X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b656febdf03cfa90ed14151cdf3d56a685f8af74..07f20d9a63226a25e71ba6c72e2803c1f58e7903:/docs/latex/wx/notebook.tex diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index e25921c0c5..ce9ce5009d 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -24,27 +24,17 @@ 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} 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 -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.} -\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}% +\input noteevt.inc \wxheading{See also} @@ -60,7 +50,7 @@ This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} 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. @@ -90,11 +80,13 @@ 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. +The call to this function may generate the page changing events. + \wxheading{Parameters} \docparam{page}{Specifies the new page.} @@ -107,7 +99,7 @@ Adds a new page. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \wxheading{Remarks} @@ -119,10 +111,12 @@ 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. +The call to this function generates the page changing events. + \membersection{wxNotebook::AssignImageList}\label{wxnotebookassignimagelist} \func{void}{AssignImageList}{\param{wxImageList*}{ imageList}} @@ -155,6 +149,8 @@ Deletes all pages. Deletes the specified page, and the associated window. +The call to this function generates the page changing events. + \membersection{wxNotebook::GetImageList}\label{wxnotebookgetimagelist} \constfunc{wxImageList*}{GetImageList}{\void} @@ -199,13 +195,49 @@ 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::HitTest}\label{wxnotebookhittest} + +\func{int}{HitTest}{\param{const wxPoint\&}{ pt}, \param{long}{ *flags = {\tt NULL}}} + +Returns the index of the tab at the specified position or {\tt wxNOT\_FOUND} +if none. If {\it flags} parameter is non {\tt NULL}, the position of the point +inside the tab is returned as well. + +{\bf NB: } This method is currently only implemented under wxMSW and wxUniv. + +\wxheading{Parameters} + +\docparam{pt}{Specifies the point for the hit test.} + +\docparam{flags}{Return value for detailed information. One of the following values: +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf wxNB\_HITTEST\_NOWHERE}}{There was no tab under this point.} +\twocolitem{{\bf wxNB\_HITTEST\_ONICON}}{The point was over an icon (currently wxMSW only).} +\twocolitem{{\bf wxNB\_HITTEST\_ONLABEL}}{The point was over a label (currently wxMSW only).} +\twocolitem{{\bf wxNB\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.} +\end{twocollist} +} + +\wxheading{Return value} + +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{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. @@ -224,7 +256,7 @@ Inserts a new page at the specified position. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +true if successful, false otherwise. \wxheading{Remarks} @@ -268,12 +300,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}} @@ -293,6 +329,8 @@ Sets the text for the given page. Sets the selection for the given page, returning the previous selection. +The call to this function generates the page changing events. + \wxheading{See also} \helpref{wxNotebook::GetSelection}{wxnotebookgetselection}