]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/treectrl.tex
fix warning
[wxWidgets.git] / docs / latex / wx / treectrl.tex
index 812744fa3de7f1eca84c0abd2d03def90aa521bd..dbe43ff52a44e5a2cca81c7aad64a62a6f2309d1 100644 (file)
@@ -75,6 +75,7 @@ functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_TREE\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
 \twocolitem{{\bf EVT\_TREE\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
+\twocolitem{{\bf EVT\_TREE\_END\_DRAG(id, func)}}{End dragging with the left or right mouse button.}
 \twocolitem{{\bf EVT\_TREE\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
 \twocolitem{{\bf EVT\_TREE\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
 \twocolitem{{\bf EVT\_TREE\_DELETE\_ITEM(id, func)}}{Delete an item.}
@@ -88,6 +89,8 @@ functions that take a \helpref{wxTreeEvent}{wxtreeevent} argument.
 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGED(id, func)}}{Selection has changed.}
 \twocolitem{{\bf EVT\_TREE\_SEL\_CHANGING(id, func)}}{Selection is changing. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
 \twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip
+is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}
 \end{twocollist}
 
 \wxheading{See also}
@@ -103,11 +106,12 @@ library are known to have bugs with handling the tree control colours: the
 usual symptom is that the expanded items leave black (or otherwise incorrectly
 coloured) background behind them, especially for the controls using non
 default background colour. The recommended solution is to upgrade the {\tt comctl32.dll}
-to a newer version: see
+to a newer version: see 
 \urlref{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxTreeCtrl::wxTreeCtrl}\label{wxtreectrlconstr}
 
 \func{}{wxTreeCtrl}{\void}
@@ -141,12 +145,14 @@ appropriately.}
 
 \helpref{wxTreeCtrl::Create}{wxtreectrlcreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxTreeCtrl::\destruct{wxTreeCtrl}}
+
+\membersection{wxTreeCtrl::\destruct{wxTreeCtrl}}\label{wxtreectrldtor}
 
 \func{void}{\destruct{wxTreeCtrl}}{\void}
 
 Destructor, destroying the list control.
 
+
 \membersection{wxTreeCtrl::AddRoot}\label{wxtreectrladdroot}
 
 \func{wxTreeItemId}{AddRoot}{\param{const wxString\&}{ text},
@@ -160,6 +166,7 @@ selected items, respectively.
 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 both selected and unselected items.
 
+
 \membersection{wxTreeCtrl::AppendItem}\label{wxtreectrlappenditem}
 
 \func{wxTreeItemId}{AppendItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
@@ -173,6 +180,7 @@ selected items, respectively.
 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 both selected and unselected items.
 
+
 \membersection{wxTreeCtrl::AssignButtonsImageList}\label{wxtreectrlassignbuttonsimagelist}
 
 \func{void}{AssignButtonsImageList}{\param{wxImageList*}{ imageList}}
@@ -189,6 +197,7 @@ This function is only available in the generic version.
 
 See also \helpref{SetButtonsImageList}{wxtreectrlsetbuttonsimagelist}.
 
+
 \membersection{wxTreeCtrl::AssignImageList}\label{wxtreectrlassignimagelist}
 
 \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}}
@@ -199,6 +208,7 @@ be automatically deleted by wxTreeCtrl as appropriate
 
 See also \helpref{SetImageList}{wxtreectrlsetimagelist}.
 
+
 \membersection{wxTreeCtrl::AssignStateImageList}\label{wxtreectrlassignstateimagelist}
 
 \func{void}{AssignStateImageList}{\param{wxImageList*}{ imageList}}
@@ -210,18 +220,21 @@ be automatically deleted by wxTreeCtrl as appropriate
 See also \helpref{SetStateImageList}{wxtreectrlsetstateimagelist}.
 
 
+
 \membersection{wxTreeCtrl::Collapse}\label{wxtreectrlcollapse}
 
 \func{void}{Collapse}{\param{const wxTreeItemId\&}{ item}}
 
 Collapses the given item.
 
+
 \membersection{wxTreeCtrl::CollapseAndReset}\label{wxtreectrlcollapseandreset}
 
 \func{void}{CollapseAndReset}{\param{const wxTreeItemId\&}{ item}}
 
 Collapses the given item and removes all children.
 
+
 \membersection{wxTreeCtrl::Create}\label{wxtreectrlcreate}
 
 \func{bool}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
@@ -230,6 +243,7 @@ Collapses the given item and removes all children.
 
 Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details.
 
+
 \membersection{wxTreeCtrl::Delete}\label{wxtreectrldelete}
 
 \func{void}{Delete}{\param{const wxTreeItemId\&}{ item}}
@@ -237,12 +251,17 @@ Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr}
 Deletes the specified item. A {\tt EVT\_TREE\_DELETE\_ITEM} event will be
 generated.
 
+This function may cause a subsequent call to GetNextChild to fail.
+
+
 \membersection{wxTreeCtrl::DeleteAllItems}\label{wxtreectrldeleteallitems}
 
 \func{void}{DeleteAllItems}{\void}
 
-Deletes all the items in the control. Note that this will {\bf not} generate
-any events unlike \helpref{Delete}{wxtreectrldelete} method.
+Deletes all the items in the control. Note that this may not generate 
+{\tt EVT\_TREE\_DELETE\_ITEM} events under some Windows versions although
+normally such event is generated for each removed item.
+
 
 \membersection{wxTreeCtrl::DeleteChildren}\label{wxtreectrldeletechildren}
 
@@ -252,6 +271,11 @@ Deletes all children of the given item (but not the item itself). Note that
 this will {\bf not} generate any events unlike 
 \helpref{Delete}{wxtreectrldelete} method.
 
+If you have called \helpref{wxTreeCtrl::SetItemHasChildren}{wxtreectrlsetitemhaschildren}, you
+may need to call it again since {\it DeleteChildren} does not automatically
+clear the setting.
+
+
 \membersection{wxTreeCtrl::EditLabel}\label{wxtreectrleditlabel}
 
 \func{void}{EditLabel}{\param{const wxTreeItemId\&}{ item}}
@@ -269,11 +293,12 @@ will be sent which can be vetoed as well.
 \helpref{wxTreeCtrl::EndEditLabel}{wxtreectrlendeditlabel},
 \helpref{wxTreeEvent}{wxtreeevent}
 
+
 \membersection{wxTreeCtrl::EndEditLabel}\label{wxtreectrlendeditlabel}
 
 \func{void}{EndEditLabel}{\param{bool }{cancelEdit}}
 
-Ends label editing. If {\it cancelEdit} is {\tt TRUE}, the edit will be cancelled.
+Ends label editing. If {\it cancelEdit} is {\tt true}, the edit will be cancelled.
 
 This function is currently supported under Windows only.
 
@@ -281,27 +306,30 @@ This function is currently supported under Windows only.
 
 \helpref{wxTreeCtrl::EditLabel}{wxtreectrleditlabel}
 
+
 \membersection{wxTreeCtrl::EnsureVisible}\label{wxtreectrlensurevisible}
 
 \func{void}{EnsureVisible}{\param{const wxTreeItemId\&}{ item}}
 
 Scrolls and/or expands items to ensure that the given item is visible.
 
+
 \membersection{wxTreeCtrl::Expand}\label{wxtreectrlexpand}
 
 \func{void}{Expand}{\param{const wxTreeItemId\&}{ item}}
 
 Expands the given item.
 
+
 \membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect}
 
-\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = {\tt FALSE}}}
+\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = {\tt false}}}
 
-Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is {\tt TRUE},
+Retrieves the rectangle bounding the {\it item}. If {\it textOnly} is {\tt true},
 only the rectangle around the item's label will be returned, otherwise the
 item's image is also taken into account.
 
-The return value is {\tt TRUE} if the rectangle was successfully retrieved or {\tt FALSE}
+The return value is {\tt true} if the rectangle was successfully retrieved or {\tt false}
 if it was not (in this case {\it rect} is not changed) - for example, if the
 item is currently invisible.
 
@@ -312,6 +340,7 @@ item is currently invisible.
 \perlnote{In wxPerl this method only takes the parameters {\tt item} and 
   {\tt textOnly}, and returns a Wx::Rect ( or undef ).}
 
+
 \membersection{wxTreeCtrl::GetButtonsImageList}\label{wxtreectrlgetbuttonsimagelist}
 
 \constfunc{wxImageList*}{GetButtonsImageList}{\void}
@@ -320,19 +349,22 @@ Returns the buttons image list (from which application-defined button images are
 
 This function is only available in the generic version.
 
+
 \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount}
 
-\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt TRUE}}}
+\constfunc{size\_t}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt true}}}
 
-Returns the number of items in the branch. If {\it recursively} is {\tt TRUE}, returns the total number
+Returns the number of items in the branch. If {\it recursively} is {\tt true}, returns the total number
 of descendants, otherwise only one level of children is counted.
 
