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

NAME

6       wxListItem - Functions for wxListItem class
7

DESCRIPTION

9       This class stores information about a wxListCtrl item or column.
10
11       wxListItem is a class which contains information about:
12
13       The  wxListItem  object  can also contain item-specific colour and font
14       information: for this you need to call one of setTextColour/2, setBack‐
15       groundColour/2  or setFont/2 functions on it passing it the colour/font
16       to use. If the colour/font is not specified, the default  list  control
17       colour/font is used.
18
19       See: wxListCtrl
20
21       wxWidgets docs: wxListItem
22

DATA TYPES

24       wxListItem() = wx:wx_object()
25

EXPORTS

27       new() -> wxListItem()
28
29              Constructor.
30
31       new(Item) -> wxListItem()
32
33              Types:
34
35                 Item = wxListItem()
36
37       clear(This) -> ok
38
39              Types:
40
41                 This = wxListItem()
42
43              Resets the item state to the default.
44
45       getAlign(This) -> wx:wx_enum()
46
47              Types:
48
49                 This = wxListItem()
50
51              Returns the alignment for this item.
52
53              Can   be   one  of  wxLIST_FORMAT_LEFT,  wxLIST_FORMAT_RIGHT  or
54              wxLIST_FORMAT_CENTRE.
55
56       getBackgroundColour(This) -> wx:wx_colour4()
57
58              Types:
59
60                 This = wxListItem()
61
62              Returns the background colour for this item.
63
64       getColumn(This) -> integer()
65
66              Types:
67
68                 This = wxListItem()
69
70              Returns the zero-based column; meaningful only in report mode.
71
72       getFont(This) -> wxFont:wxFont()
73
74              Types:
75
76                 This = wxListItem()
77
78              Returns the font used to display the item.
79
80       getId(This) -> integer()
81
82              Types:
83
84                 This = wxListItem()
85
86              Returns the zero-based item position.
87
88       getImage(This) -> integer()
89
90              Types:
91
92                 This = wxListItem()
93
94              Returns the zero-based index of the image  associated  with  the
95              item into the image list.
96
97       getMask(This) -> integer()
98
99              Types:
100
101                 This = wxListItem()
102
103              Returns  a bit mask indicating which fields of the structure are
104              valid.
105
106              Can be any combination of the following values:
107
108       getState(This) -> integer()
109
110              Types:
111
112                 This = wxListItem()
113
114              Returns a bit field representing the state of the item.
115
116              Can be any combination of:
117
118       getText(This) -> unicode:charlist()
119
120              Types:
121
122                 This = wxListItem()
123
124              Returns the label/header text.
125
126       getTextColour(This) -> wx:wx_colour4()
127
128              Types:
129
130                 This = wxListItem()
131
132              Returns the text colour.
133
134       getWidth(This) -> integer()
135
136              Types:
137
138                 This = wxListItem()
139
140              Meaningful only for column headers in report mode.
141
142              Returns the column width.
143
144       setAlign(This, Align) -> ok
145
146              Types:
147
148                 This = wxListItem()
149                 Align = wx:wx_enum()
150
151              Sets the alignment for the item.
152
153              See also getAlign/1
154
155       setBackgroundColour(This, ColBack) -> ok
156
157              Types:
158
159                 This = wxListItem()
160                 ColBack = wx:wx_colour()
161
162              Sets the background colour for the item.
163
164       setColumn(This, Col) -> ok
165
166              Types:
167
168                 This = wxListItem()
169                 Col = integer()
170
171              Sets the zero-based column.
172
173              Meaningful only in report mode.
174
175       setFont(This, Font) -> ok
176
177              Types:
178
179                 This = wxListItem()
180                 Font = wxFont:wxFont()
181
182              Sets the font for the item.
183
184       setId(This, Id) -> ok
185
186              Types:
187
188                 This = wxListItem()
189                 Id = integer()
190
191              Sets the zero-based item position.
192
193       setImage(This, Image) -> ok
194
195              Types:
196
197                 This = wxListItem()
198                 Image = integer()
199
200              Sets the zero-based index of the image associated with the  item
201              into the image list.
202
203       setMask(This, Mask) -> ok
204
205              Types:
206
207                 This = wxListItem()
208                 Mask = integer()
209
210              Sets the mask of valid fields.
211
212              See getMask/1.
213
214       setState(This, State) -> ok
215
216              Types:
217
218                 This = wxListItem()
219                 State = integer()
220
221              Sets  the  item state flags (note that the valid state flags are
222              influenced by the value of the state mask, see setStateMask/2).
223
224              See getState/1 for valid flag values.
225
226       setStateMask(This, StateMask) -> ok
227
228              Types:
229
230                 This = wxListItem()
231                 StateMask = integer()
232
233              Sets the bitmask that is used to determine which  of  the  state
234              flags are to be set.
235
236              See also setState/2.
237
238       setText(This, Text) -> ok
239
240              Types:
241
242                 This = wxListItem()
243                 Text = unicode:chardata()
244
245              Sets the text label for the item.
246
247       setTextColour(This, ColText) -> ok
248
249              Types:
250
251                 This = wxListItem()
252                 ColText = wx:wx_colour()
253
254              Sets the text colour for the item.
255
256       setWidth(This, Width) -> ok
257
258              Types:
259
260                 This = wxListItem()
261                 Width = integer()
262
263              Meaningful only for column headers in report mode.
264
265              Sets the column width.
266
267       destroy(This :: wxListItem()) -> ok
268
269              Destroys the object.
270
271
272
273wxWidgets team.                     wx 2.1                       wxListItem(3)