X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1d2bd8475d56ae893f48aa5ca7676f0d9e72825a..44cf9b50eef370cc94a6c1f249693dee3776d619:/docs/latex/wx/notebook.tex diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index 0e7c925e66..29e87d94c6 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -24,10 +24,11 @@ managed by wxNotebook. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxNB\_FIXEDWIDTH}}{(Windows only)All tabs will have same width.} -\twocolitem{\windowstyle{wxNB\_LEFT}}{Place tabs on the left side.} -\twocolitem{\windowstyle{wxNB\_RIGHT}}{Place tabs on the right side.} -\twocolitem{\windowstyle{wxNB\_BOTTOM}}{Place tabs under instead of above the notebook pages.} +\twocolitem{\windowstyle{wxNB\_LEFT}}{Place tabs on the left side. Not supported under Windows XP.} +\twocolitem{\windowstyle{wxNB\_RIGHT}}{Place tabs on the right side. Not supported under Windows XP.} +\twocolitem{\windowstyle{wxNB\_BOTTOM}}{Place tabs under instead of above the notebook pages. Not supported under Windows XP.} +\twocolitem{\windowstyle{wxNB\_FIXEDWIDTH}}{(Windows only) All tabs will have same width.} +\twocolitem{\windowstyle{wxNB\_MULTILINE}}{(Windows only) There can be several rows of tabs.} \end{twocollist} @@ -49,7 +50,7 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. \func{}{wxNotebook}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, - \param{const wxSize\&}{ size}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}} + \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0}, \param{const wxString\& }{name = "notebook"}} Constructs a notebook control. @@ -79,7 +80,7 @@ Destroys the wxNotebook object. \func{bool}{AddPage}{\param{wxNotebookPage*}{ page}, \param{const wxString\&}{ text}, - \param{bool}{ select = FALSE}, + \param{bool}{ select = false}, \param{int}{ imageId = -1}} Adds a new page. @@ -96,7 +97,7 @@ Adds a new page. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \wxheading{Remarks} @@ -108,7 +109,7 @@ Do not delete the page, it will be deleted by the notebook. \membersection{wxNotebook::AdvanceSelection}\label{wxnotebookadvanceselection} -\func{void}{AdvanceSelection}{\param{bool}{ forward = TRUE}} +\func{void}{AdvanceSelection}{\param{bool}{ forward = true}} Cycles through the tabs. @@ -188,13 +189,19 @@ Returns the number of rows in the notebook control. \constfunc{int}{GetSelection}{\void} -Returns the currently selected page, or -1 if none was selected. +Returns the currently selected page, or $-1$ if none was selected. + +Note that this method may return either the previously or newly selected page +when called from the {\tt EVT\_NOTEBOOK\_PAGE\_CHANGED} handler depending on +the platform and so\rtfsp +\helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} should be +used instead in this case. \membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage} \func{bool}{InsertPage}{\param{int}{ index}, \param{wxNotebookPage*}{ page}, \param{const wxString\&}{ text}, - \param{bool}{ select = FALSE}, + \param{bool}{ select = false}, \param{int}{ imageId = -1}} Inserts a new page at the specified position. @@ -213,7 +220,7 @@ Inserts a new page at the specified position. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \wxheading{Remarks} @@ -257,12 +264,16 @@ ownership of the image list, you must delete it yourself. Sets the amount of space around each page's icon and label, in pixels. +{\bf NB:} The vertical padding cannot be changed in wxGTK. + \membersection{wxNotebook::SetPageSize}\label{wxnotebooksetpagesize} \func{void}{SetPageSize}{\param{const wxSize\&}{ size}} Sets the width and height of the pages. +{\bf NB:} This method is currently not implemented for wxGTK. + \membersection{wxNotebook::SetPageImage}\label{wxnotebooksetpageimage} \func{bool}{SetPageImage}{\param{int}{ page}, \param{int }{image}}