cxxEnumerator

The <cxxEnumerator> element within the <cxxEnumerators> element provides the details of an enumerator defined within an enumeration.

Description

The <cxxEnumerator> element contains <cxxEnumeratorScopedName>, <cxxEnumeratorPrototype>, <cxxEnumeratorNameLookup>, <cxxEnumeratorInitialiser> and <cxxEnumeratorAPIItemLocation> to describe the details of the enumerator.

Example

<cxxEnumerators>
    <cxxEnumerator id="class_c_graphics_context_1aa83437963ec92f7c4bef2ca1fe1d841faa74134e0c09d1d944bd4ef7c274511ae">
        <apiName>ELeft</apiName>
        <cxxEnumeratorScopedName>CGraphicsContext</cxxEnumeratorScopedName>
        <cxxEnumeratorPrototype>ELeft</cxxEnumeratorPrototype>
        <cxxEnumeratorNameLookup>CGraphicsContext::ELeft</cxxEnumeratorNameLookup>
        <cxxEnumeratorAPIItemLocation>
            <cxxEnumeratorDeclarationFile name="filePath" value="C:/src/include/gdi.h"/>
            <cxxEnumeratorDeclarationFileLine name="lineNumber" value="1722"/>
        </cxxEnumeratorAPIItemLocation>
        <apiDesc>
            <p>Text is left-aligned. </p>
        </apiDesc>
    </cxxEnumerator>
    <cxxEnumerator id="class_c_graphics_context_1aa83437963ec92f7c4bef2ca1fe1d841faf9bbbaae3b62083e453a204ca381aff7">
        ...
    </cxxEnumerator>
    <cxxEnumerator id="class_c_graphics_context_1aa83437963ec92f7c4bef2ca1fe1d841fa6567b3e91e6ce82151d21d2617ac1694">
        ...
    </cxxEnumerator>
</cxxEnumerators>

Contained by

cxxEnumerators

Contains

apiDesc, apiName, cxxEnumeratorAPIItemLocation cxxEnumeratorInitialiser cxxEnumeratorNameLookup cxxEnumeratorPrototype cxxEnumeratorScopedName

Content Model

(apiName, then cxxEnumeratorScopedName (optional) then cxxEnumeratorPrototype (optional) then cxxEnumeratorNameLookup (optional) then cxxEnumeratorInitialiser (optional) then cxxEnumeratorAPIItemLocation (optional) then apiDesc, )

Inheritance

topic/ph reference/ph apiRef/apiDefItem apiValue/apiDefItem cxxEnumeration/cxxEnumerator