X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ab3165fb0dd760f633203c815853e578d634abee..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/treectrl.tex diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index 96859ec829..26118922e6 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -13,7 +13,7 @@ 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, -which may be tested for validity by calling wxTreeItemId::IsOk. +which may be tested for validity by calling \helpref{wxTreeItemId::IsOk}{wxtreeitemidisok}. To intercept events from a tree control, use the event table macros described in \helpref{wxTreeEvent}{wxtreeevent}. @@ -28,6 +28,10 @@ To intercept events from a tree control, use the event table macros described in +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -65,8 +69,6 @@ to be deselected. This is the default.} \twocolitem{\windowstyle{wxTR\_MULTIPLE}}{Use this style to allow a range of items to be selected. If a second range is selected, the current range, if any, is deselected.} -\twocolitem{\windowstyle{wxTR\_EXTENDED}}{Use this style -to allow disjoint items to be selected. (Only partially implemented; may not work in all cases.)} \twocolitem{\windowstyle{wxTR\_DEFAULT\_STYLE}}{The set of flags that are closest to the defaults for the native control for a particular toolkit.} \end{twocollist} @@ -238,6 +240,28 @@ See also \helpref{SetStateImageList}{wxtreectrlsetstateimagelist}. Collapses the given item. +\membersection{wxTreeCtrl::CollapseAll}\label{wxtreectrlcollapseall} + +\func{void}{CollapseAll}{\void} + +Collapses the root item. + +\wxheading{See also} + +\helpref{ExpandAll}{wxtreectrlexpandall} + + +\membersection{wxTreeCtrl::CollapseAllChildren}\label{wxtreectrlcollapseallchildren} + +\func{void}{CollapseAllChildren}{\param{const wxTreeItemId\&}{ item}} + +Collapses this item and all of its children, recursively. + +\wxheading{See also} + +\helpref{ExpandAllChildren}{wxtreectrlexpandallchildren} + + \membersection{wxTreeCtrl::CollapseAndReset}\label{wxtreectrlcollapseandreset} \func{void}{CollapseAndReset}{\param{const wxTreeItemId\&}{ item}} @@ -333,7 +357,7 @@ Expands the given item. \membersection{wxTreeCtrl::ExpandAll}\label{wxtreectrlexpandall} -\func{void}{Expand}{\void} +\func{void}{ExpandAll}{\void} Expands all items in the tree. @@ -728,6 +752,13 @@ Returns {\tt true} if the given item is in bold state. See also: \helpref{SetItemBold}{wxtreectrlsetitembold} +\membersection{wxTreeCtrl::IsEmpty}\label{wxtreectrlisempty} + +\constfunc{bool}{IsEmpty}{} + +Returns \true if the control is empty (i.e. has no items, even no root one). + + \membersection{wxTreeCtrl::IsExpanded}\label{wxtreectrlisexpanded} \constfunc{bool}{IsExpanded}{\param{const wxTreeItemId\&}{ item}} @@ -1023,3 +1054,63 @@ all items if it does have this style. Unselects the given item. This works in multiselection controls only. + + + + +%% the wxTreeItemId opaque class + + +\section{\class{wxTreeItemId}}\label{wxtreeitemid} + +An opaque reference to a tree item. + + +\wxheading{Derived from} + +None + +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + +\wxheading{See also} + +\helpref{wxTreeCtrl}{wxtreectrl}, \helpref{wxTreeItemData}{wxtreeitemdata},\\ +\helpref{wxTreeCtrl overview}{wxtreectrloverview} + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxTreeItemId::wxTreeItemId}\label{wxtreeitemidconstr} + +\func{}{wxTreeItemId}{\void} + +Default constructor. wxTreemItemIds are not meant to be constructed explicitly by +the user; they are returned by the \helpref{wxTreeCtrl}{wxtreectrl} functions instead. + + +\membersection{wxTreeItemId::IsOk}\label{wxtreeitemidisok} + +\constfunc{bool}{IsOk}{} + +Returns \true if this instance is referencing a valid tree item. + + +\membersection{Operators}\label{wxtreeitemidoperators} + +\constfunc{void}{operator $!$}{} + +Synonim for \helpref{IsOk}{wxtreeitemidisok} + + +\constfunc{bool}{operator $==$}{\param{const wxTreeItemId\& }{item}} + +\constfunc{bool}{operator $!=$}{\param{const wxTreeItemId\& }{item}} + +Operators for comparison between \helpref{wxTreeItemId}{wxtreeitemid} objects. +