+
 \membersection{wxTreeCtrl::GetCount}\label{wxtreectrlgetcount}
 
 \constfunc{int}{GetCount}{\void}
 
 Returns the number of items in the control.
 
+
 \membersection{wxTreeCtrl::GetEditControl}\label{wxtreectrlgeteditcontrol}
 
 \constfunc{wxTextCtrl *}{GetEditControl}{\void}
@@ -342,9 +374,10 @@ if no label is being edited.
 
 {\bf NB:} It is currently only implemented for wxMSW.
 
+
 \membersection{wxTreeCtrl::GetFirstChild}\label{wxtreectrlgetfirstchild}
 
-\constfunc{wxTreeItemId}{GetFirstChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
+\constfunc{wxTreeItemId}{GetFirstChild}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemIdValue \& }{cookie}}
 
 Returns the first child; call \helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild} for the next child.
 
@@ -367,30 +400,35 @@ value are both returned as a tuple containing the two values.}
 \perlnote{In wxPerl this method only takes the {\tt item} parameter, and
   returns a 2-element list {\tt ( item, cookie )}.}
 
+
 \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
 
 \constfunc{wxTreeItemId}{GetFirstVisibleItem}{\void}
 
 Returns the first visible item.
 
+
 \membersection{wxTreeCtrl::GetImageList}\label{wxtreectrlgetimagelist}
 
 \constfunc{wxImageList*}{GetImageList}{\void}
 
 Returns the normal image list.
 
+
 \membersection{wxTreeCtrl::GetIndent}\label{wxtreectrlgetindent}
 
 \constfunc{int}{GetIndent}{\void}
 
 Returns the current tree control indentation.
 
+
 \membersection{wxTreeCtrl::GetItemBackgroundColour}\label{wxtreectrlgetitembackgroundcolour}
 
 \constfunc{wxColour}{GetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}}
 
 Returns the background colour of the item.
 
+
 \membersection{wxTreeCtrl::GetItemData}\label{wxtreectrlgetitemdata}
 
 \constfunc{wxTreeItemData*}{GetItemData}{\param{const wxTreeItemId\&}{ item}}
@@ -407,16 +445,16 @@ Returns the tree item data associated with the item.
 \twocolitem{{\bf GetPyData(item)}}{Returns the Python Object
 associated with the wxTreeItemData for the given item Id.}
 \end{twocollist}}
-}
+}%
 
 \perlnote{wxPerl provides the following shortcut method:
 \indented{2cm}{
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf GetPlData( item )}}{Returns the Perl data
-associated with the Wx::TreeItemData ( it is just the same as
-tree->GetItemData( item )->GetData(); ).}
+associated with the Wx::TreeItemData. It is just the same as
+tree->GetItemData(item)->GetData().}
 \end{twocollist}}
-}
+}%
 
 \membersection{wxTreeCtrl::GetItemFont}\label{wxtreectrlgetitemfont}
 
@@ -424,6 +462,7 @@ tree->GetItemData( item )->GetData(); ).}
 
 Returns the font of the item label.
 
+
 \membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
 
 \constfunc{int}{GetItemImage}{\param{const wxTreeItemId\& }{item},
@@ -442,18 +481,21 @@ item is expanded and the normal image is shown when it is collapsed)
 (which is shown when an expanded item is currently selected)
 \end{itemize}
 
+
 \membersection{wxTreeCtrl::GetItemText}\label{wxtreectrlgetitemtext}
 
 \constfunc{wxString}{GetItemText}{\param{const wxTreeItemId\&}{ item}}
 
 Returns the item label.
 
+
 \membersection{wxTreeCtrl::GetItemTextColour}\label{wxtreectrlgetitemtextcolour}
 
 \constfunc{wxColour}{GetItemTextColour}{\param{const wxTreeItemId\&}{ item}}
 
 Returns the colour of the item label.
 
+
 \membersection{wxTreeCtrl::GetLastChild}\label{wxtreectrlgetlastchild}
 
 \constfunc{wxTreeItemId}{GetLastChild}{\param{const wxTreeItemId\&}{ item}}
