]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/listitem.tex
Added logic, API and docs for wxDataViewModel::HasDefaultCompare indicating a compare...
[wxWidgets.git] / docs / latex / wx / listitem.tex
index 0cd02ffbbc278d390393fce850d5e75a2188ed30..1e9919b0426788e89e5231c13f6e3a543db73890 100644 (file)
@@ -24,8 +24,6 @@ Constructor.
 
 Resets the item state to the default.
 
-
-
 \membersection{wxListItem::GetAlign}\label{wxlistitemgetalign}
 
 \constfunc{wxListColumnFormat}{GetAlign}{\void}
@@ -33,31 +31,24 @@ Resets the item state to the default.
 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.
-
-
+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}
 
@@ -65,16 +56,12 @@ Returns client data associated with the control.
 
 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}
@@ -82,8 +69,6 @@ Returns the zero-based item position.
 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}
@@ -93,16 +78,14 @@ can be any combination of the following values:
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{wxLIST\_MASK\_STATE}{The {\bf GetState} is valid.}
-\twocolitem{wxLIST\_MASK\_TEXT}{The {\bf GetText} is valid.}
-\twocolitem{wxLIST\_MASK\_IMAGE}{The {\bf GetImage} is valid.}
-\twocolitem{wxLIST\_MASK\_DATA}{The {\bf GetData} is valid.}
-\twocolitem{wxLIST\_MASK\_WIDTH}{The {\bf GetWidth} is valid.}
-\twocolitem{wxLIST\_MASK\_FORMAT}{The {\bf GetAlign} is valid.}
+\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}
@@ -119,40 +102,30 @@ combination of:
 \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::SetAlign}{wxlistitemsetalign}
-
-
+\helpref{wxListItem::GetAlign}{wxlistitemgetalign}
 
 \membersection{wxListItem::SetBackgroundColour}\label{wxlistitemsetbackgroundcolour}
 
@@ -160,15 +133,11 @@ Sets the alignment for the item. See also
 
 Sets the background colour for the item.
 
-
-
 \membersection{wxListItem::SetColumn}\label{wxlistitemsetcolumn}
 
 \func{void}{SetColumn}{\param{int }{col}}
 
-Sets the zer-based column. Meaningful only in report mode.
-
-
+Sets the zero-based column. Meaningful only in report mode.
 
 \membersection{wxListItem::SetData}\label{wxlistitemsetdata}
 
@@ -176,9 +145,8 @@ Sets the zer-based column. Meaningful only in report mode.
 
 \func{void}{SetData}{\param{void* }{data}}
 
-Sets client data for the item.
-
-
+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}
 
@@ -186,33 +154,24 @@ Sets client data for the item.
 
 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}}
 
-Returns the zero-based index of the image associated with the item
+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::SetMask}{wxlistitemsetmask}.
-
-
+Sets the mask of valid fields. See \helpref{wxListItem::GetMask}{wxlistitemgetmask}.
 
 \membersection{wxListItem::SetState}\label{wxlistitemsetstate}
 
@@ -221,11 +180,9 @@ Sets the mask of valid fields. See
 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}{wxlistitemsetstate} for valid flag
+See \helpref{wxListItem::GetState}{wxlistitemgetstate} for valid flag
 values.
 
-
-
 \membersection{wxListItem::SetStateMask}\label{wxlistitemsetstatemask}
 
 \func{void}{SetStateMask}{\param{long }{stateMask}}
@@ -233,26 +190,21 @@ values.
 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.
+