|
1 <?xml version="1.0" encoding="UTF-8"?> |
|
2 <!-- |
|
3 Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 All rights reserved. |
|
5 --> |
|
6 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
|
7 <reference xml:lang="en-us" outputclass="element" id="cxxVariable"> |
|
8 <title>cxxVariable</title> |
|
9 <shortdesc>The <cxxVariable> element contains the elements necessary to describe a variable.</shortdesc> |
|
10 <refbody> |
|
11 <section> |
|
12 <title>Description</title> |
|
13 <p>The <cxxVariable> element requires the <i>id</i> attribute so that it can be referenced |
|
14 by other topics. <cxxVariable> also requires an <apiname> element to specify the variable |
|
15 name, the the <cxxVariableDetail> element to hold the variable description.</p> |
|
16 </section> |
|
17 <example> |
|
18 <title>Example</title> |
|
19 <codeblock><cxxClass id="a_class"> |
|
20 <apiName>AClass</apiName> |
|
21 <cxxClassDetail> |
|
22 ... |
|
23 </cxxClassDetail> |
|
24 <cxxFunction id="a_class_1a0cd89cbef4c7224dab024bfa3182b99e"> |
|
25 ... |
|
26 </cxxFunction> |
|
27 <cxxVariable id="a_class_1ae0375"> |
|
28 <apiName>iFunctions</apiName> |
|
29 <cxxVariableDetail> |
|
30 <cxxVariableDefinition> |
|
31 <cxxVariableAccessSpecifier value="protected"/> |
|
32 <cxxVariableDeclaredType> |
|
33 <apiRelation href="a_class_general_functions.xml#class_m_anim_general_functions">MAnimGeneralFunctions</apiRelation> *</cxxVariableDeclaredType> |
|
34 <cxxVariableScopedName>CAnim</cxxVariableScopedName> |
|
35 <cxxVariablePrototype>MAnimGeneralFunctions * iFunctions</cxxVariablePrototype> |
|
36 <cxxVariableNameLookup>CAnim::iFunctions</cxxVariableNameLookup> |
|
37 <cxxVariableAPIItemLocation> |
|
38 <cxxVariableDeclarationFile name="filePath" value="C:/src/include/w32adll.h"/> |
|
39 <cxxVariableDeclarationFileLine name="lineNumber" value="908"/> |
|
40 </cxxVariableAPIItemLocation> |
|
41 </cxxVariableDefinition> |
|
42 <apiDesc> |
|
43 <p>Pointer to a class containing functions implemented by the window server.</p> |
|
44 <p>These are available to any <xref href="a_class.xml#a_class">CAnim</xref> derived class.</p> |
|
45 <p>Note that this value is automatically set for you by the animation framework. You do not need to assign a value to this pointer.</p> |
|
46 </apiDesc> |
|
47 </cxxVariableDetail> |
|
48 </cxxVariable> |
|
49 <cxxClassInherits> |
|
50 ... |
|
51 </cxxClassInherits> |
|
52 </cxxClass></codeblock> |
|
53 </example> |
|
54 <section conref="../packagedef.dita#cxxVariable-reference/cxxVariable-containedBy-section"/> |
|
55 <section conref="../packagedef.dita#cxxVariable-reference/cxxVariable-contains-section"/> |
|
56 <section conref="../packagedef.dita#cxxVariable-reference/cxxVariable-contentModel-section"/> |
|
57 <section conref="../packagedef.dita#cxxVariable-reference/cxxVariable-attList-section"/> |
|
58 <section conref="../packagedef.dita#cxxVariable-reference/cxxVariable-classValue-section"/> |
|
59 </refbody> |
|
60 </reference> |