@@ -466,9 +508,10 @@ Returns the last child of the item (or an invalid tree item if this item has no
 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling},
 \helpref{GetLastChild}{wxtreectrlgetlastchild}
 
+
 \membersection{wxTreeCtrl::GetNextChild}\label{wxtreectrlgetnextchild}
 
-\constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{long\& }{cookie}}
+\constfunc{wxTreeItemId}{GetNextChild}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemIdValue \& }{cookie}}
 
 Returns the next child; call \helpref{wxTreeCtrl::GetFirstChild}{wxtreectrlgetfirstchild} for the first child.
 
@@ -490,6 +533,7 @@ value are both returned as a tuple containing the two values.}
 \perlnote{In wxPerl this method returns a 2-element list
   {\tt ( item, cookie )}, instead of modifying its parameters.}
 
+
 \membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
 
 \constfunc{wxTreeItemId}{GetNextSibling}{\param{const wxTreeItemId\&}{ item}}
@@ -502,18 +546,21 @@ Returns an invalid tree item if there are no further siblings.
 
 \helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling}
 
+
 \membersection{wxTreeCtrl::GetNextVisible}\label{wxtreectrlgetnextvisible}
 
 \constfunc{wxTreeItemId}{GetNextVisible}{\param{const wxTreeItemId\&}{ item}}
 
 Returns the next visible item.
 
+
 \membersection{wxTreeCtrl::GetItemParent}\label{wxtreectrlgetitemparent}
 
 \constfunc{wxTreeItemId}{GetItemParent}{\param{const wxTreeItemId\&}{ item}}
 
 Returns the item's parent.
 
+
 \membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent}
 
 \constfunc{wxTreeItemId}{GetParent}{\param{const wxTreeItemId\&}{ item}}
@@ -526,6 +573,7 @@ Returns the item's parent.
 \pythonnote{This method is named {\tt GetItemParent} to avoid a name
 clash with wxWindow::GetParent.}
 
+
 \membersection{wxTreeCtrl::GetPrevSibling}\label{wxtreectrlgetprevsibling}
 
 \constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}}
@@ -538,18 +586,21 @@ Returns an invalid tree item if there are no further children.
 
 \helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
 
+
 \membersection{wxTreeCtrl::GetPrevVisible}\label{wxtreectrlgetprevvisible}
 
 \constfunc{wxTreeItemId}{GetPrevVisible}{\param{const wxTreeItemId\&}{ item}}
 
 Returns the previous visible item.
 
+
 \membersection{wxTreeCtrl::GetRootItem}\label{wxtreectrlgetrootitem}
 
 \constfunc{wxTreeItemId}{GetRootItem}{\void}
 
 Returns the root item for the tree control.
 
+
 \membersection{wxTreeCtrl::GetItemSelectedImage}\label{wxtreectrlgetitemselectedimage}
 
 \constfunc{int}{GetItemSelectedImage}{\param{const wxTreeItemId\& }{item}}
@@ -557,6 +608,7 @@ Returns the root item for the tree control.
 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}
@@ -566,6 +618,7 @@ This function only works with the controls without wxTR\_MULTIPLE style, use
 \helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
 this style.
 
+
 \membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections}
 
 \constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
@@ -581,12 +634,14 @@ and returns a Python list of {\tt wxTreeItemId}s.}
 \perlnote{In wxPerl this method takes no parameters and returns a list of
  {\tt Wx::TreeItemId}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{wxTreeItemId}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
@@ -615,6 +670,7 @@ returned as a tuple.}
 \perlnote{In wxPerl this method only takes the {\tt point} parameter
   and returns a 2-element list {\tt ( item, flags )}.}
 
+
 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
 
 \func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxTreeItemId\& }{previous}, \param{const wxString\&}{ text},
@@ -624,6 +680,7 @@ returned as a tuple.}
  \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
 
 Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}).
+{\it before} must be less than the number of children.
 
 The {\it image} and {\it selImage} parameters are an index within
 the normal image list specifying the image to use for unselected and
@@ -634,37 +691,43 @@ both selected and unselected items.
 \pythonnote{The second form of this method is called
 {\tt InsertItemBefore} in wxPython.}
 
+
 \membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
 
 \constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}}
 
-Returns {\tt TRUE} if the given item is in bold state.
+Returns {\tt true} if the given item is in bold state.
 
 See also: \helpref{SetItemBold}{wxtreectrlsetitembold}
 
