.\" This is a wxWidgets manpage page generated from the XML docs .TH wxNotebook 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxNotebook \- Notebook class .SH DESCRIPTION This class represents a notebook control, which manages multiple windows with associated tabs. To use the class, create a wxNotebook object and call AddPage or InsertPage , passing a window to be used as the page. Do not explicitly delete the window for a page that is currently managed by wxNotebook. wxNotebookPage is a typedef for wxWindow. Page backgrounds 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 wxSystemOptions::SetOption to disable it for the whole application, or you can disable it for individual pages by using SetBackgroundColour . To disable themed pages globally: wxSystemOptions::SetOption(wxT("msw.notebook.themed-background"), 0); Set the value to 1 to enable it again. To give a single page a solid background that more or less fits in with the overall theme, use: wxColour col = notebook->GetThemeBackgroundColour(); if (col.Ok()) { page->SetBackgroundColour(col); } On platforms other than Windows, or if the application is not using Windows themes, GetThemeBackgroundColour will return an uninitialised colour object, and the above code will therefore work on all platforms. .SH "PARENTS" wxControl wxWindow wxEvtHandler wxObject .SH "INCLUDE FILES" wx/notebook.h .SH MEMBERS .SS wxNotebook () Default constructor. .SS wxNotebook (wxWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = 0const wxString& name = wxNotebookNameStr) Constructs a notebook control. Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN window style. .SS ~wxNotebook () Destroys the wxNotebook object. .SS bool AddPage (wxNotebookPage* pageconst wxString& textbool select = falseint imageId = -1) Adds a new page. The call to this function may generate the page changing events. .SS void AdvanceSelection (bool forward = true) Cycles through the tabs. The call to this function generates the page changing events. .SS void AssignImageList (wxImageList* imageList) Sets the image list for the page control and takes ownership of the list. .SS bool Create (wxWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& sizelong style = 0const wxString& name = wxNotebookNameStr) Creates a notebook control. See wxNotebook::wxNotebook for a description of the parameters. .SS bool DeleteAllPages () Deletes all pages. .SS bool DeletePage (size_t page) Deletes the specified page, and the associated window. The call to this function generates the page changing events. .SS wxWindow * GetCurrentPage () Returns the currently selected notebook age or NULL . .SS wxImageList* GetImageList () .SS wxNotebookPage* GetPage (size_t page) Returns the window at the given page position. .SS size_t GetPageCount () Returns the number of pages in the notebook control. .SS int GetPageImage (size_t nPage) Returns the image index for the given page. .SS wxString GetPageText (size_t nPage) Returns the string for the given page. .SS int GetRowCount () Returns the number of rows in the notebook control. .SS int GetSelection () 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 EVT_NOTEBOOK_PAGE_CHANGED handler depending on the platform and so wxNotebookEvent::GetSelection should be used instead in this case. .SS wxColour GetThemeBackgroundColour () If running under Windows and themes are enabled for the application, this function returns a suitable colour for painting the background of a notebook page, and can be passed to SetBackgroundColour . Otherwise, an uninitialised colour will be returned. .SS int HitTest (const wxPoint& ptlong *flags = NULL) Returns the index of the tab at the specified position or wxNOT_FOUND if none. If flags parameter is non NULL , the position of the point inside the tab is returned as well. NB: This method is currently only implemented under wxMSW and wxUniv. .SS bool InsertPage (size_t indexwxNotebookPage* pageconst wxString& textbool select = falseint imageId = -1) Inserts a new page at the specified position. .SS void OnSelChange (wxNotebookEvent& event) An event handler function, called when the page selection is changed. .SS bool RemovePage (size_t page) Deletes the specified page, without deleting the associated window. .SS void SetImageList (wxImageList* imageList) Sets the image list for the page control. It does not take ownership of the image list, you must delete it yourself. .SS void SetPadding (const wxSize& padding) Sets the amount of space around each page's icon and label, in pixels. NB: The vertical padding cannot be changed in wxGTK. .SS void SetPageSize (const wxSize& size) Sets the width and height of the pages. NB: This method is currently not implemented for wxGTK. .SS bool SetPageImage (size_t pageint image) Sets the image index for the given page. image is an index into the image list which was set with wxNotebook::SetImageList . .SS bool SetPageText (size_t pageconst wxString& text) Sets the text for the given page. .SS int SetSelection (size_t page) Sets the selection for the given page, returning the previous selection. The call to this function generates the page changing events. .SH "WINDOW STYLES" .SS wxNB_TOP Place tabs on the top side. .SS wxNB_LEFT Place tabs on the left side. .SS wxNB_RIGHT Place tabs on the right side. .SS wxNB_BOTTOM Place tabs under instead of above the notebook pages. .SS wxNB_FIXEDWIDTH (Windows only) All tabs will have same width. .SS wxNB_MULTILINE (Windows only) There can be several rows of tabs. .SS wxNB_NOPAGETHEME (Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance. .SS wxNB_FLAT (Windows CE only) Show tabs in a flat style. .SH "SEE ALSO" wxControl wxWindow wxEvtHandler wxObject wxBookCtrl wxNotebookEvent wxImageList notebook sample .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.