mask corrections

[wxWidgets.git] / docs / latex / wx / treectrl.tex

diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex
index 6e5b52fb27641b0fb8b44d858be1b54158c8d1a0..845cbc65a391341bc3abcfdf3fd855ad43c38f7e 100644 (file)
--- a/docs/latex/wx/treectrl.tex
+++ b/docs/latex/wx/treectrl.tex
@@ -21,7 +21,7 @@ To intercept events from a tree control, use the event table macros described in
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxTR\_HAS\_BUTTONS}}{Use this style to show + and - buttons to the
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxTR\_HAS\_BUTTONS}}{Use this style to show + and - buttons to the

-left of parent items.}
+left of parent items. Win32 only. }

 \twocolitem{\windowstyle{wxTR\_EDIT\_LABELS}}{Use this style if you wish the user to be
 able to edit labels in the tree control.}
 \twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style to allow the user to
 \twocolitem{\windowstyle{wxTR\_EDIT\_LABELS}}{Use this style if you wish the user to be
 able to edit labels in the tree control.}
 \twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style to allow the user to


@@ -159,7 +159,7 @@ EVT\_TREE\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no
 text control will appear for in-place editing.
 
 If the user changed the label (i.e. s/he does not press ESC or leave
 text control will appear for in-place editing.
 
 If the user changed the label (i.e. s/he does not press ESC or leave

-the text control without changes, a EVT\_TREE\_END\_LABEL\_EDIT event 
+the text control without changes, a EVT\_TREE\_END\_LABEL\_EDIT event

 will be sent which can be vetoed as well.
 
 \wxheading{See also}
 will be sent which can be vetoed as well.
 
 \wxheading{See also}


@@ -203,6 +203,10 @@ The return value is TRUE if the rectangle was successfully retrieved or FALSE
 if it was not (in this case {\it rect} is not changed) - for example, if the
 item is currently invisible.
 
 if it was not (in this case {\it rect} is not changed) - for example, if the
 item is currently invisible.
 

+\pythonnote{The wxPython version of this method requires only the
+\tt{item} and \tt{textOnly} parameters.  The return value is either a
+\tt{wxRect} object or \tt{None}.}
+

 \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
 
 \constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = TRUE}}
 \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
 
 \constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = TRUE}}


@@ -251,16 +255,9 @@ Returns the first visible item.
 
 \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist}
 
 
 \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist}
 

-\constfunc{wxImageList*}{GetImageList}{\param{int }{which = wxIMAGE\_LIST\_NORMAL}}
+\constfunc{wxImageList*}{GetImageList}{\void}

 
 

-Returns the specified image list. {\it which} may be one of:
-
-\twocolwidtha{5cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxIMAGE\_LIST\_NORMAL}}{The normal (large icon) image list.}
-\twocolitem{\windowstyle{wxIMAGE\_LIST\_SMALL}}{The small icon image list.}
-\twocolitem{\windowstyle{wxIMAGE\_LIST\_STATE}}{The user-defined state image list (unimplemented).}
-\end{twocollist}
+Returns the normal image list.

 
 \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent}
 
 
 \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent}
 


@@ -287,9 +284,20 @@ associated with the wxTreeItemData for the given item Id.}
 
 \membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
 
 
 \membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
 

-\constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item}}
-
-Gets the normal item image.
+\constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item},
+\param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}
+
+Gets the specified item image. The value of {\it which} may be:
+\begin{itemize}\itemsep=0pt
+\item{wxTreeItemIcon\_Normal} to get the normal item image
+\item{wxTreeItemIcon\_Selected} to get the selected item image (i.e. the image
+which is shown when the item is currently selected)
+\item{wxTreeItemIcon\_Expanded} to get the expanded image (this only
+makes sense for items which have children - then this image is shown when the
+item is expanded and the normal image is shown when it is collapsed)
+\item{wxTreeItemIcon\_SelectedExpanded} to get the selected expanded image
+(which is shown when an expanded item is currently selected)
+\end{itemize}

 
 \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
 
 
 \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
 


@@ -381,14 +389,15 @@ Returns the root item for the tree control.
 
 \constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}}
 
 
 \constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}}
 

