* doc/tmpl/* * hildon-widgets/* moved widget descriptions to respective source file...
[hildon] / doc / tmpl / hildon-app.sgml
1 <!-- ##### SECTION Title ##### -->
2 HildonApp
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 <informalexample>
11 <programlisting>
12
13 app = hildon_app_new_with_appview( appview );
14
15 hildon_app_set_title( app, "This is a hello dude application" );
16
17 </programlisting>
18 </informalexample>
19 </para>
20
21 <!-- ##### SECTION See_Also ##### -->
22 <para>
23
24 </para>
25
26 <!-- ##### ENUM HildonZoomLevel ##### -->
27 <para>
28
29 </para>
30
31 @HILDON_ZOOM_SMALL: 
32 @HILDON_ZOOM_MEDIUM: 
33 @HILDON_ZOOM_LARGE: 
34
35 <!-- ##### MACRO HILDON_TYPE_ZOOM_LEVEL ##### -->
36 <para>
37
38 </para>
39
40
41
42 <!-- ##### MACRO HILDON_MENU_KEY ##### -->
43 <para>
44
45 </para>
46
47
48
49 <!-- ##### MACRO HILDON_HOME_KEY ##### -->
50 <para>
51
52 </para>
53
54
55
56 <!-- ##### MACRO HILDON_TOOLBAR_KEY ##### -->
57 <para>
58
59 </para>
60
61
62
63 <!-- ##### MACRO HILDON_FULLSCREEN_KEY ##### -->
64 <para>
65
66 </para>
67
68
69
70 <!-- ##### MACRO HILDON_INCREASE_KEY ##### -->
71 <para>
72
73 </para>
74
75
76
77 <!-- ##### MACRO HILDON_DECREASE_KEY ##### -->
78 <para>
79
80 </para>
81
82
83
84 <!-- ##### MACRO HILDON_TOOLBAR_MODIFIERS ##### -->
85 <para>
86
87 </para>
88
89
90
91 <!-- ##### MACRO HILDON_KEYEVENT_IS_MENU_KEY ##### -->
92 <para>
93
94 </para>
95
96 @keyevent: 
97
98
99 <!-- ##### MACRO HILDON_KEYEVENT_IS_HOME_KEY ##### -->
100 <para>
101
102 </para>
103
104 @keyevent: 
105
106
107 <!-- ##### MACRO HILDON_KEYEVENT_IS_TOOLBAR_KEY ##### -->
108 <para>
109
110 </para>
111
112 @keyevent: 
113
114
115 <!-- ##### MACRO HILDON_KEYEVENT_IS_FULLSCREEN_KEY ##### -->
116 <para>
117
118 </para>
119
120 @keyevent: 
121
122
123 <!-- ##### MACRO HILDON_KEYEVENT_IS_INCREASE_KEY ##### -->
124 <para>
125
126 </para>
127
128 @keyevent: 
129
130
131 <!-- ##### MACRO HILDON_KEYEVENT_IS_DECREASE_KEY ##### -->
132 <para>
133
134 </para>
135
136 @keyevent: 
137
138
139 <!-- ##### MACRO TRANSIENCY_MAXITER ##### -->
140 <para>
141
142 </para>
143
144
145
146 <!-- ##### FUNCTION hildon_app_get_type ##### -->
147 <para>
148
149 </para>
150
151 @Returns: 
152
153
154 <!-- ##### MACRO HILDON_TYPE_ZOOM_LEVEL ##### -->
155 <para>
156
157 </para>
158
159
160
161 <!-- ##### MACRO HILDON_MENU_KEY ##### -->
162 <para>
163
164 </para>
165
166
167
168 <!-- ##### MACRO HILDON_HOME_KEY ##### -->
169 <para>
170
171 </para>
172
173
174
175 <!-- ##### MACRO HILDON_TOOLBAR_KEY ##### -->
176 <para>
177
178 </para>
179
180
181
182 <!-- ##### MACRO HILDON_FULLSCREEN_KEY ##### -->
183 <para>
184
185 </para>
186
187
188
189 <!-- ##### MACRO HILDON_INCREASE_KEY ##### -->
190 <para>
191
192 </para>
193
194
195
196 <!-- ##### MACRO HILDON_DECREASE_KEY ##### -->
197 <para>
198
199 </para>
200
201
202
203 <!-- ##### MACRO HILDON_TOOLBAR_MODIFIERS ##### -->
204 <para>
205
206 </para>
207
208
209
210 <!-- ##### MACRO HILDON_KEYEVENT_IS_MENU_KEY ##### -->
211 <para>
212
213 </para>
214
215 @keyevent: 
216
217
218 <!-- ##### MACRO HILDON_KEYEVENT_IS_HOME_KEY ##### -->
219 <para>
220
221 </para>
222
223 @keyevent: 
224
225
226 <!-- ##### MACRO HILDON_KEYEVENT_IS_TOOLBAR_KEY ##### -->
227 <para>
228
229 </para>
230
231 @keyevent: 
232
233
234 <!-- ##### MACRO HILDON_KEYEVENT_IS_FULLSCREEN_KEY ##### -->
235 <para>
236
237 </para>
238
239 @keyevent: 
240
241
242 <!-- ##### MACRO HILDON_KEYEVENT_IS_INCREASE_KEY ##### -->
243 <para>
244
245 </para>
246
247 @keyevent: 
248
249
250 <!-- ##### MACRO HILDON_KEYEVENT_IS_DECREASE_KEY ##### -->
251 <para>
252
253 </para>
254
255 @keyevent: 
256
257
258 <!-- ##### MACRO TRANSIENCY_MAXITER ##### -->
259 <para>
260
261 </para>
262
263
264
265 <!-- ##### FUNCTION hildon_app_get_type ##### -->
266 <para>
267
268 </para>
269
270 @Returns: 
271
272
273 <!-- ##### FUNCTION hildon_app_new ##### -->
274 <para>
275
276 </para>
277
278 @Returns: 
279
280
281 <!-- ##### FUNCTION hildon_app_new_with_appview ##### -->
282 <para>
283
284 </para>
285
286 @appview: 
287 @Returns: 
288
289
290 <!-- ##### FUNCTION hildon_app_set_appview ##### -->
291 <para>
292
293 </para>
294
295 @self: 
296 @appview: 
297
298
299 <!-- ##### FUNCTION hildon_app_get_appview ##### -->
300 <para>
301
302 </para>
303
304 @self: 
305 @Returns: 
306
307
308 <!-- ##### FUNCTION hildon_app_set_autoregistration ##### -->
309 <para>
310
311 </para>
312
313 @self: 
314 @auto_reg: 
315
316
317 <!-- ##### FUNCTION hildon_app_register_view ##### -->
318 <para>
319
320 </para>
321
322 @self: 
323 @view_ptr: 
324
325
326 <!-- ##### FUNCTION hildon_app_register_view_with_id ##### -->
327 <para>
328
329 </para>
330
331 @self: 
332 @view_ptr: 
333 @Param3: 
334 @Returns: 
335 <!-- # Unused Parameters # -->
336 @view_id: 
337
338
339 <!-- ##### FUNCTION hildon_app_unregister_view ##### -->
340 <para>
341
342 </para>
343
344 @self: 
345 @view_ptr: 
346
347
348 <!-- ##### FUNCTION hildon_app_unregister_view_with_id ##### -->
349 <para>
350
351 </para>
352
353 @self: 
354 @Param2: 
355 <!-- # Unused Parameters # -->
356 @view_id: 
357
358
359 <!-- ##### FUNCTION hildon_app_find_view_id ##### -->
360 <para>
361
362 </para>
363
364 @self: 
365 @view_ptr: 
366 @Returns: 
367
368
369 <!-- ##### FUNCTION hildon_app_notify_view_changed ##### -->
370 <para>
371
372 </para>
373
374 @self: 
375 @view_ptr: 
376
377
378 <!-- ##### FUNCTION hildon_app_set_killable ##### -->
379 <para>
380
381 </para>
382
383 @self: 
384 @killability: 
385
386
387 <!-- ##### FUNCTION hildon_app_set_ui_manager ##### -->
388 <para>
389
390 </para>
391
392 @self: 
393 @uim: 
394
395
396 <!-- ##### FUNCTION hildon_app_get_ui_manager ##### -->
397 <para>
398
399 </para>
400
401 @self: 
402 @Returns: 
403
404
405 <!-- ##### SIGNAL HildonApp::clipboard-copy ##### -->
406 <para>
407
408 </para>
409
410 @hildonapp: the object which received the signal.
411 @arg1: 
412
413 <!-- ##### SIGNAL HildonApp::clipboard-cut ##### -->
414 <para>
415
416 </para>
417
418 @hildonapp: the object which received the signal.
419 @arg1: 
420
421 <!-- ##### SIGNAL HildonApp::clipboard-paste ##### -->
422 <para>
423
424 </para>
425
426 @hildonapp: the object which received the signal.
427 @arg1: 
428
429 <!-- ##### SIGNAL HildonApp::im-close ##### -->
430 <para>
431
432 </para>
433
434 @hildonapp: the object which received the signal.
435
436 <!-- ##### SIGNAL HildonApp::switch-to ##### -->
437 <para>
438
439 </para>
440
441 @hildonapp: the object which received the signal.
442 @arg1: 
443
444 <!-- ##### SIGNAL HildonApp::topmost-status-acquire ##### -->
445 <para>
446
447 </para>
448
449 @hildonapp: the object which received the signal.
450
451 <!-- ##### SIGNAL HildonApp::topmost-status-lose ##### -->
452 <para>
453
454 </para>
455
456 @hildonapp: the object which received the signal.
457
458 <!-- ##### ARG HildonApp:app-title ##### -->
459 <para>
460
461 </para>
462
463 <!-- ##### ARG HildonApp:appview ##### -->
464 <para>
465
466 </para>
467
468 <!-- ##### ARG HildonApp:autoregistration ##### -->
469 <para>
470
471 </para>
472
473 <!-- ##### ARG HildonApp:killable ##### -->
474 <para>
475
476 </para>
477
478 <!-- ##### ARG HildonApp:scroll-control ##### -->
479 <para>
480
481 </para>
482
483 <!-- ##### ARG HildonApp:two-part-title ##### -->
484 <para>
485
486 </para>
487
488 <!-- ##### ARG HildonApp:ui-manager ##### -->
489 <para>
490
491 </para>
492
493 <!-- ##### ARG HildonApp:zoom ##### -->
494 <para>
495
496 </para>
497