X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3972fb4919148d1ed67f897ea5beb67eedd662f6..d82323930c8ce1b800f2213a598fbda79f868d1d:/docs/latex/wx/notebook.tex?ds=sidebyside diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index d8d9f8ab24..2ec54d1b11 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -15,6 +15,25 @@ managed by wxNotebook. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + +\wxheading{Window styles} + +\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.} + +\end{twocollist} + +See also \helpref{window styles overview}{windowstyles}. + + \wxheading{Event handling} To process input from a notebook control, use the following event handler macros to direct input to member @@ -22,10 +41,9 @@ functions that take a \helpref{wxNotebookEvent}{wxnotebookevent} argument. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGED(id, func)}}{The page selection was changed. Processes a -wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.} -\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGING(id, func)}}{The page selection is about to be changed. -Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} +\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGED(id, func)}}{The page selection was changed.} +\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed. +This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} \end{twocollist}% \wxheading{See also} @@ -46,6 +64,8 @@ Default constructor. Constructs a notebook control. +Note that sometimes you can reduce flicker by passing the wxCLIP\_CHILDREN window style. + \wxheading{Parameters} \docparam{parent}{The parent window. Must be non-NULL.} @@ -56,8 +76,9 @@ Constructs a notebook control. \docparam{size}{The window size.} -\docparam{style}{The window style. Its value is a bit list of zero or more of {\bf wxTC\_MULTILINE}, - {\bf wxTC\_RIGHTJUSTIFY}, {\bf wxTC\_FIXEDWIDTH} and {\bf wxTC\_OWNERDRAW}.} +\docparam{style}{The window style. See \helpref{wxNotebook}{wxnotebook}.} + +\docparam{name}{The name of the control (used only under Motif).} \membersection{wxNotebook::\destruct{wxNotebook}} @@ -120,7 +141,7 @@ Deletes all pages. \func{bool}{DeletePage}{\param{int}{ page}} -Deletes the specified page. +Deletes the specified page, and the associated window. \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist} @@ -146,13 +167,13 @@ Returns the number of pages in the notebook control. \membersection{wxNotebook::GetPageImage}\label{wxnotebookgetpageimage} -\constfunc{int}{GetPageImage}{\void} +\constfunc{int}{GetPageImage}{\param{int }{nPage}} Returns the image index for the given page. \membersection{wxNotebook::GetPageText}\label{wxnotebookgetpagetext} -\constfunc{wxString}{GetPageText}{\void} +\constfunc{wxString}{GetPageText}{\param{int }{nPage}} Returns the string for the given page. @@ -211,6 +232,12 @@ An event handler function, called when the page selection is changed. \helpref{wxNotebookEvent}{wxnotebookevent} +\membersection{wxNotebook::RemovePage}\label{wxnotebookremovepage} + +\func{bool}{RemovePage}{\param{int}{ page}} + +Deletes the specified page, without deleting the associated window. + \membersection{wxNotebook::SetImageList}\label{wxnotebooksetimagelist} \func{void}{SetImageList}{\param{wxImageList*}{ imageList}}