X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/93664d1bff826fa6cd273ecf83cf4518cca52262..9e967d5417d49764276cf121a32c35d5770b1332:/docs/latex/wx/notebook.tex diff --git a/docs/latex/wx/notebook.tex b/docs/latex/wx/notebook.tex index 75853fa697..b5dc6a4bd0 100644 --- a/docs/latex/wx/notebook.tex +++ b/docs/latex/wx/notebook.tex @@ -10,6 +10,7 @@ managed by wxNotebook. \wxheading{Derived from} +wxBookCtrlBase (see \helpref{wxBookCtrl overview}{wxbookctrloverview})\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ \helpref{wxEvtHandler}{wxevthandler}\\ @@ -19,6 +20,10 @@ managed by wxNotebook. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -46,7 +51,7 @@ See also \helpref{window styles overview}{windowstyles}. On Windows XP, the default theme paints a gradient on the notebook's pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use wxNB\_NOPAGETHEME to disable -themed drawing for a particular notebook, you can call {\tt wxSystemOptions::SetOption} +themed drawing for a particular notebook, you can call {\tt wxSystemOptions::SetOption} to disable it for the whole application, or you can disable it for individual pages by using {\tt SetBackgroundColour}. @@ -273,7 +278,7 @@ to {\tt SetBackgroundColour}. Otherwise, an uninitialised colour will be returne \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 +if none. If {\it flags} parameter is non-{\tt NULL}, the position of the point inside the tab is returned as well. \wxheading{Parameters} @@ -283,10 +288,11 @@ inside the tab is returned as well. \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.} +\twocolitem{{\bf wxBK\_HITTEST\_NOWHERE}}{There was no tab under this point.} +\twocolitem{{\bf wxBK\_HITTEST\_ONICON}}{The point was over an icon (currently wxMSW only).} +\twocolitem{{\bf wxBK\_HITTEST\_ONLABEL}}{The point was over a label (currently wxMSW only).} +\twocolitem{{\bf wxBK\_HITTEST\_ONITEM}}{The point was over an item, but not on the label or icon.} +\twocolitem{{\bf wxBK\_HITTEST\_ONPAGE}}{The point was over a currently selected page, not over any tab. Note that this flag is present only if {\tt wxNOT\_FOUND} is returned.} \end{twocollist} } @@ -403,8 +409,21 @@ Sets the selection for the given page, returning the previous selection. The call to this function generates the page changing events. +This function is deprecated and should not be used in new code. Please use the +\helpref{ChangeSelection}{wxnotebookchangeselection} function instead. + \wxheading{See also} \helpref{wxNotebook::GetSelection}{wxnotebookgetselection} +\membersection{wxNotebook::ChangeSelection}\label{wxnotebookchangeselection} + +\func{int}{ChangeSelection}{\param{size\_t}{ page}} + +Changes the selection for the given page, returning the previous selection. + +The call to this function \emph{does not} generate the page changing events. +This is the only difference with \helpref{SetSelection}{wxnotebooksetselection}. +See \helpref{this topic}{progevent} for more info. +