summaryrefslogtreecommitdiffstats
path: root/templates/html/htmlmemdecl.tpl
blob: 6af75cecedec7f56b88bad103f747ca6e7dfbaa5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
{# inputs: member, inheritId=<string> anonymousNestingLevel=<int> #}
{% if not member.isEnumValue %}
  {# start member declaration #}
  <tr class="memitem:{{ member.anchor}}{% if inheritId %} inherit {{ inheritId }}{% endif %}">
  {% if member.isEnumeration %}
    {% if anonymousNestingLevel>0 %}
      <td class="memItemLeft">
    {% else %}
      <td class="memItemLeft" align="right" valign="top">
    {% endif %}
    {# write optional anchor #}
      {% if not member.hasDetails %}
        <a class="anchor" id="{% if member.anonymousMember %}{{ member.anonymousMember.anchor}}{% else %}{{ member.anchor }}{% endif %}"></a>
      {% endif %}
    {# write optional indent #}
    {% repeat anonymousNestingLevel %}&#160;&#160;&#160;{% endrepeat %}
    enum&#160;</td><td class="memTemplItemRight" valign="bottom">
    {# write name #}
    {% if not member.isAnonymous %}
      {% with obj=member text=member.name %}
        {% include 'htmlobjlink.tpl' %}
      {% endwith %}
    {% endif %}
    {% if member.enumBaseType %} : {{ member.enumBaseType }}{% endif %}
    {% if member.enumValues|length>0 and config.ENUM_VALUES_PER_LINE>0 %}
      {
        {% for enumVal in member.enumValues %}
          {% if member.enumValues|length>config.ENUM_VALUES_PER_LINE and forloop.counter0|divisibleby:config.ENUM_VALUES_PER_LINE %}
            <br/>&#160;&#160;
          {% endif %}
          {% spaceless %}
            {% with obj=enumVal text=enumVal.name %}
              {% include 'htmlobjlink.tpl' %}
              {% if enumVal.hasOneLineInitializer %}
                {{ member.initializer }}
              {% endif %}
              {% if not forloop.last %},{% endif %}
            {% endwith %}
          {% endspaceless %}
        {% endfor %}
        {% if member.enumValues|length>config.ENUM_VALUES_PER_LINE %}
        <br/>
        {% endif %}
      }
    {% endif %}
  {% else %}
    {% if anonymousNestingLevel>0 or member.anonymousType %}
      <td class="memItemLeft">
    {% else %}
      {% if member.templateArgs %}
        <td class="memTemplParams" colspan="2">
      {% else %}
        <td class="memItemLeft" align="right" valign="top">
      {% endif %}
    {% endif %}
    {# write optional anchor #}
      {% if not member.hasDetails %}
        <a class="anchor" id="{% if member.anonymousMember %}{{ member.anonymousMember.anchor}}{% else %}{{ member.anchor }}{% endif %}"></a>
      {% endif %}
    {# write optional indent #}
    {% repeat anonymousNestingLevel %}&#160;&#160;&#160;{% endrepeat %}
    {# write template list #}
      {% if member.templateArgs and member.language=='cpp' %}
        {% spaceless %}
          template&lt;
          {% for targ in member.templateArgs %}
            {{ targ.type }} {{ targ.name }}{% if targ.defVal %} = {{ targ.defval }}{% endif %}{% if not forloop.last %}, {% endif %}
          {% endfor %}
        {% endspaceless %} &gt;
        </td></tr><tr class="memitem:{{ member.anchor }}{% if inheritId %} inherit {{ inheritId }}{% endif %}"><td class="memTemplItemLeft" align="right" valign="top">
      {% endif %}
    {# write type #}
      {% if member.anonymousType %}
        {% with ctx=member.anonymousType anonymousNestingLevel=anonymousNestingLevel|add:1 %}
          {{ ctx.compoundType }}
          {% if ctx.bareName %}
            &#160;<b>{{ ctx.bareName }}</b> {# TODO: associated documentation is lost! #}
          {% endif %}
          {</td></tr>
          {# recursively write members that can appear inside the anonymous class/struct #}
          {% with memberListInfo=ctx.publicTypes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.publicMethods %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.publicStaticMethods %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.publicAttributes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.publicStaticAttributes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.protectedTypes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.protectedMethods %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.protectedStaticMethods %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.protectedAttributes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.protectedStaticAttributes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.privateTypes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.privateMethods %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.privateStaticMethods %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.privateAttributes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
          {% with memberListInfo=ctx.privateStaticAttributes %}
            {% include 'htmlmemlist.tpl' %}
          {% endwith %}
        {% endwith %}
        <tr class="memitem:{{ member.anchor }}{% if inheritId %} inherit {{ inheritId }}{% endif %}">
        <td class="memItemLeft" valign="top">{% repeat anonymousNestingLevel %}&#160;&#160;&#160;{% endrepeat %}
        }
      {% else %}
        {% if member.isObjCMethod %}
          {% if member.isStatic %}+&#160;{% else %}-&#160;{% endif %}
        {% else %}
          {{ member.declType }}
        {% endif %}
      {% endif %}
      {% spaceless %}
        &#160;
        {% if anonymousNestingLevel>0 %}
           &#160;&#160;
        {% else %}
          </td><td class="{% if member.templateArgs %}memTemplItemRight{% else %}memItemRight{% endif %}" valign="bottom">
        {% endif %}
      {% endspaceless %}
    {# write name #}
      {% if not member.isAnonymous %}
        {% if member.anonymousMember %}
          {% with obj=member.anonymousMember text=member.anonymousMember.name %}
            {% include 'htmlobjlink.tpl' %}
          {% endwith %}
        {% else %}
          {% with obj=member text=member.name %}
            {% include 'htmlobjlink.tpl' %}
          {% endwith %}
        {% endif %}
      {% endif %}
    {# write arguments #}
      {% if not member.isObjCMethod %}
        {{ member.declArgs }}
      {% endif %}
    {# write exceptions #}
      {% if member.exception %}
        {{ member.exception }}
      {% endif %}
    {# write bitfield #}
      {% if member.bitfields %}
        {{ member.bitfields }}
      {% endif %}
    {# write one-line initializer #}
      {% if member.hasOneLineInitializer %}
        {% if member.isDefine %}&#160;&#160;&#160;{% endif %}
        {{ member.initializer }}
      {% endif %}
    {# write template alias #}
      {% if member.templateAlias %}
        {{ member.templateAlias }}
      {% endif %}
    {# write obj-c implementation #}
      {% if member.isObjCMethod or member.isObjCProperty %}
        {% if member.isImplementation %}
          <code> [implementation]</code>
        {% endif %}
      {% endif %}
    {# write getter/setter property #}
      {% if member.isProperty and member.propertyAttrs|length>0 %}
        <code> [
        {% for attr in member.propertyAttrs %}
          {{ attr }}{% if not forloop.last %},{% endif %}
        {% endfor %}
        ]</code>
      {% endif %}
    {# write event methods #}
      {% if member.isEvent and member.eventAttrs|length>0 %}
        <code> [
        {% for attr in member.eventAttrs %}
          {{ attr }}{% if not forloop.last %},{% endif %}
        {% endfor %}
        ]</code>
      {% endif %}
    {# end member declaration #}
  {% endif %} {# member.isEnumeration #}
  </td></tr>
  {# brief description #}
    {% if member.brief %}
      <tr class="memdesc:{{ member.anchor }}{% if inheritId %} inherit {{ inheritId }}{% endif %}"><td class="mdescLeft">&#160;</td><td class="mdescRight">
      {{ member.brief }}
      {% if member.hasDetails %}
        {# TODO: link to group if member is grouped #}
        <a href="#{{ member.anchor }}">{{ tr.more }}</a>
      {% endif %}
      <br/></td></tr>
    {% endif %}
  <tr class="separator:{{ member.anchor }}{% if inheritId %} inherit {{ inheritId }}{% endif %}"><td class="memSeparator" colspan="2">&#160;</td></tr>
{% endif %} {# not member.isEnumValue #}