X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3972fb4919148d1ed67f897ea5beb67eedd662f6..802df2b744052c0da6353e5ad4ade2f8dfcfdab8:/docs/latex/wx/notebook.tex diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index d8d9f8ab24..f0d414855a 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -15,18 +15,26 @@ managed by wxNotebook. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} -\wxheading{Event handling} +\wxheading{Include files} -To process input from a notebook control, use the following event handler macros to direct input to member -functions that take a \helpref{wxNotebookEvent}{wxnotebookevent} argument. + -\twocolwidtha{7cm} +\wxheading{Window styles} + +\twocolwidtha{5cm} \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.} -\end{twocollist}% + +\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} + +See also \helpref{window styles overview}{windowstyles}. + +\input noteevt.inc \wxheading{See also} @@ -42,10 +50,12 @@ Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.} 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. +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 +66,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}} @@ -102,6 +113,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}, @@ -120,7 +143,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 +169,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. @@ -166,7 +189,13 @@ 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} @@ -211,15 +240,23 @@ 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}} -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} @@ -227,12 +264,16 @@ Sets the image list for the page control. 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}}