fixed another return FALSE in a function returning a pointer (patch 545046)

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

diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex
index 1b057afcd4a6d8df95449f1607838b2e71f49651..4ced4a1ea63da11826d0de900ae489fd39b5ae01 100644 (file)
--- a/docs/latex/wx/treectrl.tex
+++ b/docs/latex/wx/treectrl.tex
@@ -32,13 +32,17 @@ 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.}
 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
 \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
 \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


@@ -346,7 +350,7 @@ Returns an invalid tree item if there are no further children.
 value are both returned as a tuple containing the two values.}
 
 \perlnote{In wxPerl this method only takes the {\tt item} parameter, and
 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}
 
 
 \membersection{wxTreeCtrl::GetFirstVisibleItem}\label{wxtreectrlgetfirstvisibleitem}
 


@@ -450,7 +454,7 @@ Returns an invalid tree item if there are no further children.
 value are both returned as a tuple containing the two values.}
 
 \perlnote{In wxPerl this method returns a 2-element list
 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}
 
 
 \membersection{wxTreeCtrl::GetNextSibling}\label{wxtreectrlgetnextsibling}
 


@@ -566,7 +570,7 @@ id at this point plus extra information {\it flags}. {\it flags} is a bitlist of
 returned as a tuple.}
 
 \perlnote{In wxPerl this method only takes the {\tt point} parameter
 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}
 
 
 \membersection{wxTreeCtrl::InsertItem}\label{wxtreectrlinsertitem}
 


@@ -822,75 +826,3 @@ 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.
 

-\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}
-
-\func{void}{SetId}{\param{const wxTreeItemId\&}{ id}}
-
-Sets the item associated with this node.
-