]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/listitem.tex
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
better Wait/Delete() docs (patch 1434085)
[wxWidgets.git] / docs / latex / wx / listitem.tex
... / ...
CommitLineData
1\section{\class{wxListItem}}\label{wxlistitem}
2
3This class stores information about a wxListCtrl item or column.
4
5\wxheading{Derived from}
6
7\helpref{wxObject}{wxobject}
8
9\wxheading{Include files}
10
11<wx/listctrl.h>
12
13\latexignore{\rtfignore{\wxheading{Members}}}
14
15\membersection{wxListItem::wxListItem}\label{wxlistitemwxlistitem}
16
17\func{}{wxListItem}{\void}
18
19Constructor.
20
21\membersection{wxListItem::Clear}\label{wxlistitemclear}
22
23\func{void}{Clear}{\void}
24
25Resets the item state to the default.
26
27\membersection{wxListItem::GetAlign}\label{wxlistitemgetalign}
28
29\constfunc{wxListColumnFormat}{GetAlign}{\void}
30
31Returns the alignment for this item. Can be one of
32wxLIST\_FORMAT\_LEFT, wxLIST\_FORMAT\_RIGHT or wxLIST\_FORMAT\_CENTRE.
33
34\membersection{wxListItem::GetBackgroundColour}\label{wxlistitemgetbackgroundcolour}
35
36\constfunc{wxColour}{GetBackgroundColour}{\void}
37
38Returns the background colour for this item.
39
40\membersection{wxListItem::GetColumn}\label{wxlistitemgetcolumn}
41
42\constfunc{int}{GetColumn}{\void}
43
44Returns the zero-based column; meaningful only in report mode.
45
46\membersection{wxListItem::GetData}\label{wxlistitemgetdata}
47
48\constfunc{long}{GetData}{\void}
49
50Returns client data associated with the control. Please note that
51client data is associated with the item and not with subitems.
52
53\membersection{wxListItem::GetFont}\label{wxlistitemgetfont}
54
55\constfunc{wxFont}{GetFont}{\void}
56
57Returns the font used to display the item.
58
59\membersection{wxListItem::GetId}\label{wxlistitemgetid}
60
61\constfunc{long}{GetId}{\void}
62
63Returns the zero-based item position.
64
65\membersection{wxListItem::GetImage}\label{wxlistitemgetimage}
66
67\constfunc{int}{GetImage}{\void}
68
69Returns the zero-based index of the image
70associated with the item into the image list.
71
72\membersection{wxListItem::GetMask}\label{wxlistitemgetmask}
73
74\constfunc{long}{GetMask}{\void}
75
76Returns a bit mask indicating which fields of the structure are valid;
77can be any combination of the following values:
78
79\twocolwidtha{5cm}
80\begin{twocollist}\itemsep=0pt
81\twocolitem{wxLIST\_MASK\_STATE}{{\bf GetState} is valid.}
82\twocolitem{wxLIST\_MASK\_TEXT}{{\bf GetText} is valid.}
83\twocolitem{wxLIST\_MASK\_IMAGE}{{\bf GetImage} is valid.}
84\twocolitem{wxLIST\_MASK\_DATA}{{\bf GetData} is valid.}
85\twocolitem{wxLIST\_MASK\_WIDTH}{{\bf GetWidth} is valid.}
86\twocolitem{wxLIST\_MASK\_FORMAT}{{\bf GetFormat} is valid.}
87\end{twocollist}
88
89\membersection{wxListItem::GetState}\label{wxlistitemgetstate}
90
91\constfunc{long}{GetState}{\void}
92
93Returns a bit field representing the state of the item. Can be any
94combination of:
95
96\twocolwidtha{5cm}
97\begin{twocollist}\itemsep=0pt
98\twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is. Win32 only. }
99\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event. Win32 only. }
100\twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.}
101\twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.}
102\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state. Win32 only. }
103\end{twocollist}
104
105\membersection{wxListItem::GetText}\label{wxlistitemgettext}
106
107\constfunc{const wxString\&}{GetText}{\void}
108
109Returns the label/header text.
110
111\membersection{wxListItem::GetTextColour}\label{wxlistitemgettextcolour}
112
113\constfunc{wxColour}{GetTextColour}{\void}
114
115Returns the text colour.
116
117\membersection{wxListItem::GetWidth}\label{wxlistitemgetwidth}
118
119\constfunc{int}{GetWidth}{\void}
120
121Meaningful only for column headers in report mode. Returns the column width.
122
123\membersection{wxListItem::SetAlign}\label{wxlistitemsetalign}
124
125\func{void}{SetAlign}{\param{wxListColumnFormat }{align}}
126
127Sets the alignment for the item. See also
128\helpref{wxListItem::GetAlign}{wxlistitemgetalign}
129
130\membersection{wxListItem::SetBackgroundColour}\label{wxlistitemsetbackgroundcolour}
131
132\func{void}{SetBackgroundColour}{\param{const wxColour\& }{colBack}}
133
134Sets the background colour for the item.
135
136\membersection{wxListItem::SetColumn}\label{wxlistitemsetcolumn}
137
138\func{void}{SetColumn}{\param{int }{col}}
139
140Sets the zero-based column. Meaningful only in report mode.
141
142\membersection{wxListItem::SetData}\label{wxlistitemsetdata}
143
144\func{void}{SetData}{\param{long }{data}}
145
146\func{void}{SetData}{\param{void* }{data}}
147
148Sets client data for the item. Please note that
149client data is associated with the item and not with subitems.
150
151\membersection{wxListItem::SetFont}\label{wxlistitemsetfont}
152
153\func{void}{SetFont}{\param{const wxFont\& }{font}}
154
155Sets the font for the item.
156
157\membersection{wxListItem::SetId}\label{wxlistitemsetid}
158
159\func{void}{SetId}{\param{long }{id}}
160
161Sets the zero-based item position.
162
163\membersection{wxListItem::SetImage}\label{wxlistitemsetimage}
164
165\func{void}{SetImage}{\param{int }{image}}
166
167Sets the zero-based index of the image associated with the item
168into the image list.
169
170\membersection{wxListItem::SetMask}\label{wxlistitemsetmask}
171
172\func{void}{SetMask}{\param{long }{mask}}
173
174Sets the mask of valid fields. See \helpref{wxListItem::GetMask}{wxlistitemgetmask}.
175
176\membersection{wxListItem::SetState}\label{wxlistitemsetstate}
177
178\func{void}{SetState}{\param{long }{state}}
179
180Sets the item state flags (note that the valid state flags are influenced
181by the value of the state mask, see
182\helpref{wxListItem::SetStateMask}{wxlistitemsetstatemask}).
183See \helpref{wxListItem::GetState}{wxlistitemgetstate} for valid flag
184values.
185
186\membersection{wxListItem::SetStateMask}\label{wxlistitemsetstatemask}
187
188\func{void}{SetStateMask}{\param{long }{stateMask}}
189
190Sets the bitmask that is used to determine which of the state flags
191are to be set. See also \helpref{wxListItem::SetState}{wxlistitemsetstate}.
192
193\membersection{wxListItem::SetText}\label{wxlistitemsettext}
194
195\func{void}{SetText}{\param{const wxString\& }{text}}
196
197Sets the text label for the item.
198
199\membersection{wxListItem::SetTextColour}\label{wxlistitemsettextcolour}
200
201\func{void}{SetTextColour}{\param{const wxColour\& }{colText}}
202
203Sets the text colour for the item.
204
205\membersection{wxListItem::SetWidth}\label{wxlistitemsetwidth}
206
207\func{void}{SetWidth}{\param{int }{width}}
208
209Meaningful only for column headers in report mode. Sets the column width.
210
wxWidgets (Impactor)