updated SetFont() documentation: it returns bool, not void (bug 1705330)

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

diff --git a/docs/latex/wx/treebook.tex b/docs/latex/wx/treebook.tex
index 5fb0b255f8c056993b7678833af04a021613afd8..788cefa385699506d93f59a16d5cfa3aa07cb195 100644 (file)
--- a/docs/latex/wx/treebook.tex
+++ b/docs/latex/wx/treebook.tex
@@ -18,10 +18,11 @@ of preference sections on the left and select section page on the right.
 
 To use the class simply create it and populate with pages using
 \helpref{InsertPage}{wxtreebookinsertpage},
+\helpref{InsertSubPage}{wxtreebookinsertsubpage},
 \helpref{AddPage}{wxtreebookaddpage},
 \helpref{AddSubPage}{wxtreebookaddsubpage}.
 
-If your tree is no more than 1 level in depth then you could
+If your tree is no more than $1$ level in depth then you could
 simply use \helpref{AddPage}{wxtreebookaddpage} and 
 \helpref{AddSubPage}{wxtreebookaddsubpage} to sequentially populate your tree
 by adding at every step a page or a subpage to the end of the tree.
@@ -104,7 +105,7 @@ Also deletes all the pages owned by the control (inserted previously into it).
     \param{int }{imageId = wxNOT\_FOUND}}
 
 Adds a new page. The page is placed at the topmost level after all other pages.
-NULL could be specified for page to create an empty page.
+\NULL could be specified for page to create an empty page.
 
 
 
@@ -112,10 +113,8 @@ NULL could be specified for page to create an empty page.
 
 \func{bool}{AddSubPage}{\param{wxWindow* }{page}, \param{const wxString\& }{text}, \param{bool }{bSelect = false}, \param{int }{imageId = wxNOT\_FOUND}}
 
-\func{bool}{AddSubPage}{\param{size\_t }{pagePos}, \param{wxWindow* }{page}, \param{const wxString\& }{text}, \param{bool }{bSelect = false}, \param{int }{imageId = wxNOT\_FOUND}}
-
-Adds a new child-page to either the last or the specified top-level.
-NULL could be specified for page to create an empty page.
+Adds a new child-page to the last top-level page.
+\NULL could be specified for page to create an empty page.
 
 
 
@@ -215,7 +214,16 @@ depending on the platform and so wxTreebookEvent::GetSelection should be used in
 
 Inserts a new page just before the page indicated by pagePos.
 The new page is placed before pagePos page and on the same level.
-NULL could be specified for page to create an empty page.
+\NULL could be specified for page to create an empty page.
+
+
+\membersection{wxTreebook::InsertSubPage}\label{wxtreebookinsertsubpage}
+
+\func{bool}{InsertSubPage}{\param{size\_t }{pagePos}, \param{wxWindow* }{page}, \param{const wxString\& }{text}, \param{bool }{bSelect = false}, \param{int }{imageId = wxNOT\_FOUND}}
+
+Inserts a sub page under the specified page.
+
+\NULL could be specified for page to create an empty page.
 
 
 \membersection{wxTreebook::IsNodeExpanded}\label{wxtreebookisnodeexpanded}
@@ -263,7 +271,22 @@ Sets the selection for the given page, returning the previous selection.
 
 The call to this function generates the page changing events.
 
+This function is deprecated and should not be used in new code. Please use the
+\helpref{ChangeSelection}{wxtreebookchangeselection} function instead.
+
 \wxheading{See also}
 
 \helpref{wxTreebook::GetSelection}{wxtreebookgetselection}
 
+
+
+\membersection{wxTreebook::ChangeSelection}\label{wxtreebookchangeselection}
+
+\func{int}{ChangeSelection}{\param{size\_t}{ page}}
+
+Changes the selection for the given page, returning the previous selection.
+
+The call to this function \emph{does not} generate the page changing events.
+This is the only difference with \helpref{SetSelection}{wxtreebooksetselection}.
+See \helpref{this topic}{progevent} for more info.
+