JavaScript support for DALi
[platform/core/uifw/dali-toolkit.git] / plugins / dali-script-v8 / docs / dali-theme / partials / classes.handlebars
1 <h1>{{name}} Class</h1>
2 <div class="box meta">
3     {{#if uses}}
4         <div class="uses">
5             Uses
6             <ul class="inline commas">
7                 {{#uses}}
8                     <li><a href="{{.}}.html">{{.}}</a></li>
9                 {{/uses}}
10             </ul>
11         </div>
12     {{/if}}
13
14     {{#if extends}}
15         <div class="extends">
16             Extends {{#crossLink extends}}{{/crossLink}}
17         </div>
18     {{/if}}
19
20     {{#if foundAt}}
21         <div class="foundat">
22             Defined in: <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
23         </div>
24     {{/if}}
25
26     {{#if module}}
27         {{#if submodule}}
28             Module: {{#crossLinkModule submodule}}{{/crossLinkModule}}<br>
29             Parent Module: {{#crossLinkModule module}}{{/crossLinkModule}}
30         {{else}}
31             Module: {{#crossLinkModule module}}{{/crossLinkModule}}
32         {{/if}}
33     {{/if}}
34
35     {{#if since}}
36         <p>Available since {{since}}</p>
37     {{/if}}
38 </div>
39
40 {{#if deprecated}}
41     <div class="box deprecated">
42         <p>
43         {{#if deprecationMessage}}
44             <strong>Deprecated:</strong> {{deprecationMessage}}
45         {{else}}
46             This class is deprecated.
47         {{/if}}
48         </p>
49     </div>
50 {{/if}}
51
52 <div class="box intro">
53     {{{classDescription}}}
54 </div>
55
56 {{#is_constructor}}
57     <div class="constructor">
58         <h2>Constructor</h2>
59         {{>method}}
60     </div>
61 {{/is_constructor}}
62
63 <div id="classdocs" class="tabview">
64     <ul class="api-class-tabs">
65         <li class="api-class-tab index"><a href="#index">Index</a></li>
66
67         {{#if methods}}
68             <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
69         {{/if}}
70         {{#if properties}}
71             <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
72         {{/if}}
73         {{#if attrs}}
74             <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
75         {{/if}}
76         {{#if events}}
77             <li class="api-class-tab events"><a href="#events">Events</a></li>
78         {{/if}}
79     </ul>
80
81     <div>
82         <div id="index" class="api-class-tabpanel index">
83             <h2 class="off-left">Item Index</h2>
84
85             {{#if methods}}
86                 <div class="index-section methods">
87                     <h3>Methods</h3>
88
89                     <ul class="index-list methods{{#if extends}} extends{{/if}}">
90                         {{#methods}}
91                             <li class="index-item method{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
92                                 <a href="#method_{{name}}">{{name}}</a>
93
94                                 {{#if static}}
95                                     <span class="flag static">static</span>
96                                 {{/if}}
97                                 {{#if deprecated}}
98                                     <span class="flag deprecated">deprecated</span>
99                                 {{/if}}
100                             </li>
101                         {{/methods}}
102                     </ul>
103                 </div>
104             {{/if}}
105
106             {{#if properties}}
107                 <div class="index-section properties">
108                     <h3>Properties</h3>
109
110                     <ul class="index-list properties{{#if extends}} extends{{/if}}">
111                         {{#properties}}
112                             <li class="index-item property{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
113                                 <a href="#property_{{name}}">{{name}}</a>
114
115                                 {{#if static}}
116                                     <span class="flag static">static</span>
117                                 {{/if}}
118                                 {{#if deprecated}}
119                                     <span class="flag deprecated">deprecated</span>
120                                 {{/if}}
121                             </li>
122                         {{/properties}}
123                     </ul>
124                 </div>
125             {{/if}}
126
127             {{#if attrs}}
128                 <div class="index-section attrs">
129                     <h3>Attributes</h3>
130
131                     <ul class="index-list attrs{{#if extends}} extends{{/if}}">
132                         {{#attrs}}
133                             <li class="index-item attr{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
134                                 <a href="#attr_{{name}}">{{name}}</a>
135                             </li>
136                         {{/attrs}}
137                     </ul>
138                 </div>
139             {{/if}}
140
141             {{#if events}}
142                 <div class="index-section events">
143                     <h3>Events</h3>
144
145                     <ul class="index-list events{{#if extends}} extends{{/if}}">
146                         {{#events}}
147                             <li class="index-item event{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
148                                 <a href="#event_{{name}}">{{name}}</a>
149
150                                 {{#if static}}
151                                     <span class="flag static">static</span>
152                                 {{/if}}
153                                 {{#if deprecated}}
154                                     <span class="flag deprecated">deprecated</span>
155                                 {{/if}}
156                             </li>
157                         {{/events}}
158                     </ul>
159                 </div>
160             {{/if}}
161         </div>
162
163         {{#if methods}}
164             <div id="methods" class="api-class-tabpanel">
165                 <h2 class="off-left">Methods</h2>
166
167                 {{#methods}}
168 {{>method}}
169                 {{/methods}}
170             </div>
171         {{/if}}
172
173         {{#if properties}}
174             <div id="properties" class="api-class-tabpanel">
175                 <h2 class="off-left">Properties</h2>
176
177                 {{#properties}}
178                     {{>props}}
179                 {{/properties}}
180             </div>
181         {{/if}}
182
183         {{#if attrs}}
184             <div id="attrs" class="api-class-tabpanel">
185                 <h2 class="off-left">Attributes</h2>
186
187                 {{#attrs}}
188                     {{>attrs}}
189                 {{/attrs}}
190             </div>
191         {{/if}}
192
193         {{#if events}}
194             <div id="events" class="api-class-tabpanel">
195                 <h2 class="off-left">Events</h2>
196
197                 {{#events}}
198                     {{>events}}
199                 {{/events}}
200             </div>
201         {{/if}}
202     </div>
203 </div>