X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2b34251cba8fd13818d99d04a336bd16126d44a..eb17eaba370e68c2c59f29e4e20de979bf4655f2:/docs/latex/wx/treectrl.tex diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex index fad69db3bf..eddf81f653 100644 --- a/docs/latex/wx/treectrl.tex +++ b/docs/latex/wx/treectrl.tex @@ -204,8 +204,8 @@ 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}.} +{\tt item} and {\tt textOnly} parameters. The return value is either a +{\tt wxRect} object or {\tt None}.} \membersection{wxTreeCtrl::GetChildrenCount}\label{wxtreectrlgetchildrencount} @@ -277,7 +277,7 @@ Returns the tree item data associated with the item. \pythonnote{wxPython provides the following shortcut method:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{GetPyData(item)}}{Returns the Python Object +\twocolitem{{\bf GetPyData(item)}}{Returns the Python Object associated with the wxTreeItemData for the given item Id.} \end{twocollist}} } @@ -361,6 +361,9 @@ Returns the next visible 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} \constfunc{wxTreeItemId}{GetPrevSibling}{\param{const wxTreeItemId\&}{ item}} @@ -411,7 +414,7 @@ function can be called only if the control has the wxTR\_MULTIPLE style. 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.} +and returns a Python list of {\tt wxTreeItemId}'s.} \membersection{wxTreeCtrl::GetStateImageList}\label{wxtreectrlgetstateimagelist} @@ -446,7 +449,10 @@ in {\it flags}. {\it flags} is a bitlist of the following: \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}} -Inserts an item after a given one. +\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}} + +Inserts an item after a given one ({\it previous}) or before one identified by its position ({\it before}). If {\it image} > -1 and {\it selImage} is -1, the same image is used for both selected and unselected items. @@ -530,6 +536,12 @@ Sets the indentation for the tree control. Sets the normal image list. +\membersection{wxTreeCtrl::SetItemBackgroundColour}\label{wxtreectrlsetitembackgroundcolour} + +\func{void}{SetItemBackgroundColour}{\param{const wxTreeItemId\&}{ item}, \param{const wxColour\& }{col}} + +Sets the colour of the items background. + \membersection{wxTreeCtrl::SetItemBold}\label{wxtreectrlsetitembold} \func{void}{SetItemBold}{\param{const wxTreeItemId\& }{item}, \param{bool}{ bold = TRUE}} @@ -547,11 +559,23 @@ Sets the item client data. \pythonnote{wxPython provides the following shortcut method:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{SetPyData(item, obj)}}{Associate the given Python +\twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python Object with the wxTreeItemData for the given item Id.} \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}} @@ -583,6 +607,12 @@ Sets the selected item image (this function is obsolete, use 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}} @@ -664,8 +694,8 @@ container. In addition, the following methods are added in wxPython for accessing the object:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{GetData()}}{Returns a reference to the Python Object} -\twocolitem{\bf{SetData(obj)}}{Associates a new Python Object with the +\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object} +\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the wxTreeItemData} \end{twocollist}} }