|
1 <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html lang="en" xml:lang="en"> |
|
3 <head> |
|
4 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> |
|
5 <meta name="copyright" content="(C) Copyright 2005" /> |
|
6 <meta name="DC.rights.owner" content="(C) Copyright 2005" /> |
|
7 <meta content="concept" name="DC.Type" /> |
|
8 <meta name="DC.Title" content="WRTKit ListView Class" /> |
|
9 <meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" /> |
|
10 <meta content="XHTML" name="DC.Format" /> |
|
11 <meta content="GUID-A7F24A67-D46C-4156-8276-A97B945235D6" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit ListView Class</title> |
|
16 </head> |
|
17 <body id="GUID-A7F24A67-D46C-4156-8276-A97B945235D6"><a name="GUID-A7F24A67-D46C-4156-8276-A97B945235D6"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit ListView Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The ListView is a view that arranges controls in a vertical stack similar to |
|
33 native S60 user interfaces. |
|
34 </p> |
|
35 |
|
36 <div class="fignone" id="GUID-A7F24A67-D46C-4156-8276-A97B945235D6__GUID-D342BE27-89B4-454F-BC2C-B6FBDEE9112A"><a name="GUID-A7F24A67-D46C-4156-8276-A97B945235D6__GUID-D342BE27-89B4-454F-BC2C-B6FBDEE9112A"><!-- --></a><span class="figcap">Figure 1. |
|
37 ListView with caption</span> |
|
38 |
|
39 |
|
40 <br /><img src="Travel_Companion_Main_Screenshot_1.png" /><br /> |
|
41 </div> |
|
42 |
|
43 </div> |
|
44 |
|
45 <div class="section"><h2 class="sectiontitle"> |
|
46 Inherits from</h2> |
|
47 |
|
48 |
|
49 <p> |
|
50 |
|
51 <a href="WRTKit_View_Class-GUID-e673fe1a-cf46-46f5-b243-ce7422c69cc5.html"> |
|
52 View</a> |
|
53 </p> |
|
54 |
|
55 </div> |
|
56 |
|
57 </div> |
|
58 |
|
59 <div> |
|
60 <div class="familylinks"> |
|
61 <div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div> |
|
62 </div> |
|
63 </div> |
|
64 <div class="nested1" id="GUID-73FAF0DC-A0AE-47B8-81A1-F723F1457FA2"><a name="GUID-73FAF0DC-A0AE-47B8-81A1-F723F1457FA2"><!-- --></a> |
|
65 |
|
66 <h2 class="topictitle2"> |
|
67 Constructor</h2> |
|
68 |
|
69 <div> |
|
70 |
|
71 <div class="section"><h3 class="sectiontitle"> |
|
72 Syntax</h3> |
|
73 |
|
74 |
|
75 <pre> |
|
76 [ListView] new ListView(String id, String caption)</pre> |
|
77 |
|
78 </div> |
|
79 |
|
80 <div class="section"><h3 class="sectiontitle"> |
|
81 Description</h3> |
|
82 |
|
83 |
|
84 <p> |
|
85 |
|
86 Creates a new instance of the ListView class. |
|
87 </p> |
|
88 |
|
89 </div> |
|
90 |
|
91 <div class="section"><h3 class="sectiontitle"> |
|
92 Arguments</h3> |
|
93 |
|
94 |
|
95 <br /><ul> |
|
96 |
|
97 <li> |
|
98 |
|
99 <p> |
|
100 id</p> |
|
101 |
|
102 |
|
103 |
|
104 <p> |
|
105 |
|
106 Unique identifier for the view. Can be retrieved using the id property defined |
|
107 in the UIElement class that this control inherits from. Useful for example to |
|
108 identify the source of an event in event callback functions or to apply a CSS |
|
109 rule to only this particular view. The identifier can be null, in which case |
|
110 no id will be set for the view. |
|
111 </p> |
|
112 |
|
113 |
|
114 </li> |
|
115 |
|
116 <li> |
|
117 |
|
118 <p> |
|
119 caption</p> |
|
120 |
|
121 |
|
122 |
|
123 <p> |
|
124 |
|
125 The caption text for the view. A null caption can be used to hide the |
|
126 caption area. Pass an empty string to this argument in order to show the |
|
127 caption area but without text. This can be used if a custom image should |
|
128 be shown instead of text for the view caption. The image can then be |
|
129 defined using CSS by providing a background for the .ListViewCaptionText |
|
130 CSS rule. By specifying the rule only for the id that was specified with |
|
131 the id argument a custom background can be given to a particular view. |
|
132 The value is an XHTML string. |
|
133 </p> |
|
134 |
|
135 |
|
136 </li> |
|
137 |
|
138 </ul> |
|
139 |
|
140 </div> |
|
141 |
|
142 <div class="section"><h3 class="sectiontitle"> |
|
143 Return value</h3> |
|
144 |
|
145 |
|
146 <p> |
|
147 |
|
148 A new instance of the ListView class. |
|
149 </p> |
|
150 |
|
151 </div> |
|
152 |
|
153 </div> |
|
154 |
|
155 </div> |
|
156 |
|
157 <div class="nested1" id="GUID-D382D123-2C88-46B8-8E27-129C91E2C6ED"><a name="GUID-D382D123-2C88-46B8-8E27-129C91E2C6ED"><!-- --></a> |
|
158 |
|
159 <h2 class="topictitle2"> |
|
160 getCaption()</h2> |
|
161 |
|
162 <div> |
|
163 |
|
164 <div class="section"><h3 class="sectiontitle"> |
|
165 Syntax</h3> |
|
166 |
|
167 |
|
168 <pre> |
|
169 [String] ListView.getCaption(void)</pre> |
|
170 |
|
171 </div> |
|
172 |
|
173 <div class="section"><h3 class="sectiontitle"> |
|
174 Description</h3> |
|
175 |
|
176 |
|
177 <p> |
|
178 |
|
179 Retrieves the current caption of the view. |
|
180 The value is an XHTML string. |
|
181 </p> |
|
182 |
|
183 </div> |
|
184 |
|
185 <div class="section"><h3 class="sectiontitle"> |
|
186 Arguments</h3> |
|
187 |
|
188 |
|
189 <p> |
|
190 |
|
191 This method does not take any arguments. |
|
192 </p> |
|
193 |
|
194 </div> |
|
195 |
|
196 <div class="section"><h3 class="sectiontitle"> |
|
197 Return value</h3> |
|
198 |
|
199 |
|
200 <p> |
|
201 |
|
202 The current caption of the view or null if the view doesn't have a caption. |
|
203 </p> |
|
204 |
|
205 </div> |
|
206 |
|
207 </div> |
|
208 |
|
209 </div> |
|
210 |
|
211 <div class="nested1" id="GUID-DB089887-5FD1-4490-8D44-A6B9F5BF0A46"><a name="GUID-DB089887-5FD1-4490-8D44-A6B9F5BF0A46"><!-- --></a> |
|
212 |
|
213 <h2 class="topictitle2"> |
|
214 setCaption()</h2> |
|
215 |
|
216 <div> |
|
217 |
|
218 <div class="section"><h3 class="sectiontitle"> |
|
219 Syntax</h3> |
|
220 |
|
221 |
|
222 <pre> |
|
223 [void] ListView.setCaption(String caption)</pre> |
|
224 |
|
225 </div> |
|
226 |
|
227 <div class="section"><h3 class="sectiontitle"> |
|
228 Description</h3> |
|
229 |
|
230 |
|
231 <p> |
|
232 |
|
233 Sets the caption for the view. A null caption can be used to hide the caption area. |
|
234 The value is an XHTML string. |
|
235 </p> |
|
236 |
|
237 </div> |
|
238 |
|
239 <div class="section"><h3 class="sectiontitle"> |
|
240 Arguments</h3> |
|
241 |
|
242 |
|
243 <br /><ul> |
|
244 |
|
245 <li> |
|
246 |
|
247 <p> |
|
248 caption</p> |
|
249 |
|
250 |
|
251 |
|
252 <p> |
|
253 |
|
254 The new caption for the view or null for no caption. |
|
255 </p> |
|
256 |
|
257 |
|
258 </li> |
|
259 |
|
260 </ul> |
|
261 |
|
262 </div> |
|
263 |
|
264 <div class="section"><h3 class="sectiontitle"> |
|
265 Return value</h3> |
|
266 |
|
267 |
|
268 <p> |
|
269 |
|
270 This method does not return a value. |
|
271 </p> |
|
272 |
|
273 </div> |
|
274 |
|
275 </div> |
|
276 |
|
277 </div> |
|
278 |
|
279 <div class="nested1" id="GUID-277742B7-93D0-4824-8331-077573478EED"><a name="GUID-277742B7-93D0-4824-8331-077573478EED"><!-- --></a> |
|
280 |
|
281 <h2 class="topictitle2"> |
|
282 getControls()</h2> |
|
283 |
|
284 <div> |
|
285 |
|
286 <div class="section"><h3 class="sectiontitle"> |
|
287 Syntax</h3> |
|
288 |
|
289 |
|
290 <pre> |
|
291 [Array] ListView.getControls(void)</pre> |
|
292 |
|
293 </div> |
|
294 |
|
295 <div class="section"><h3 class="sectiontitle"> |
|
296 Description</h3> |
|
297 |
|
298 |
|
299 <p> |
|
300 |
|
301 Retrieves the controls of this view. |
|
302 </p> |
|
303 |
|
304 </div> |
|
305 |
|
306 <div class="section"><h3 class="sectiontitle"> |
|
307 Arguments</h3> |
|
308 |
|
309 |
|
310 <p> |
|
311 |
|
312 This method does not take any arguments. |
|
313 </p> |
|
314 |
|
315 </div> |
|
316 |
|
317 <div class="section"><h3 class="sectiontitle"> |
|
318 Return value</h3> |
|
319 |
|
320 |
|
321 <p> |
|
322 |
|
323 An array with the controls of this view or an empty array if the view |
|
324 doesn't have any controls. |
|
325 </p> |
|
326 |
|
327 </div> |
|
328 |
|
329 </div> |
|
330 |
|
331 </div> |
|
332 |
|
333 <div class="nested1" id="GUID-A71AEDB1-3950-48D7-954D-65FB2E8FC0AE"><a name="GUID-A71AEDB1-3950-48D7-954D-65FB2E8FC0AE"><!-- --></a> |
|
334 |
|
335 <h2 class="topictitle2"> |
|
336 addControl()</h2> |
|
337 |
|
338 <div> |
|
339 |
|
340 <div class="section"><h3 class="sectiontitle"> |
|
341 Syntax</h3> |
|
342 |
|
343 |
|
344 <pre> |
|
345 [void] ListView.addControl(Control control)</pre> |
|
346 |
|
347 </div> |
|
348 |
|
349 <div class="section"><h3 class="sectiontitle"> |
|
350 Description</h3> |
|
351 |
|
352 |
|
353 <p> |
|
354 |
|
355 Adds a control to the view. The control is added last, below the currently |
|
356 last control. |
|
357 </p> |
|
358 |
|
359 </div> |
|
360 |
|
361 <div class="section"><h3 class="sectiontitle"> |
|
362 Arguments</h3> |
|
363 |
|
364 |
|
365 <br /><ul> |
|
366 |
|
367 <li> |
|
368 |
|
369 <p> |
|
370 control</p> |
|
371 |
|
372 |
|
373 |
|
374 <p> |
|
375 |
|
376 The control to add to the view. |
|
377 </p> |
|
378 |
|
379 |
|
380 </li> |
|
381 |
|
382 </ul> |
|
383 |
|
384 </div> |
|
385 |
|
386 <div class="section"><h3 class="sectiontitle"> |
|
387 Return value</h3> |
|
388 |
|
389 |
|
390 <p> |
|
391 |
|
392 This method does not return a value. |
|
393 </p> |
|
394 |
|
395 </div> |
|
396 |
|
397 </div> |
|
398 |
|
399 </div> |
|
400 |
|
401 <div class="nested1" id="GUID-19BF7EC2-A542-412D-A930-D91D8398E3A2"><a name="GUID-19BF7EC2-A542-412D-A930-D91D8398E3A2"><!-- --></a> |
|
402 |
|
403 <h2 class="topictitle2"> |
|
404 insertControl()</h2> |
|
405 |
|
406 <div> |
|
407 |
|
408 <div class="section"><h3 class="sectiontitle"> |
|
409 Syntax</h3> |
|
410 |
|
411 |
|
412 <pre> |
|
413 [void] ListView.insertControl(Control control, Control beforeControl)</pre> |
|
414 |
|
415 </div> |
|
416 |
|
417 <div class="section"><h3 class="sectiontitle"> |
|
418 Description</h3> |
|
419 |
|
420 |
|
421 <p> |
|
422 |
|
423 Inserts a control to the view. The control is added before the control that is |
|
424 specified using the beforeControl argument. |
|
425 </p> |
|
426 |
|
427 </div> |
|
428 |
|
429 <div class="section"><h3 class="sectiontitle"> |
|
430 Arguments</h3> |
|
431 |
|
432 |
|
433 <br /><ul> |
|
434 |
|
435 <li> |
|
436 |
|
437 <p> |
|
438 control</p> |
|
439 |
|
440 |
|
441 |
|
442 <p> |
|
443 |
|
444 The control to add to the view. |
|
445 </p> |
|
446 |
|
447 |
|
448 </li> |
|
449 |
|
450 <li> |
|
451 |
|
452 <p> |
|
453 beforeControl</p> |
|
454 |
|
455 |
|
456 |
|
457 <p> |
|
458 |
|
459 The control that should be immediately after the added control after |
|
460 the new control is added to the view. If the argument is null or otherwise |
|
461 invalid (e.g. not a control in this view) then the new control is added last. |
|
462 </p> |
|
463 |
|
464 |
|
465 </li> |
|
466 |
|
467 </ul> |
|
468 |
|
469 </div> |
|
470 |
|
471 <div class="section"><h3 class="sectiontitle"> |
|
472 Return value</h3> |
|
473 |
|
474 |
|
475 <p> |
|
476 |
|
477 This method does not return a value. |
|
478 </p> |
|
479 |
|
480 </div> |
|
481 |
|
482 </div> |
|
483 |
|
484 </div> |
|
485 |
|
486 <div class="nested1" id="GUID-7FC2A00B-9076-44AA-AC0D-43F5B2660D0A"><a name="GUID-7FC2A00B-9076-44AA-AC0D-43F5B2660D0A"><!-- --></a> |
|
487 |
|
488 <h2 class="topictitle2"> |
|
489 removeControl()</h2> |
|
490 |
|
491 <div> |
|
492 |
|
493 <div class="section"><h3 class="sectiontitle"> |
|
494 Syntax</h3> |
|
495 |
|
496 |
|
497 <pre> |
|
498 [void] ListView.removeControl(Control control)</pre> |
|
499 |
|
500 </div> |
|
501 |
|
502 <div class="section"><h3 class="sectiontitle"> |
|
503 Description</h3> |
|
504 |
|
505 |
|
506 <p> |
|
507 |
|
508 Removes a control from the view. |
|
509 </p> |
|
510 |
|
511 </div> |
|
512 |
|
513 <div class="section"><h3 class="sectiontitle"> |
|
514 Arguments</h3> |
|
515 |
|
516 |
|
517 <br /><ul> |
|
518 |
|
519 <li> |
|
520 |
|
521 <p> |
|
522 control</p> |
|
523 |
|
524 |
|
525 |
|
526 <p> |
|
527 |
|
528 The control to remove from the view. |
|
529 </p> |
|
530 |
|
531 |
|
532 </li> |
|
533 |
|
534 </ul> |
|
535 |
|
536 </div> |
|
537 |
|
538 <div class="section"><h3 class="sectiontitle"> |
|
539 Return value</h3> |
|
540 |
|
541 |
|
542 <p> |
|
543 |
|
544 This method does not return a value. |
|
545 </p> |
|
546 |
|
547 </div> |
|
548 |
|
549 </div> |
|
550 |
|
551 </div> |
|
552 |
|
553 |
|
554 </body> |
|
555 </html> |