X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e319bb30f7e88242f56144fcc279b57047566a6b..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/auinotebook.tex?ds=inline diff --git a/docs/latex/wx/auinotebook.tex b/docs/latex/wx/auinotebook.tex index 31feb9fbb5..fec32a0cc9 100644 --- a/docs/latex/wx/auinotebook.tex +++ b/docs/latex/wx/auinotebook.tex @@ -20,19 +20,25 @@ The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxau \wxheading{Derived from} -\helpref{wxControl}{wxcontrol} +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAui}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxAUI\_NB\_DEFAULT\_STYLE}}{Defined as wxAUI\_NB\_TOP | wxAUI\_NB\_TAB\_SPLIT | wxAUI\_NB\_TAB\_MOVE | wxAUI\_NB\_SCROLL\_BUTTONS | wxAUI\_NB\_CLOSE\_ON\_ACTIVE\_TAB -.} +\twocolitem{\windowstyle{wxAUI\_NB\_DEFAULT\_STYLE}}{Defined as wxAUI\_NB\_TOP | wxAUI\_NB\_TAB\_SPLIT | wxAUI\_NB\_TAB\_MOVE | wxAUI\_NB\_SCROLL\_BUTTONS | wxAUI\_NB\_CLOSE\_ON\_ACTIVE\_TAB.} \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_SPLIT}}{Allows the tab control to be split by dragging a tab.} \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_MOVE}}{Allows a tab to be moved horizontally by dragging.} \twocolitem{\windowstyle{wxAUI\_NB\_TAB\_EXTERNAL\_MOVE}}{Allows a tab to be moved to another tab control.} @@ -42,6 +48,8 @@ The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxau \twocolitem{\windowstyle{wxAUI\_NB\_CLOSE\_BUTTON}}{With this style, a close button is available on the tab bar.} \twocolitem{\windowstyle{wxAUI\_NB\_CLOSE\_ON\_ACTIVE\_TAB}}{With this style, the close button is visible on the active tab.} \twocolitem{\windowstyle{wxAUI\_NB\_CLOSE\_ON\_ALL\_TABS}}{With this style, the close button is visible on all tabs.} +\twocolitem{\windowstyle{wxAUI\_NB\_TOP}}{With this style, tabs are drawn along the top of the notebook.} +\twocolitem{\windowstyle{wxAUI\_NB\_BOTTOM}}{With this style, tabs are drawn along the bottom of the notebook.} \end{twocollist} @@ -63,6 +71,12 @@ Constructor. Creates a wxAuiNotebok control. Adds a page. If the {\it select} parameter is true, calling this will generate a page change event. +\membersection{wxAuiNotebook::AdvanceSelection}\label{wxauinotebookadvanceselection} + +\func{void}{AdvanceSelection}{\param{bool }{forward = true}} + +Sets the selection to the next or previous page. + \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}} @@ -81,6 +95,13 @@ Deletes a page at the given index. Calling this method will generate a page cha Returns the associated art provider. +\membersection{wxAuiNotebook::GetHeightForPageHeight}\label{wxauinotebookgetheightforpageheight} + +\func{int}{GetHeightForPageHeight}{\param{int }{pageHeight}} + +Returns the desired height of the notebook for the given page height. Use this to fit the notebook to +a given page size. + \membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage} \constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}} @@ -103,7 +124,8 @@ Returns the number of pages in the notebook. \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}} -Returns the page index for the specified window. If the window is not found in the notebook, wxNOT_FOUND is returned. +Returns the page index for the specified window. If the window is not found in +the notebook, wxNOT\_FOUND is returned. \membersection{wxAuiNotebook::GetPageText}\label{wxauinotebookgetpagetext} @@ -111,6 +133,12 @@ Returns the page index for the specified window. If the window is not found in Returns the tab label for the page. +\membersection{wxAuiNotebook::GetTabCtrlHeight}\label{wxauinotebookgettabctrlheight} + +\constfunc{int}{GetTabCtrlHeight}{\void} + +Returns the height of the tab control. + \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection} \constfunc{int}{GetSelection}{\void} @@ -136,6 +164,30 @@ Removes a page, without deleting the window pointer. Sets the art provider to be used by the notebook. +\membersection{wxAuiNotebook::SetFont}\label{wxauinotebooksetfont} + +\func{bool}{SetFont}{\param{const wxFont\& }{font}} + +Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels. + +\membersection{wxAuiNotebook::SetNormalFont}\label{wxauinotebooksetnormalfont} + +\func{void}{SetNormalFont}{\param{const wxFont\& }{font}} + +Sets the font for drawing unselected tab labels. + +\membersection{wxAuiNotebook::SetSelectedFont}\label{wxauinotebooksetselectedfont} + +\func{void}{SetSelectedFont}{\param{const wxFont\& }{font}} + +Sets the font for drawing selected tab labels. + +\membersection{wxAuiNotebook::SetMeasuringFont}\label{wxauinotebooksetmeasuringfont} + +\func{void}{SetMeasuringFont}{\param{const wxFont\& }{font}} + +Sets the font for measuring tab labels. + \membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap} \func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}} @@ -175,14 +227,17 @@ instruct the control to use dynamic tab height, which is the default behaviour. Under the default behaviour, when a tab with a large bitmap is added, the tab control's height will automatically increase to accommodate the larger bitmap. -\func{void}{Split}{\param{size_t }{page}, \param{int }{direction}} +\func{void}{Split}{\param{size\_t }{page}, \param{int }{direction}} Split performs a split operation programmatically. The argument \arg{page} indicates the page that will be split off. This page will also become the active page after the split. The \arg{direction} argument specifies where the pane should go, it should be one of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT. +\membersection{wxAuiNotebook::ShowWindowMenu}\label{wxauinotebookshowwindowmenu} +\func{bool}{ShowWindowMenu}{\void} - +Shows the window menu for the active tab control associated with this notebook, +and returns \true if a selection was made.