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