X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dcbd177f06597f98aae27bf53a4c98b4739102c7..68d411dc5724b9284455a31ef8a8d6d99c18d224:/docs/latex/wx/notebook.tex diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index 1e07b54517..5e1bea62b8 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -24,14 +24,17 @@ managed by wxNotebook. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\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\_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\_FIXEDWIDTH}}{(Windows only) All tabs will have same width.} \twocolitem{\windowstyle{wxNB\_MULTILINE}}{(Windows only) There can be several rows of tabs.} \end{twocollist} +The styles \texttt{wxNB\_LEFT}, \texttt{RIGHT} and \texttt{BOTTOM} are not +supported under Microsoft Windows XP when using visual themes. + See also \helpref{window styles overview}{windowstyles}. \input noteevt.inc @@ -43,6 +46,7 @@ See also \helpref{window styles overview}{windowstyles}. \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxNotebook::wxNotebook}\label{wxnotebookctor} \func{}{wxNotebook}{\void} @@ -70,12 +74,14 @@ Note that sometimes you can reduce flicker by passing the wxCLIP\_CHILDREN windo \docparam{name}{The name of the control (used only under Motif).} + \membersection{wxNotebook::\destruct{wxNotebook}}\label{wxnotebookdtor} \func{}{\destruct{wxNotebook}}{\void} Destroys the wxNotebook object. + \membersection{wxNotebook::AddPage}\label{wxnotebookaddpage} \func{bool}{AddPage}{\param{wxNotebookPage*}{ page}, @@ -109,6 +115,7 @@ Do not delete the page, it will be deleted by the notebook. \helpref{wxNotebook::InsertPage}{wxnotebookinsertpage} + \membersection{wxNotebook::AdvanceSelection}\label{wxnotebookadvanceselection} \func{void}{AdvanceSelection}{\param{bool}{ forward = true}} @@ -117,6 +124,7 @@ Cycles through the tabs. The call to this function generates the page changing events. + \membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist} \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}} @@ -129,6 +137,7 @@ the list. \helpref{wxImageList}{wximagelist}, \helpref{SetImageList}{wxnotebooksetimagelist} + \membersection{wxNotebook::Create}\label{wxnotebookcreate} \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, @@ -137,12 +146,14 @@ the list. Creates a notebook control. See \helpref{wxNotebook::wxNotebook}{wxnotebookctor} for a description of the parameters. + \membersection{wxNotebook::DeleteAllPages}\label{wxnotebookdeleteallpages} \func{bool}{DeleteAllPages}{\void} Deletes all pages. + \membersection{wxNotebook::DeletePage}\label{wxnotebookdeletepage} \func{bool}{DeletePage}{\param{size\_t}{ page}} @@ -151,6 +162,14 @@ Deletes the specified page, and the associated window. The call to this function generates the page changing events. + +\membersection{wxNotebook::GetCurrentPage}\label{wxnotebookgetcurrentpage} + +\constfunc{wxWindow *}{GetCurrentPage}{\void} + +Returns the currently selected notebook age or \texttt{NULL}. + + \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist} \constfunc{wxImageList*}{GetImageList}{\void} @@ -161,36 +180,42 @@ Returns the associated image list. \helpref{wxImageList}{wximagelist}, \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist} + \membersection{wxNotebook::GetPage}\label{wxnotebookgetpage} \func{wxNotebookPage*}{GetPage}{\param{size\_t}{ page}} Returns the window at the given page position. + \membersection{wxNotebook::GetPageCount}\label{wxnotebookgetpagecount} \constfunc{size\_t}{GetPageCount}{\void} Returns the number of pages in the notebook control. + \membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage} \constfunc{int}{GetPageImage}{\param{size\_t }{nPage}} Returns the image index for the given page. + \membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext} \constfunc{wxString}{GetPageText}{\param{size\_t }{nPage}} Returns the string for the given page. + \membersection{wxNotebook::GetRowCount}\label{wxnotebookgetrowcount} \constfunc{int}{GetRowCount}{\void} Returns the number of rows in the notebook control. + \membersection{wxNotebook::GetSelection}\label{wxnotebookgetselection} \constfunc{int}{GetSelection}{\void} @@ -203,6 +228,7 @@ the platform and so\rtfsp \helpref{wxNotebookEvent::GetSelection}{wxnotebookeventgetselection} should be used instead in this case. + \membersection{wxNotebook::HitTest}\label{wxnotebookhittest} \func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long}{ *flags = {\tt NULL}}} @@ -233,6 +259,7 @@ Returns the zero-based tab index or {\tt wxNOT\_FOUND} if there is no tab is at the specified position. + \membersection{wxNotebook::InsertPage}\label{wxnotebookinsertpage} \func{bool}{InsertPage}{\param{size\_t}{ index}, \param{wxNotebookPage*}{ page}, @@ -266,6 +293,7 @@ Do not delete the page, it will be deleted by the notebook. \helpref{wxNotebook::AddPage}{wxnotebookaddpage} + \membersection{wxNotebook::OnSelChange}\label{wxnotebookonselchange} \func{void}{OnSelChange}{\param{wxNotebookEvent\&}{ event}} @@ -276,12 +304,14 @@ An event handler function, called when the page selection is changed. \helpref{wxNotebookEvent}{wxnotebookevent} + \membersection{wxNotebook::RemovePage}\label{wxnotebookremovepage} \func{bool}{RemovePage}{\param{size\_t}{ page}} Deletes the specified page, without deleting the associated window. + \membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist} \func{void}{SetImageList}{\param{wxImageList*}{ imageList}} @@ -294,6 +324,7 @@ ownership of the image list, you must delete it yourself. \helpref{wxImageList}{wximagelist}, \helpref{AssignImageList}{wxnotebookassignimagelist} + \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding} \func{void}{SetPadding}{\param{const wxSize\&}{ padding}} @@ -302,6 +333,7 @@ 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}} @@ -310,6 +342,7 @@ 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{size\_t}{ page}, \param{int }{image}} @@ -317,12 +350,14 @@ Sets the width and height of the pages. Sets the image index for the given page. {\it image} is an index into the image list which was set with \helpref{wxNotebook::SetImageList}{wxnotebooksetimagelist}. + \membersection{wxNotebook::SetPageText}\label{wxnotebooksetpagetext} \func{bool}{SetPageText}{\param{size\_t}{ page}, \param{const wxString\& }{text}} Sets the text for the given page. + \membersection{wxNotebook::SetSelection}\label{wxnotebooksetselection} \func{int}{SetSelection}{\param{size\_t}{ page}}