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       findItem(This, Start, Pt, Direction) -> integer()
168
169              Types:
170
171                 This = wxListCtrl()
172                 Start = integer()
173                 Str = unicode:chardata()
174                 Option = {partial, boolean()}
175                 This = wxListCtrl()
176                 Start = integer()
177                 Pt = {X::integer(), Y::integer()}
178                 Direction = integer()
179
180              See external documentation.
181              Also:
182              findItem(This, Start, Pt, Direction) -> integer() when
183              This::wxListCtrl(),     Start::integer(),     Pt::{X::integer(),
184              Y::integer()}, Direction::integer().
185
186
187       getColumn(This, Col, Item) -> boolean()
188
189              Types:
190
191                 This = wxListCtrl()
192                 Col = integer()
193                 Item = wxListItem:wxListItem()
194
195              See external documentation.
196
197       getColumnCount(This) -> integer()
198
199              Types:
200
201                 This = wxListCtrl()
202
203              See external documentation.
204
205       getColumnWidth(This, Col) -> integer()
206
207              Types:
208
209                 This = wxListCtrl()
210                 Col = integer()
211
212              See external documentation.
213
214       getCountPerPage(This) -> integer()
215
216              Types:
217
218                 This = wxListCtrl()
219
220              See external documentation.
221
222       getEditControl(This) -> wxTextCtrl:wxTextCtrl()
223
224              Types:
225
226                 This = wxListCtrl()
227
228              See external documentation.
229
230       getImageList(This, Which) -> wxImageList:wxImageList()
231
232              Types:
233
234                 This = wxListCtrl()
235                 Which = integer()
236
237              See external documentation.
238
239       getItem(This, Info) -> boolean()
240
241              Types:
242
243                 This = wxListCtrl()
244                 Info = wxListItem:wxListItem()
245
246              See external documentation.
247
248       getItemBackgroundColour(This, Item) -> wx:wx_colour4()
249
250              Types:
251
252                 This = wxListCtrl()
253                 Item = integer()
254
255              See external documentation.
256
257       getItemCount(This) -> integer()
258
259              Types:
260
261                 This = wxListCtrl()
262
263              See external documentation.
264
265       getItemData(This, Item) -> integer()
266
267              Types:
268
269                 This = wxListCtrl()
270                 Item = integer()
271
272              See external documentation.
273
274       getItemFont(This, Item) -> wxFont:wxFont()
275
276              Types:
277
278                 This = wxListCtrl()
279                 Item = integer()
280
281              See external documentation.
282
283       getItemPosition(This, Item) -> Result
284
285              Types:
286
287                 Result = {Res::boolean(), Pos::{X::integer(), Y::integer()}}
288                 This = wxListCtrl()
289                 Item = integer()
290
291              See external documentation.
292
293       getItemRect(This, Item) -> Result
294
295              Types:
296
297                 Result = {Res::boolean(), Rect::{X::integer(),  Y::integer(),
298                 W::integer(), H::integer()}}
299                 This = wxListCtrl()
300                 Item = integer()
301
302              Equivalent to getItemRect(This, Item, []).
303
304       getItemRect(This, Item, Options::[Option]) -> Result
305
306              Types:
307
308                 Result  = {Res::boolean(), Rect::{X::integer(), Y::integer(),
309                 W::integer(), H::integer()}}
310                 This = wxListCtrl()
311                 Item = integer()
312                 Option = {code, integer()}
313
314              See external documentation.
315
316       getItemSpacing(This) -> {W::integer(), H::integer()}
317
318              Types:
319
320                 This = wxListCtrl()
321
322              See external documentation.
323
324       getItemState(This, Item, StateMask) -> integer()
325
326              Types:
327
328                 This = wxListCtrl()
329                 Item = integer()
330                 StateMask = integer()
331
332              See external documentation.
333
334       getItemText(This, Item) -> unicode:charlist()
335
336              Types:
337
338                 This = wxListCtrl()
339                 Item = integer()
340
341              See external documentation.
342
343       getItemTextColour(This, Item) -> wx:wx_colour4()
344
345              Types:
346
347                 This = wxListCtrl()
348                 Item = integer()
349
350              See external documentation.
351
352       getNextItem(This, Item) -> integer()
353
354              Types:
355
356                 This = wxListCtrl()
357                 Item = integer()
358
359              Equivalent to getNextItem(This, Item, []).
360
361       getNextItem(This, Item, Options::[Option]) -> integer()
362
363              Types:
364
365                 This = wxListCtrl()
366                 Item = integer()
367                 Option = {geometry, integer()} | {state, integer()}
368
369              See external documentation.
370
371       getSelectedItemCount(This) -> integer()
372
373              Types:
374
375                 This = wxListCtrl()
376
377              See external documentation.
378
379       getTextColour(This) -> wx:wx_colour4()
380
381              Types:
382
383                 This = wxListCtrl()
384
385              See external documentation.
386
387       getTopItem(This) -> integer()
388
389              Types:
390
391                 This = wxListCtrl()
392
393              See external documentation.
394
395       getViewRect(This)   ->   {X::integer(),   Y::integer(),   W::integer(),
396       H::integer()}
397
398              Types:
399
400                 This = wxListCtrl()
401
402              See external documentation.
403
404       hitTest(This, Point) -> Result
405
406              Types:
407
408                 Result  =  {Res::integer(), Flags::integer(), PSubItem::inte‐
409                 ger()}
410                 This = wxListCtrl()
411                 Point = {X::integer(), Y::integer()}
412
413              See external documentation.
414
415       insertColumn(This, Col, Heading) -> integer()
416       insertColumn(This, Col, Info) -> integer()
417
418              Types:
419
420                 This = wxListCtrl()
421                 Col = integer()
422                 Heading = unicode:chardata()
423                 This = wxListCtrl()
424                 Col = integer()
425                 Info = wxListItem:wxListItem()
426
427              See external documentation.
428              Also:
429              insertColumn(This, Col, Info) -> integer() when
430              This::wxListCtrl(),   Col::integer(),    Info::wxListItem:wxLis‐
431              tItem().
432
433
434       insertColumn(This, Col, Heading, Options::[Option]) -> integer()
435
436              Types:
437
438                 This = wxListCtrl()
439                 Col = integer()
440                 Heading = unicode:chardata()
441                 Option = {format, integer()} | {width, integer()}
442
443              See external documentation.
444
445       insertItem(This, Info) -> integer()
446
447              Types:
448
449                 This = wxListCtrl()
450                 Info = wxListItem:wxListItem()
451
452              See external documentation.
453
454       insertItem(This, Index, ImageIndex) -> integer()
455       insertItem(This, Index, Label) -> integer()
456
457              Types:
458
459                 This = wxListCtrl()
460                 Index = integer()
461                 ImageIndex = integer()
462                 This = wxListCtrl()
463                 Index = integer()
464                 Label = unicode:chardata()
465
466              See external documentation.
467              Also:
468              insertItem(This, Index, Label) -> integer() when
469              This::wxListCtrl(), Index::integer(), Label::unicode:chardata().
470
471
472       insertItem(This, Index, Label, ImageIndex) -> integer()
473
474              Types:
475
476                 This = wxListCtrl()
477                 Index = integer()
478                 Label = unicode:chardata()
479                 ImageIndex = integer()
480
481              See external documentation.
482
483       refreshItem(This, Item) -> ok
484
485              Types:
486
487                 This = wxListCtrl()
488                 Item = integer()
489
490              See external documentation.
491
492       refreshItems(This, ItemFrom, ItemTo) -> ok
493
494              Types:
495
496                 This = wxListCtrl()
497                 ItemFrom = integer()
498                 ItemTo = integer()
499
500              See external documentation.
501
502       scrollList(This, Dx, Dy) -> boolean()
503
504              Types:
505
506                 This = wxListCtrl()
507                 Dx = integer()
508                 Dy = integer()
509
510              See external documentation.
511
512       setBackgroundColour(This, Colour) -> boolean()
513
514              Types:
515
516                 This = wxListCtrl()
517                 Colour = wx:wx_colour()
518
519              See external documentation.
520
521       setColumn(This, Col, Item) -> boolean()
522
523              Types:
524
525                 This = wxListCtrl()
526                 Col = integer()
527                 Item = wxListItem:wxListItem()
528
529              See external documentation.
530
531       setColumnWidth(This, Col, Width) -> boolean()
532
533              Types:
534
535                 This = wxListCtrl()
536                 Col = integer()
537                 Width = integer()
538
539              See external documentation.
540
541       setImageList(This, ImageList, Which) -> ok
542
543              Types:
544
545                 This = wxListCtrl()
546                 ImageList = wxImageList:wxImageList()
547                 Which = integer()
548
549              See external documentation.
550
551       setItem(This, Info) -> boolean()
552
553              Types:
554
555                 This = wxListCtrl()
556                 Info = wxListItem:wxListItem()
557
558              See external documentation.
559
560       setItem(This, Index, Col, Label) -> integer()
561
562              Types:
563
564                 This = wxListCtrl()
565                 Index = integer()
566                 Col = integer()
567                 Label = unicode:chardata()
568
569              Equivalent to setItem(This, Index, Col, Label, []).
570
571       setItem(This, Index, Col, Label, Options::[Option]) -> integer()
572
573              Types:
574
575                 This = wxListCtrl()
576                 Index = integer()
577                 Col = integer()
578                 Label = unicode:chardata()
579                 Option = {imageId, integer()}
580
581              See external documentation.
582
583       setItemBackgroundColour(This, Item, Col) -> ok
584
585              Types:
586
587                 This = wxListCtrl()
588                 Item = integer()
589                 Col = wx:wx_colour()
590
591              See external documentation.
592
593       setItemCount(This, Count) -> ok
594
595              Types:
596
597                 This = wxListCtrl()
598                 Count = integer()
599
600              See external documentation.
601
602       setItemData(This, Item, Data) -> boolean()
603
604              Types:
605
606                 This = wxListCtrl()
607                 Item = integer()
608                 Data = integer()
609
610              See external documentation.
611
612       setItemFont(This, Item, F) -> ok
613
614              Types:
615
616                 This = wxListCtrl()
617                 Item = integer()
618                 F = wxFont:wxFont()
619
620              See external documentation.
621
622       setItemImage(This, Item, Image) -> boolean()
623
624              Types:
625
626                 This = wxListCtrl()
627                 Item = integer()
628                 Image = integer()
629
630              Equivalent to setItemImage(This, Item, Image, []).
631
632       setItemImage(This, Item, Image, Options::[Option]) -> boolean()
633
634              Types:
635
636                 This = wxListCtrl()
637                 Item = integer()
638                 Image = integer()
639                 Option = {selImage, integer()}
640
641              See external documentation.
642
643       setItemColumnImage(This, Item, Column, Image) -> boolean()
644
645              Types:
646
647                 This = wxListCtrl()
648                 Item = integer()
649                 Column = integer()
650                 Image = integer()
651
652              See external documentation.
653
654       setItemPosition(This, Item, Pos) -> boolean()
655
656              Types:
657
658                 This = wxListCtrl()
659                 Item = integer()
660                 Pos = {X::integer(), Y::integer()}
661
662              See external documentation.
663
664       setItemState(This, Item, State, StateMask) -> boolean()
665
666              Types:
667
668                 This = wxListCtrl()
669                 Item = integer()
670                 State = integer()
671                 StateMask = integer()
672
673              See external documentation.
674
675       setItemText(This, Item, Str) -> ok
676
677              Types:
678
679                 This = wxListCtrl()
680                 Item = integer()
681                 Str = unicode:chardata()
682
683              See external documentation.
684
685       setItemTextColour(This, Item, Col) -> ok
686
687              Types:
688
689                 This = wxListCtrl()
690                 Item = integer()
691                 Col = wx:wx_colour()
692
693              See external documentation.
694
695       setSingleStyle(This, Style) -> ok
696
697              Types:
698
699                 This = wxListCtrl()
700                 Style = integer()
701
702              Equivalent to setSingleStyle(This, Style, []).
703
704       setSingleStyle(This, Style, Options::[Option]) -> ok
705
706              Types:
707
708                 This = wxListCtrl()
709                 Style = integer()
710                 Option = {add, boolean()}
711
712              See external documentation.
713
714       setTextColour(This, Col) -> ok
715
716              Types:
717
718                 This = wxListCtrl()
719                 Col = wx:wx_colour()
720
721              See external documentation.
722
723       setWindowStyleFlag(This, Style) -> ok
724
725              Types:
726
727                 This = wxListCtrl()
728                 Style = integer()
729
730              See external documentation.
731
732       sortItems(This::wxListCtrl(), SortCallBack::function()) -> boolean()
733
734              Sort the items in the list control
735
736
737              SortCallBack(Item1,Item2) -> integer()
738
739              SortCallBack  receives the client data associated with two items
740              to compare, and should return 0 if the items are equal, a  nega‐
741              tive  value  if the first item is less than the second one and a
742              positive value if the first item is greater than the second one.
743              NOTE: The callback may not call other (wx) processes.
744
745       destroy(This::wxListCtrl()) -> ok
746
747              Destroys this object, do not use object again
748

AUTHORS

750       <>
751
752
753
754                                   wx 1.9.3                      wxListCtrl(3)