-Gets the selected item image.
+Gets the selected item image (this function is obsolete, use
+{\tt GetItemImage(item, wxTreeItemIcon\_Selected} instead).

 
 \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection}
 
 \constfunc{wxTreeItemId}{GetSelection}{\void}
 
 Returns the selection, or an invalid item if there is no selection.
 
 \membersection{wxTreeCtrl::GetSelection}\label{wxtreectrlgetselection}
 
 \constfunc{wxTreeItemId}{GetSelection}{\void}
 
 Returns the selection, or an invalid item if there is no selection.

-This function only works with the controls without wxTR\_MULTIPLE style, use 
+This function only works with the controls without wxTR\_MULTIPLE style, use

 \helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
 this style.
 
 \helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
 this style.
 


@@ -401,6 +410,15 @@ function can be called only if the control has the wxTR\_MULTIPLE style.
 
 Returns the number of selected items.
 
 
 Returns the number of selected items.
 

+\pythonnote{The wxPython version of this method accepts no parameters
+and returns a Python list of \tt{wxTreeItemId}'s.}
+
+\membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist}
+
+\constfunc{wxImageList*}{GetStateImageList}{\void}
+
+Returns the state image list (from which application-defined state images are taken).
+

 \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
 
 \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
 \membersection{wxTreeCtrl::HitTest}\label{wxtreectrlhittest}
 
 \func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}


@@ -508,10 +526,15 @@ Sets the indentation for the tree control.
 
 \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
 
 
 \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
 

-\func{void}{SetImageList}{\param{wxImageList*}{ imageList}, \param{int }{which = wxIMAGE\_LIST\_NORMAL}}
+\func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
+
+Sets the normal image list.
+
+\membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour}
+
+\func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}

 
 

-Sets the image list. {\it which} should be one of wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL and
-wxIMAGE\_LIST\_STATE.
+Sets the colour of the items background.

 
 \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold}
 
 
 \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold}
 


@@ -535,6 +558,18 @@ Object with the wxTreeItemData for the given item Id.}
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
+
+\func{void}{SetItemFont}{\param{const wxTreeItemId\&}{ item}, \param{const wxFont\& }{font}}
+
+Sets the items font. All items in the tree should have the same height to avoid
+text clipping, so the fonts height should be the same for all of them,
+although font attributes may vary.
+
+\wxheading{See also}
+
+\helpref{SetItemBold}{wxtreectrlsetitembold}
+

 \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
 
 \func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = TRUE}}
 \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
 
 \func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = TRUE}}


@@ -546,15 +581,19 @@ usage and loading time.
 
 \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
 
 
 \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
 

-\func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{image}}
+\func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item},
+\param{int }{image},
+\param{wxTreeItemIcon }{which = wxTreeItemIcon\_Normal}}

 
 

-Sets the normal item image. This is an index into the assciated image list.
+Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage}
+for the description of {\it which} parameter.

 
 \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage}
 
 \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}}
 
 
 \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage}
 
 \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}}
 

-Sets the item selected image. This is an index into the assciated image list.
+Sets the selected item image (this function is obsolete, use
+{\tt SetItemImage(item, wxTreeItemIcon\_Selected} instead).

 
 \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
 
 
 \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
 


@@ -562,6 +601,18 @@ Sets the item selected image. This is an index into the assciated image list.
 
 Sets the item label.
 
 
 Sets the item label.
 

+\membersection{wxTreeCtrl::SetItemTextColour}\label{wxtreectrlsetitemtextcolour}
+
+\func{void}{SetItemTextColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}
+
+Sets the colour of the items text.
+
+\membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist}
+
+\func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}}
+
+Sets the state image list (from which application-defined state images are taken).
+

 \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
 
 \func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}
 \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
 
 \func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}


@@ -591,7 +642,7 @@ Removes the selection from the currently selected item (if any).
 
 \func{void}{UnselectAll}{\void}
 
 
 \func{void}{UnselectAll}{\void}
 

-This function either behaves the same as \helpref{Unselect}{wxtreectrlunselect} 
+This function either behaves the same as \helpref{Unselect}{wxtreectrlunselect}

 if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from
 all items if it does have this style.
 
 if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from
 all items if it does have this style.