X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8c517ddd1a2dd7eee7f95eb9ac1783f4a2e6fd76..b0ee47ff76c278c053ac2ad36bb3129b0fcd050f:/docs/latex/wx/notebook.tex?ds=inline diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index e70c497000..e25921c0c5 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -19,6 +19,21 @@ managed by wxNotebook. +\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 @@ -26,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\_CHANGED(id, func)}}{The page selection was changed.} \twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed. -Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} +This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} \end{twocollist}% \wxheading{See also} @@ -50,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.} @@ -60,8 +76,7 @@ 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).} @@ -108,6 +123,18 @@ Do not delete the page, it will be deleted by the notebook. Cycles through the tabs. +\membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist} + +\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}} + +Sets the image list for the page control and takes ownership of +the list. + +\wxheading{See also} + +\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}, @@ -152,13 +179,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. @@ -227,11 +254,13 @@ Deletes the specified page, without deleting the associated window. \func{void}{SetImageList}{\param{wxImageList*}{ imageList}} -Sets the image list for the page control. +Sets the image list for the page control. It does not take +ownership of the image list, you must delete it yourself. \wxheading{See also} -\helpref{wxImageList}{wximagelist} +\helpref{wxImageList}{wximagelist}, +\helpref{AssignImageList}{wxnotebookassignimagelist} \membersection{wxNotebook::SetPadding}\label{wxnotebooksetpadding}