1wxListCtrl(3)              Erlang Module Definition              wxListCtrl(3)
2
3
4

NAME

6       wxListCtrl - See external documentation: wxListCtrl.
7

DESCRIPTION

9       See external documentation: wxListCtrl.
10
11       This class is derived (and can use functions) from:
12       wxControl
13       wxWindow
14       wxEvtHandler
15

DATA TYPES

17         wxListCtrl():
18
19
20           An  object  reference,  The  representation  is internal and can be
21           changed without notice. It can't be used for comparsion  stored  on
22           disc or distributed for use on other nodes.
23

EXPORTS

25       new() -> wxListCtrl()
26
27              See external documentation.
28
29       new(Parent) -> wxListCtrl()
30
31              Types:
32
33                 Parent = wxWindow:wxWindow()
34
35       new(Parent, Options::[Option]) -> wxListCtrl()
36
37              Types:
38
39                 Parent = wxWindow:wxWindow()
40                 Option  =  {winid, integer()} | {pos, {X::integer(), Y::inte‐
41                 ger()}} |  {size,  {W::integer(),  H::integer()}}  |  {style,
42                 integer()}  |  {validator,  wx:wx_object()} | {onGetItemText,
43                 function()} | {onGetItemAttr, function()} | {onGetItemColumn‐
44                 Image, function()}
45
46              Creates a listctrl with optional callback functions:
47
48              OnGetItemText  =  (This,  Item,  Column)  ->  unicode:charlist()
49              OnGetItemAttr = (This, Item) ->  wxListItemAttr:wxListItemAttr()
50              OnGetItemColumnImage = (This, Item, Column) -> integer()
51
52              See external documentation.
53
54       arrange(This) -> boolean()
55
56              Types:
57
58                 This = wxListCtrl()
59
60              Equivalent to arrange(This, []).
61
62       arrange(This, Options::[Option]) -> boolean()
63
64              Types:
65
66                 This = wxListCtrl()
67                 Option = {flag, integer()}
68
69              See external documentation.
70
71       assignImageList(This, ImageList, Which) -> ok
72
73              Types:
74
75                 This = wxListCtrl()
76                 ImageList = wxImageList:wxImageList()
77                 Which = integer()
78
79              See external documentation.
80
81       clearAll(This) -> ok
82
83              Types:
84
85                 This = wxListCtrl()
86
87              See external documentation.
88
89       create(This, Parent) -> wxListCtrl()
90
91              Types:
92
93                 This = wxWindow:wxWindow()
94                 Parent = wxWindow:wxWindow()
95
96              Equivalent to create(This, Parent, []).
97
98       create(This, Parent, Options::[Option]) -> wxListCtrl()
99
100              Types:
101
102                 This = wxWindow:wxWindow()
103                 Parent = wxWindow:wxWindow()
104                 Option  =  {winid, integer()} | {pos, {X::integer(), Y::inte‐
105                 ger()}} |  {size,  {W::integer(),  H::integer()}}  |  {style,
106                 integer()}  |  {validator,  wx:wx_object()} | {onGetItemText,
107                 function()} | {onGetItemAttr, function()} | {onGetItemColumn‐
108                 Image, function()}
109
110              See external documentation.
111
112       deleteAllItems(This) -> boolean()
113
114              Types:
115
116                 This = wxListCtrl()
117
118              See external documentation.
119
120       deleteColumn(This, Col) -> boolean()
121
122              Types:
123
124                 This = wxListCtrl()
125                 Col = integer()
126
127              See external documentation.
128
129       deleteItem(This, Item) -> boolean()
130
131              Types:
132
133                 This = wxListCtrl()
134                 Item = integer()
135
136              See external documentation.
137
138       editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()
139
140              Types:
141
142                 This = wxListCtrl()
143                 Item = integer()
144
145              See external documentation.
146
147       ensureVisible(This, Item) -> boolean()
148
149              Types:
150
151                 This = wxListCtrl()
152                 Item = integer()
153
154              See external documentation.
155
156       findItem(This, Start, Str) -> integer()
157
158              Types:
159
160                 This = wxListCtrl()
161                 Start = integer()
162                 Str = unicode:chardata()
163
164              Equivalent to findItem(This, Start, Str, []).
165
166       findItem(This, Start, Str, Options::[Option]) -> integer()
167
168              Types:
169
170                 This = wxListCtrl()
171                 Start = integer()
172                 Str = unicode:chardata()
173                 Option = {partial, boolean()}
174
175              See external documentation.
176              Also:
177              findItem(This, Start, Pt, Direction) -> integer() when
178              This::wxListCtrl(),     Start::integer(),     Pt::{X::integer(),
179              Y::integer()}, Direction::integer().
180
181
182       getColumn(This, Col, Item) -> boolean()
183
184              Types:
185
186                 This = wxListCtrl()
187                 Col = integer()
188                 Item = wxListItem:wxListItem()
189
190              See external documentation.
191
192       getColumnCount(This) -> integer()
193
194              Types:
195
196                 This = wxListCtrl()
197
198              See external documentation.
199
200       getColumnWidth(This, Col) -> integer()
201
202              Types:
203
204                 This = wxListCtrl()
205                 Col = integer()
206
207              See external documentation.
208
209       getCountPerPage(This) -> integer()
210
211              Types:
212
213                 This = wxListCtrl()
214
215              See external documentation.
216
217       getEditControl(This) -> wxTextCtrl:wxTextCtrl()
218
219              Types:
220
221                 This = wxListCtrl()
222
223              See external documentation.
224
225       getImageList(This, Which) -> wxImageList:wxImageList()
226
227              Types:
228
229                 This = wxListCtrl()
230                 Which = integer()
231
232              See external documentation.
233
234       getItem(This, Info) -> boolean()
235
236              Types:
237
238                 This = wxListCtrl()
239                 Info = wxListItem:wxListItem()
240
241              See external documentation.
242
243       getItemBackgroundColour(This, Item) -> wx:wx_colour4()
244
245              Types:
246
247                 This = wxListCtrl()
248                 Item = integer()
249
250              See external documentation.
251
252       getItemCount(This) -> integer()
253
254              Types:
255
256                 This = wxListCtrl()
257
258              See external documentation.
259
260       getItemData(This, Item) -> integer()
261
262              Types:
263
264                 This = wxListCtrl()
265                 Item = integer()
266
267              See external documentation.
268
269       getItemFont(This, Item) -> wxFont:wxFont()
270
271              Types:
272
273                 This = wxListCtrl()
274                 Item = integer()
275
276              See external documentation.
277
278       getItemPosition(This, Item) -> Result
279
280              Types:
281
282                 Result = {Res::boolean(), Pos::{X::integer(), Y::integer()}}
283                 This = wxListCtrl()
284                 Item = integer()
285
286              See external documentation.
287
288       getItemRect(This, Item) -> Result
289
290              Types:
291
292                 Result = {Res::boolean(), Rect::{X::integer(),  Y::integer(),
293                 W::integer(), H::integer()}}
294                 This = wxListCtrl()
295                 Item = integer()
296
297              Equivalent to getItemRect(This, Item, []).
298
299       getItemRect(This, Item, Options::[Option]) -> Result
300
301              Types:
302
303                 Result  = {Res::boolean(), Rect::{X::integer(), Y::integer(),
304                 W::integer(), H::integer()}}
305                 This = wxListCtrl()
306                 Item = integer()
307                 Option = {code, integer()}
308
309              See external documentation.
310
311       getItemSpacing(This) -> {W::integer(), H::integer()}
312
313              Types:
314
315                 This = wxListCtrl()
316
317              See external documentation.
318
319       getItemState(This, Item, StateMask) -> integer()
320
321              Types:
322
323                 This = wxListCtrl()
324                 Item = integer()
325                 StateMask = integer()
326
327              See external documentation.
328
329       getItemText(This, Item) -> unicode:charlist()
330
331              Types:
332
333                 This = wxListCtrl()
334                 Item = integer()
335
336              See external documentation.
337
338       getItemTextColour(This, Item) -> wx:wx_colour4()
339
340              Types:
341
342                 This = wxListCtrl()
343                 Item = integer()
344
345              See external documentation.
346
347       getNextItem(This, Item) -> integer()
348
349              Types:
350
351                 This = wxListCtrl()
352                 Item = integer()
353
354              Equivalent to getNextItem(This, Item, []).
355
356       getNextItem(This, Item, Options::[Option]) -> integer()
357
358              Types:
359
360                 This = wxListCtrl()
361                 Item = integer()
362                 Option = {geometry, integer()} | {state, integer()}
363
364              See external documentation.
365
366       getSelectedItemCount(This) -> integer()
367
368              Types:
369
370                 This = wxListCtrl()
371
372              See external documentation.
373
374       getTextColour(This) -> wx:wx_colour4()
375
376              Types:
377
378                 This = wxListCtrl()
379
380              See external documentation.
381
382       getTopItem(This) -> integer()
383
384              Types:
385
386                 This = wxListCtrl()
387
388              See external documentation.
389
390       getViewRect(This)   ->   {X::integer(),   Y::integer(),   W::integer(),
391       H::integer()}
392
393              Types:
394
395                 This = wxListCtrl()
396
397              See external documentation.
398
399       hitTest(This, Point) -> Result
400
401              Types:
402
403                 Result  =  {Res::integer(), Flags::integer(), PSubItem::inte‐
404                 ger()}
405                 This = wxListCtrl()
406                 Point = {X::integer(), Y::integer()}
407
408              See external documentation.
409
410       insertColumn(This, Col, Heading) -> integer()
411
412              Types:
413
414                 This = wxListCtrl()
415                 Col = integer()
416                 Heading = unicode:chardata()
417
418              See external documentation.
419              Also:
420              insertColumn(This, Col, Info) -> integer() when
421              This::wxListCtrl(),   Col::integer(),    Info::wxListItem:wxLis‐
422              tItem().
423
424
425       insertColumn(This, Col, Heading, Options::[Option]) -> integer()
426
427              Types:
428
429                 This = wxListCtrl()
430                 Col = integer()
431                 Heading = unicode:chardata()
432                 Option = {format, integer()} | {width, integer()}
433
434              See external documentation.
435
436       insertItem(This, Info) -> integer()
437
438              Types:
439
440                 This = wxListCtrl()
441                 Info = wxListItem:wxListItem()
442
443              See external documentation.
444
445       insertItem(This, Index, ImageIndex) -> integer()
446
447              Types:
448
449                 This = wxListCtrl()
450                 Index = integer()
451                 ImageIndex = integer()
452
453              See external documentation.
454              Also:
455              insertItem(This, Index, Label) -> integer() when
456              This::wxListCtrl(), Index::integer(), Label::unicode:chardata().
457
458
459       insertItem(This, Index, Label, ImageIndex) -> integer()
460
461              Types:
462
463                 This = wxListCtrl()
464                 Index = integer()
465                 Label = unicode:chardata()
466                 ImageIndex = integer()
467
468              See external documentation.
469
470       refreshItem(This, Item) -> ok
471
472              Types:
473
474                 This = wxListCtrl()
475                 Item = integer()
476
477              See external documentation.
478
479       refreshItems(This, ItemFrom, ItemTo) -> ok
480
481              Types:
482
483                 This = wxListCtrl()
484                 ItemFrom = integer()
485                 ItemTo = integer()
486
487              See external documentation.
488
489       scrollList(This, Dx, Dy) -> boolean()
490
491              Types:
492
493                 This = wxListCtrl()
494                 Dx = integer()
495                 Dy = integer()
496
497              See external documentation.
498
499       setBackgroundColour(This, Colour) -> boolean()
500
501              Types:
502
503                 This = wxListCtrl()
504                 Colour = wx:wx_colour()
505
506              See external documentation.
507
508       setColumn(This, Col, Item) -> boolean()
509
510              Types:
511
512                 This = wxListCtrl()
513                 Col = integer()
514                 Item = wxListItem:wxListItem()
515
516              See external documentation.
517
518       setColumnWidth(This, Col, Width) -> boolean()
519
520              Types:
521
522                 This = wxListCtrl()
523                 Col = integer()
524                 Width = integer()
525
526              See external documentation.
527
528       setImageList(This, ImageList, Which) -> ok
529
530              Types:
531
532                 This = wxListCtrl()
533                 ImageList = wxImageList:wxImageList()
534                 Which = integer()
535
536              See external documentation.
537
538       setItem(This, Info) -> boolean()
539
540              Types:
541
542                 This = wxListCtrl()
543                 Info = wxListItem:wxListItem()
544
545              See external documentation.
546
547       setItem(This, Index, Col, Label) -> integer()
548
549              Types:
550
551                 This = wxListCtrl()
552                 Index = integer()
553                 Col = integer()
554                 Label = unicode:chardata()
555
556              Equivalent to setItem(This, Index, Col, Label, []).
557
558       setItem(This, Index, Col, Label, Options::[Option]) -> integer()
559
560              Types:
561
562                 This = wxListCtrl()
563                 Index = integer()
564                 Col = integer()
565                 Label = unicode:chardata()
566                 Option = {imageId, integer()}
567
568              See external documentation.
569
570       setItemBackgroundColour(This, Item, Col) -> ok
571
572              Types:
573
574                 This = wxListCtrl()
575                 Item = integer()
576                 Col = wx:wx_colour()
577
578              See external documentation.
579
580       setItemCount(This, Count) -> ok
581
582              Types:
583
584                 This = wxListCtrl()
585                 Count = integer()
586
587              See external documentation.
588
589       setItemData(This, Item, Data) -> boolean()
590
591              Types:
592
593                 This = wxListCtrl()
594                 Item = integer()
595                 Data = integer()
596
597              See external documentation.
598
599       setItemFont(This, Item, F) -> ok
600
601              Types:
602
603                 This = wxListCtrl()
604                 Item = integer()
605                 F = wxFont:wxFont()
606
607              See external documentation.
608
609       setItemImage(This, Item, Image) -> boolean()
610
611              Types:
612
613                 This = wxListCtrl()
614                 Item = integer()
615                 Image = integer()
616
617              Equivalent to setItemImage(This, Item, Image, []).
618
619       setItemImage(This, Item, Image, Options::[Option]) -> boolean()
620
621              Types:
622
623                 This = wxListCtrl()
624                 Item = integer()
625                 Image = integer()
626                 Option = {selImage, integer()}
627
628              See external documentation.
629
630       setItemColumnImage(This, Item, Column, Image) -> boolean()
631
632              Types:
633
634                 This = wxListCtrl()
635                 Item = integer()
636                 Column = integer()
637                 Image = integer()
638
639              See external documentation.
640
641       setItemPosition(This, Item, Pos) -> boolean()
642
643              Types:
644
645                 This = wxListCtrl()
646                 Item = integer()
647                 Pos = {X::integer(), Y::integer()}
648
649              See external documentation.
650
651       setItemState(This, Item, State, StateMask) -> boolean()
652
653              Types:
654
655                 This = wxListCtrl()
656                 Item = integer()
657                 State = integer()
658                 StateMask = integer()
659
660              See external documentation.
661
662       setItemText(This, Item, Str) -> ok
663
664              Types:
665
666                 This = wxListCtrl()
667                 Item = integer()
668                 Str = unicode:chardata()
669
670              See external documentation.
671
672       setItemTextColour(This, Item, Col) -> ok
673
674              Types:
675
676                 This = wxListCtrl()
677                 Item = integer()
678                 Col = wx:wx_colour()
679
680              See external documentation.
681
682       setSingleStyle(This, Style) -> ok
683
684              Types:
685
686                 This = wxListCtrl()
687                 Style = integer()
688
689              Equivalent to setSingleStyle(This, Style, []).
690
691       setSingleStyle(This, Style, Options::[Option]) -> ok
692
693              Types:
694
695                 This = wxListCtrl()
696                 Style = integer()
697                 Option = {add, boolean()}
698
699              See external documentation.
700
701       setTextColour(This, Col) -> ok
702
703              Types:
704
705                 This = wxListCtrl()
706                 Col = wx:wx_colour()
707
708              See external documentation.
709
710       setWindowStyleFlag(This, Style) -> ok
711
712              Types:
713
714                 This = wxListCtrl()
715                 Style = integer()
716
717              See external documentation.
718
719       sortItems(This::wxListCtrl(), SortCallBack::function()) -> boolean()
720
721              Sort the items in the list control
722
723
724              SortCallBack(Item1,Item2) -> integer()
725
726              SortCallBack  receives the client data associated with two items
727              to compare, and should return 0 if the items are equal, a  nega‐
728              tive  value  if the first item is less than the second one and a
729              positive value if the first item is greater than the second one.
730              NOTE: The callback may not call other (wx) processes.
731
732       destroy(This::wxListCtrl()) -> ok
733
734              Destroys this object, do not use object again
735

AUTHORS

737       <>
738
739
740
741                                    wx 1.9                       wxListCtrl(3)