+
 \membersection{wxTreeCtrl::IsExpanded}\label{wxtreectrlisexpanded}
 
 \constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}}
 
-Returns {\tt TRUE} if the item is expanded (only makes sense if it has children).
+Returns {\tt true} if the item is expanded (only makes sense if it has children).
+
 
 \membersection{wxTreeCtrl::IsSelected}\label{wxtreectrlisselected}
 
 \constfunc{bool}{IsSelected}{\param{const wxTreeItemId\&}{ item}}
 
-Returns {\tt TRUE} if the item is selected.
+Returns {\tt true} if the item is selected.
+
 
 \membersection{wxTreeCtrl::IsVisible}\label{wxtreectrlisvisible}
 
 \constfunc{bool}{IsVisible}{\param{const wxTreeItemId\&}{ item}}
 
-Returns {\tt TRUE} if the item is visible (it might be outside the view, or not expanded).
+Returns {\tt true} if the item is visible (it might be outside the view, or not expanded).
+
 
 \membersection{wxTreeCtrl::ItemHasChildren}\label{wxtreectrlitemhaschildren}
 
 \constfunc{bool}{ItemHasChildren}{\param{const wxTreeItemId\&}{ item}}
 
-Returns {\tt TRUE} if the item has children.
+Returns {\tt true} if the item has children.
+
 
 \membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems}
 
@@ -679,6 +742,7 @@ The base class version compares items alphabetically.
 
 See also: \helpref{SortChildren}{wxtreectrlsortchildren}
 
+
 \membersection{wxTreeCtrl::PrependItem}\label{wxtreectrlprependitem}
 
 \func{wxTreeItemId}{PrependItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
@@ -692,17 +756,21 @@ selected items, respectively.
 If {\it image} > -1 and {\it selImage} is -1, the same image is used for
 both selected and unselected items.
 
+
 \membersection{wxTreeCtrl::ScrollTo}\label{wxtreectrlscrollto}
 
 \func{void}{ScrollTo}{\param{const wxTreeItemId\&}{ item}}
 
 Scrolls the specified item into view.
 
+
 \membersection{wxTreeCtrl::SelectItem}\label{wxtreectrlselectitem}
 
-\func{bool}{SelectItem}{\param{const wxTreeItemId\&}{ item}}
+\func{bool}{SelectItem}{\param{const wxTreeItemId\&}{ item}, \param{bool }{select = \true}}
+
+Selects the given item. In multiple selection controls, can be also used to
+deselect a currently selected item if the value of \arg{select} is false.
 
-Selects the given item.
 
 \membersection{wxTreeCtrl::SetButtonsImageList}\label{wxtreectrlsetbuttonsimagelist}
 
@@ -720,12 +788,14 @@ This function is only available in the generic version.
 
 See also \helpref{AssignButtonsImageList}{wxtreectrlassignbuttonsimagelist}.
 
+
 \membersection{wxTreeCtrl::SetIndent}\label{wxtreectrlsetindent}
 
 \func{void}{SetIndent}{\param{int }{indent}}
 
 Sets the indentation for the tree control.
 
+
 \membersection{wxTreeCtrl::SetImageList}\label{wxtreectrlsetimagelist}
 
 \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}
@@ -736,21 +806,24 @@ Sets the normal image list. Image list assigned with this method will
 See also \helpref{AssignImageList}{wxtreectrlassignimagelist}.
 
 
+
 \membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour}
 
 \func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}}
 
 Sets the colour of the item's background.
 
+
 \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold}
 
-\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = {\tt TRUE}}}
+\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = {\tt true}}}
 
-Makes item appear in bold font if {\it bold} parameter is {\tt TRUE} or resets it to
+Makes item appear in bold font if {\it bold} parameter is {\tt true} or resets it to
 the normal state.
 
 See also: \helpref{IsBold}{wxtreectrlisbold}
 
+
 \membersection{wxTreeCtrl::SetItemData}\label{wxtreectrlsetitemdata}
 
 \func{void}{SetItemData}{\param{const wxTreeItemId\&}{ item}, \param{wxTreeItemData* }{data}}
@@ -762,16 +835,16 @@ Sets the item client data.
 \twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python
 Object with the wxTreeItemData for the given item Id.}
 \end{twocollist}}
