+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name: treectrl.tex
+%% Purpose: wxTreeCtrl documentation
+%% Author: wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID: $Id$
+%% Copyright: (c) wxWidgets Team
+%% License: wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section{\class{wxTreeCtrl}}\label{wxtreectrl}
A tree control presents information as a hierarchy, with items that may be expanded
-to show further items. Items in a tree control are referenced by wxTreeItemId handles.
+to show further items. Items in a tree control are referenced by wxTreeItemId handles,
+which may be tested for validity by calling wxTreeItemId::IsOk.
To intercept events from a tree control, use the event table macros described in \helpref{wxTreeEvent}{wxtreeevent}.
to document that no buttons are to be drawn.}
\twocolitem{\windowstyle{wxTR\_HAS\_BUTTONS}}{Use this style
to show + and - buttons to the left of parent items.}
-\twocolitem{\windowstyle{wxTR\_TWIST\_BUTTONS}}{Use this style
-to show Mac-style twister buttons to the left of parent items.
-If both wxTR\_HAS\_BUTTONS and wxTR\_TWIST\_BUTTONS are given,
-twister buttons are generated. Generic only.}
\twocolitem{\windowstyle{wxTR\_NO\_LINES}}{Use this style
to hide vertical level connectors.}
+\twocolitem{\windowstyle{wxTR\_FULL\_ROW\_HIGHLIGHT}}{Use this style to have the background
+colour and the selection highlight extend over the entire horizontal
+row of the tree control window. (This flag is ignored under Windows unless you
+specify wxTR\_NO\_LINES as well.) }
\twocolitem{\windowstyle{wxTR\_LINES\_AT\_ROOT}}{Use this style
to show lines between root nodes.
Only applicable if wxTR\_HIDE\_ROOT is set and wxTR\_NO\_LINES is not set.}
\twocolitem{\windowstyle{wxTR\_HIDE\_ROOT}}{Use this style
to suppress the display of the root node,
effectively causing the first-level nodes
-to appear as a series of root nodes. Generic only.}
+to appear as a series of root nodes.}
\twocolitem{\windowstyle{wxTR\_ROW\_LINES}}{Use this style
to draw a contrasting border between displayed rows.}
\twocolitem{\windowstyle{wxTR\_HAS\_VARIABLE\_ROW\_HEIGHT}}{Use this style
\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.}
\twocolitem{{\bf EVT\_TREE\_ITEM\_COLLAPSING(id, func)}}{The item is being collapsed. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
\twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDED(id, func)}}{The item has been expanded.}
\twocolitem{{\bf EVT\_TREE\_ITEM\_EXPANDING(id, func)}}{The item is being expanded. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_RIGHT\_CLICK(id, func)}}{The user has clicked the item with the right mouse button.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_MIDDLE\_CLICK(id, func)}}{The user has clicked the item with the middle mouse button.}
\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.}
-\end{twocollist}%
+\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.}
+\twocolitem{{\bf EVT\_TREE\_ITEM\_MENU(id, func)}}{The context menu for the selected item has been requested, either by a right click or by using the menu key.}
+\twocolitem{{\bf EVT\_TREE\_STATE\_IMAGE\_CLICK(id, func)}}{The state image has been clicked. Windows only.}
+\end{twocollist}
\wxheading{See also}
implemented in the system library {\tt comctl32.dll}. Some versions of this
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}
+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
-\urlref{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}.
+\urlref{http://www.microsoft.com/downloads/release.asp?ReleaseID=11916}{http://www.microsoft.com/downloads/release.asp?ReleaseID=11916}.
\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxTreeCtrl::wxTreeCtrl}\label{wxtreectrlconstr}
\func{}{wxTreeCtrl}{\void}
\func{}{wxTreeCtrl}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
+\param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``treeCtrl"}}
Constructor, creating and showing a tree control.
\wxheading{Parameters}
-\docparam{parent}{Parent window. Must not be NULL.}
+\docparam{parent}{Parent window. Must not be {\tt NULL}.}
\docparam{id}{Window identifier. A value of -1 indicates a default value.}
\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.
+Destructor, destroying the tree control.
+
\membersection{wxTreeCtrl::AddRoot}\label{wxtreectrladdroot}
\func{wxTreeItemId}{AddRoot}{\param{const wxString\&}{ text},
- \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
+ \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
Adds the root node to the tree, returning the new item.
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},
- \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
+ \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
Appends an item to the end of the branch identified by {\it parent}, return a new item id.
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}}
Setting or assigning the button image list enables the display of image buttons.
Once enabled, the only way to disable the display of button images is to set
-the button image list to NULL.
+the button image list to {\tt NULL}.
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}}
See also \helpref{SetImageList}{wxtreectrlsetimagelist}.
+
\membersection{wxTreeCtrl::AssignStateImageList}\label{wxtreectrlassignstateimagelist}
\func{void}{AssignStateImageList}{\param{wxImageList*}{ imageList}}
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
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
+\param{long}{ style = wxTR\_HAS\_BUTTONS}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``treeCtrl"}}
Creates the tree control. See \helpref{wxTreeCtrl::wxTreeCtrl}{wxtreectrlconstr} for further details.
+
\membersection{wxTreeCtrl::Delete}\label{wxtreectrldelete}
\func{void}{Delete}{\param{const wxTreeItemId\&}{ item}}
-Deletes the specified item.
+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.
+Deletes all 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}
+
+\func{void}{DeleteChildren}{\param{const wxTreeItemId\& }{item}}
+
+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}
\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 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.
\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::ExpandAll}\label{wxtreectrlexpandall}
+
+\func{void}{Expand}{\void}
+
+Expands all items in the tree.
+
+
+\membersection{wxTreeCtrl::ExpandAllChildren}\label{wxtreectrlexpandallchildren}
+
+\func{void}{ExpandAllChildren}{\param{const wxTreeItemId\&}{ item}}
+
+Expands the given item and all its children recursively.
+
+
\membersection{wxTreeCtrl::GetBoundingRect}\label{wxtreectrlgetitemrect}
-\constfunc{bool}{GetBoundingRect}{\param{const wxTreeItemId\&}{ item}, \param{wxRect\& }{rect}, \param{bool }{textOnly = 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 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 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
+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.
+Notice that the rectangle coordinates are logical, not physical ones. So, for
+example, the x coordinate may be negative if the tree has a horizontal
+scrollbar and its position is not $0$.
+
\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}.}
-\perlnote{In wxPerl this method only takes the parameters {\tt item} and
+\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}
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 = TRUE}}
+\constfunc{unsigned int}{GetChildrenCount}{\param{const wxTreeItemId\&}{ item}, \param{bool}{ recursively = {\tt true}}}
-Returns the number of items in the branch. If {\it recursively} is 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}
+\constfunc{unsigned int}{GetCount}{\void}
Returns the number of items in the control.
+
\membersection{wxTreeCtrl::GetEditControl}\label{wxtreectrlgeteditcontrol}
-\constfunc{wxTextCtrl\&}{GetEditControl}{\void}
+\constfunc{wxTextCtrl *}{GetEditControl}{\void}
+
+Returns the edit control being currently used to edit a label. Returns {\tt NULL}
+if no label is being edited.
+
+{\bf NB:} It is currently only implemented for wxMSW.
-Returns the edit control used to edit a label.
\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.
which is opaque for the application but is necessary for the library
to make these functions reentrant (i.e. allow more than one
enumeration on one and the same object simultaneously). The cookie passed to
-GetFirstChild and GetNextChild should be the same.
+GetFirstChild and GetNextChild should be the same variable.
-Returns an invalid tree item if there are no further children.
+Returns an invalid tree item (i.e. IsOk() returns {\tt false}) if there are no further children.
\wxheading{See also}
-\helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild}
+\helpref{wxTreeCtrl::GetNextChild}{wxtreectrlgetnextchild},
+\helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
\pythonnote{In wxPython the returned wxTreeItemId and the new cookie
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 ( item, cookie ).}
+ returns a 2-element list {\tt ( item, cookie )}.}
+
\membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
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}}
\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}
+
+\constfunc{wxFont}{GetItemFont}{\param{const wxTreeItemId\&}{ item}}
+
+Returns the font of the item label.
+
\membersection{wxTreeCtrl::GetItemImage}\label{wxtreectrlgetitemimage}
(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}}
\wxheading{See also}
\helpref{GetFirstChild}{wxtreectrlgetfirstchild},
+\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.
value are both returned as a tuple containing the two values.}
\perlnote{In wxPerl this method returns a 2-element list
- ( item, cookie ), instead of modifying its parameters.}
+ {\tt ( item, cookie )}, instead of modifying its parameters.}
+
\membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
\helpref{wxTreeCtrl::GetPrevSibling}{wxtreectrlgetprevsibling}
+
\membersection{wxTreeCtrl::GetNextVisible}\label{wxtreectrlgetnextvisible}
\constfunc{wxTreeItemId}{GetNextVisible}{\param{const wxTreeItemId\&}{ item}}
Returns the next visible item.
-\membersection{wxTreeCtrl::GetParent}\label{wxtreectrlgetparent}
-\constfunc{wxTreeItemId}{GetParent}{\param{const wxTreeItemId\&}{ item}}
+\membersection{wxTreeCtrl::GetItemParent}\label{wxtreectrlgetitemparent}
+
+\constfunc{wxTreeItemId}{GetItemParent}{\param{const wxTreeItemId\&}{ item}}
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}
\helpref{wxTreeCtrl::GetNextSibling}{wxtreectrlgetnextsibling}
+
\membersection{wxTreeCtrl::GetPrevVisible}\label{wxtreectrlgetprevvisible}
\constfunc{wxTreeItemId}{GetPrevVisible}{\param{const wxTreeItemId\&}{ item}}
Returns the previous visible item.
+
+\membersection{wxTreeCtrl::GetQuickBestSize}\label{wxtreectrlgetquickbestsize}
+
+\constfunc{bool}{GetQuickBestSize}{\void}
+
+Returns true if the control will use a quick calculation for the best size,
+looking only at the first and last items. The default is false.
+
+\wxheading{See also}
+
+\helpref{wxTreeCtrl::SetQuickBestSize}{wxtreectrlsetquickbestsize}
+
+
\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}}
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}
\helpref{GetSelections}{wxtreectrlgetselections} for the controls which do have
this style.
+
\membersection{wxTreeCtrl::GetSelections}\label{wxtreectrlgetselections}
-\constfunc{size\_t}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
+\constfunc{unsigned int}{GetSelections}{\param{wxArrayTreeItemIds\& }{selection}}
Fills the array of tree items passed in with the currently selected items. This
function can be called only if the control has the wxTR\_MULTIPLE style.
\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}}
+\constfunc{wxTreeItemId}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
Calculates which (if any) item is under the given point, returning the tree item
id at this point plus extra information {\it flags}. {\it flags} is a bitlist of the following:
returned as a tuple.}
\perlnote{In wxPerl this method only takes the {\tt point} parameter
- and returns a 2-element list ( item, flags ).}
+ 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},
- \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
+ \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
\func{wxTreeItemId}{InsertItem}{\param{const wxTreeItemId\& }{parent}, \param{size\_t}{ before}, \param{const wxString\&}{ text},
- \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
+ \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
both selected and unselected items.
\pythonnote{The second form of this method is called
-\tt{InsertItemBefore} in wxPython.}
+{\tt InsertItemBefore} in wxPython.}
+
\membersection{wxTreeCtrl::IsBold}\label{wxtreectrlisbold}
\constfunc{bool}{IsBold}{\param{const wxTreeItemId\& }{item}}
-Returns 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 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 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 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 TRUE if the item has children.
+Returns {\tt true} if the item has children.
+
\membersection{wxTreeCtrl::OnCompareItems}\label{wxtreectrloncompareitems}
positive value if the first item is less than, equal to or greater than the
second one.
-The base class version compares items alphabetically.
+Please note that you \textbf{must} use wxRTTI macros
+\helpref{DECLARE\_DYNAMIC\_CLASS}{declaredynamicclass} and
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass} if you override this
+function because otherwise the base class considers that it is not overridden
+and uses the default comparison, i.e. sorts the items alphabetically, which
+allows it optimize away the calls to the virtual function completely.
See also: \helpref{SortChildren}{wxtreectrlsortchildren}
+
\membersection{wxTreeCtrl::PrependItem}\label{wxtreectrlprependitem}
\func{wxTreeItemId}{PrependItem}{\param{const wxTreeItemId\& }{parent}, \param{const wxString\&}{ text},
- \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = NULL}}
+ \param{int}{ image = -1}, \param{int}{ selImage = -1}, \param{wxTreeItemData*}{ data = {\tt NULL}}}
Appends an item as the first child of {\it parent}, return a new item id.
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{void}{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}
Setting or assigning the button image list enables the display of image buttons.
Once enabled, the only way to disable the display of button images is to set
-the button image list to NULL.
+the button image list to {\tt NULL}.
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}}
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 = TRUE}}
+\func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = {\tt true}}}
-Makes item appear in bold font if {\it bold} parameter is 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}}
\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::SetItemDropHighlight}\label{wxtreectrlsetitemdrophighlight}
+
+\func{void}{SetItemDropHighlight}{\param{const wxTreeItemId\&}{ item}, \param{bool}{highlight = {\tt true}}}
+
+Gives the item the visual feedback for Drag'n'Drop actions, which is
+useful if something is dragged from the outside onto the tree control
+(as opposed to a DnD operation within the tree control, which already
+is implemented internally).
\membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
\helpref{SetItemBold}{wxtreectrlsetitembold}
+
\membersection{wxTreeCtrl::SetItemHasChildren}\label{wxtreectrlsetitemhaschildren}
-\func{void}{SetItemHasChildren}{\param{const wxTreeItemId\&}{ item}, \param{bool }{hasChildren = 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},
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::SetQuickBestSize}\label{wxtreectrlsetquickbestsize}
+
+\func{void}{SetQuickBestSize}{\param{bool}{ quickBestSize}}
+
+If true is passed, specifies that the control will use a quick calculation for the best size,
+looking only at the first and last items. Otherwise, it will look at all items.
+The default is false.
+
+\wxheading{See also}
+
+\helpref{wxTreeCtrl::GetQuickBestSize}{wxtreectrlgetquickbestsize}
+
+
\membersection{wxTreeCtrl::SetStateImageList}\label{wxtreectrlsetstateimagelist}
\func{void}{SetStateImageList}{\param{wxImageList*}{ imageList}}
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}}
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}
if the control doesn't have wxTR\_MULTIPLE style, or removes the selection from
all items if it does have this style.
-\section{\class{wxTreeItemData}}\label{wxtreeitemdata}
-
-wxTreeItemData is some (arbitrary) user class associated with some item. The
-main advantage of having this class (compared to the old untyped interface) is
-that wxTreeItemData's are destroyed automatically by the tree and, as this
-class has virtual dtor, it means that the memory will be automatically
-freed. We don't just use wxObject instead of wxTreeItemData because
-the size of this class is critical: in any real application, each tree leaf
-will have wxTreeItemData associated with it and number of leaves may be
-quite big.
-
-Because the objects of this class are deleted by the tree, they should
-always be allocated on the heap.
-
-\wxheading{Derived from}
-
-wxTreeItemId
-
-\wxheading{Include files}
-
-<wx/treectrl.h>
-
-\wxheading{See also}
-
-\helpref{wxTreeCtrl}{wxtreectrl}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdataconstr}
-
-\func{}{wxTreeItemData}{\void}
-
-Default constructor.
-
-\pythonnote{The wxPython version of this constructor optionally
-accepts any Python object as a parameter. This object is then
-associated with the tree item using the wxTreeItemData as a
-container.
-
-In addition, the following methods are added in wxPython for accessing
-the object:
-
-\indented{2cm}{\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object}
-\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the
-wxTreeItemData}
-\end{twocollist}}
-}
-
-\perlnote{In wxPerl the constructor accepts as parameter an optional scalar,
- and stores it as client data. You may retrieve this data by calling
- {\bf GetData()}, and set it by callling {\bf SetData( data ).}
-}
-
-\membersection{wxTreeItemData::\destruct{wxTreeItemData}}
-
-\func{void}{\destruct{wxTreeItemData}}{\void}
-
-Virtual destructor.
-
-\membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid}
-
-\func{const wxTreeItem\&}{GetId}{\void}
-
-Returns the item associated with this node.
-\membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid}
+\membersection{wxTreeCtrl::UnselectItem}\label{wxtreectrlunselectitem}
-\func{void}{SetId}{\param{const wxTreeItemId\&}{ id}}
+\func{void}{UnselectItem}{\param{const wxTreeItemId\& }{item}}
-Sets the item associated with this node.
+Unselects the given item. This works in multiselection controls only.
projects / wxWidgets.git / blobdiff