-}
+}%
 
 \perlnote{wxPerl provides the following shortcut method:
 \indented{2cm}{
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf SetPlData( item, data )}}{Sets the Perl data
-associated with the Wx::TreeItemData ( it is just the same as
-tree->GetItemData( item )->SetData( data ); ).}
+associated with the Wx::TreeItemData. It is just the same as
+tree->GetItemData(item)->SetData(data).}
 \end{twocollist}}
-}
+}%
 
 \membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
 
@@ -785,15 +858,17 @@ although font attributes may vary.
 
 \helpref{SetItemBold}{wxtreectrlsetitembold}
 
+
 \membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
 
-\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = {\tt TRUE}}}
+\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = {\tt true}}}
 
 Force appearance of the button next to the item. This is useful to
 allow the user to expand the items which don't have any children now,
 but instead adding them only when needed, thus minimizing memory
 usage and loading time.
 
+
 \membersection{wxTreeCtrl::SetItemImage}\label{wxtreectrlsetitemimage}
 
 \func{void}{SetItemImage}{\param{const wxTreeItemId\&}{ item},
@@ -802,24 +877,28 @@ usage and loading time.
 Sets the specified item image. See \helpref{GetItemImage}{wxtreectrlgetitemimage}
 for the description of the {\it which} parameter.
 
+
 \membersection{wxTreeCtrl::SetItemSelectedImage}\label{wxtreectrlsetitemselectedimage}
 
 \func{void}{SetItemSelectedImage}{\param{const wxTreeItemId\&}{ item}, \param{int }{selImage}}
 
 Sets the selected item image (this function is obsolete, use {\tt SetItemImage(item, wxTreeItemIcon\_Selected}) instead).
 
+
 \membersection{wxTreeCtrl::SetItemText}\label{wxtreectrlsetitemtext}
 
 \func{void}{SetItemText}{\param{const wxTreeItemId\&}{ item}, \param{const wxString\& }{text}}
 
 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 item's text.
 
+
 \membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist}
 
 \func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}}
@@ -830,12 +909,15 @@ Image list assigned with this method will
 
 See also \helpref{AssignStateImageList}{wxtreectrlassignstateimagelist}.
 
+\membersection{wxTreeCtrl::SetWindowStyle}\label{wxtreectrlsetwindowstyle}
+
 \func{void}{SetWindowStyle}{\param{long}{styles}}
 
 Sets the mode flags associated with the display of the tree control.
 The new mode takes effect immediately.
 (Generic only; MSW ignores changes.)
 
+
 \membersection{wxTreeCtrl::SortChildren}\label{wxtreectrlsortchildren}
 
 \func{void}{SortChildren}{\param{const wxTreeItemId\&}{ item}}
@@ -843,24 +925,35 @@ The new mode takes effect immediately.
 Sorts the children of the given item using
 \helpref{OnCompareItems}{wxtreectrloncompareitems} method of wxTreeCtrl. You
 should override that method to change the sort order (the default is ascending
-alphabetical order).
+case-sensitive alphabetical order).
 
 \wxheading{See also}
 
 \helpref{wxTreeItemData}{wxtreeitemdata}, \helpref{OnCompareItems}{wxtreectrloncompareitems}
 
+
 \membersection{wxTreeCtrl::Toggle}\label{wxtreectrltoggle}
 
 \func{void}{Toggle}{\param{const wxTreeItemId\&}{ item}}
 
 Toggles the given item between collapsed and expanded states.
 
+
+\membersection{wxTreeCtrl::ToggleItemSelection}\label{wxtreectrltoggleitemselection}
+
+\func{void}{ToggleItemSelection}{\param{const wxTreeItemId\&}{ item}}
+
+Toggles the given item between selected and unselected states. For
+multiselection controls only.
+
+
 \membersection{wxTreeCtrl::Unselect}\label{wxtreectrlunselect}
 
 \func{void}{Unselect}{\void}
 
 Removes the selection from the currently selected item (if any).
 
+
 \membersection{wxTreeCtrl::UnselectAll}\label{wxtreectrlunselectall}
 
 \func{void}{UnselectAll}{\void}
@@ -869,3 +962,11 @@ 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.
 
+
+\membersection{wxTreeCtrl::UnselectItem}\label{wxtreectrlunselectitem}
+
+\func{void}{UnselectItem}{\param{const wxTreeItemId\& }{item}}
+
+Unselects the given item. This works in multiselection controls only.
+
+