X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..1d1b48625e17b7eea75f8da111751a828946a29f:/interface/notebook.h diff --git a/interface/notebook.h b/interface/notebook.h index a83726c0c0..43a91dc98c 100644 --- a/interface/notebook.h +++ b/interface/notebook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: notebook.h -// Purpose: documentation for wxNotebookEvent class +// Purpose: interface of wxNotebookEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{events} - @seealso - wxNotebook + @see wxNotebook */ class wxNotebookEvent : public wxNotifyEvent { @@ -38,18 +37,17 @@ public: /** Constructor (used internally by wxWidgets only). */ - wxNotebookEvent(wxEventType eventType = wxEVT_@NULL, int id = 0, + wxNotebookEvent(wxEventType eventType = wxEVT_NULL, int id = 0, int sel = -1, int oldSel = -1); /** Returns the page that was selected before the change, -1 if none was selected. */ - int GetOldSelection(); + int GetOldSelection() const; /** Returns the currently selected page, or -1 if none was selected. - @b NB: under Windows, GetSelection() will return the same value as GetOldSelection() when called from @c EVT_NOTEBOOK_PAGE_CHANGING handler and not the page which is going to @@ -60,7 +58,7 @@ public: you presumably don't need them anyhow as you already have the corresponding information). */ - int GetSelection(); + int GetSelection() const; /** Sets the id of the page selected before the change. @@ -74,6 +72,7 @@ public: }; + /** @class wxNotebook @wxheader{notebook.h} @@ -112,8 +111,7 @@ public: @library{wxcore} @category{miscwnd} - @seealso - wxBookCtrl, wxNotebookEvent, wxImageList, @ref overview_samplenotebook + @see wxBookCtrl(), wxNotebookEvent, wxImageList, @ref overview_samplenotebook "notebook sample" */ class wxNotebook : public wxBookCtrl overview @@ -122,27 +120,21 @@ public: //@{ /** Constructs a notebook control. - Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN window style. - + @param parent - The parent window. Must be non-@NULL. - + The parent window. Must be non-@NULL. @param id - The window identifier. - + The window identifier. @param pos - The window position. - + The window position. @param size - The window size. - + The window size. @param style - The window style. See wxNotebook. - + The window style. See wxNotebook. @param name - The name of the control (used only under Motif). + The name of the control (used only under Motif). */ wxNotebook(); wxNotebook(wxWindow* parent, wxWindowID id, @@ -155,58 +147,52 @@ public: /** Destroys the wxNotebook object. */ - ~wxNotebook(); + virtual ~wxNotebook(); /** Adds a new page. - The call to this function may generate the page changing events. - + @param page - Specifies the new page. - + Specifies the new page. @param text - Specifies the text for the new page. - + Specifies the text for the new page. @param select - Specifies whether the page should be selected. - + Specifies whether the page should be selected. @param imageId - Specifies the optional image index for the new page. - + Specifies the optional image index for the new page. + @returns @true if successful, @false otherwise. - + @remarks Do not delete the page, it will be deleted by the notebook. - - @sa InsertPage() + + @see InsertPage() */ bool AddPage(wxNotebookPage* page, const wxString& text, - bool select = @false, + bool select = false, int imageId = -1); /** Cycles through the tabs. - The call to this function generates the page changing events. */ - void AdvanceSelection(bool forward = @true); + void AdvanceSelection(bool forward = true); /** Sets the image list for the page control and takes ownership of the list. - - @sa wxImageList, SetImageList() + + @see wxImageList, SetImageList() */ void AssignImageList(wxImageList* imageList); /** Changes the selection for the given page, returning the previous selection. - The call to this function does not generate the page changing events. This is the only difference with SetSelection(). See @ref overview_progevent "this topic" for more info. */ - int ChangeSelection(size_t page); + virtual int ChangeSelection(size_t page); /** Creates a notebook control. See wxNotebook() for a description @@ -214,17 +200,17 @@ public: */ bool Create(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, - const wxSize& size, long style = 0, + const wxSize& size = wxDefaultSize, + long style = 0, const wxString& name = wxNotebookNameStr); /** Deletes all pages. */ - bool DeleteAllPages(); + virtual bool DeleteAllPages(); /** Deletes the specified page, and the associated window. - The call to this function generates the page changing events. */ bool DeletePage(size_t page); @@ -232,14 +218,14 @@ public: /** Returns the currently selected notebook page or @NULL. */ - wxWindow * GetCurrentPage(); + wxWindow* GetCurrentPage() const; /** Returns the associated image list. - - @sa wxImageList, SetImageList() + + @see wxImageList, SetImageList() */ - wxImageList* GetImageList(); + wxImageList* GetImageList() const; /** Returns the window at the given page position. @@ -249,33 +235,32 @@ public: /** Returns the number of pages in the notebook control. */ - size_t GetPageCount(); + size_t GetPageCount() const; /** Returns the image index for the given page. */ - int GetPageImage(size_t nPage); + virtual int GetPageImage(size_t nPage) const; /** Returns the string for the given page. */ - wxString GetPageText(size_t nPage); + virtual wxString GetPageText(size_t nPage) const; /** Returns the number of rows in the notebook control. */ - int GetRowCount(); + virtual int GetRowCount() const; /** 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 @c EVT_NOTEBOOK_PAGE_CHANGED handler depending on the platform and so wxNotebookEvent::GetSelection should be used instead in this case. */ - int GetSelection(); + virtual int GetSelection() const; /** If running under Windows and themes are enabled for the application, this @@ -284,83 +269,110 @@ public: can be passed to @c SetBackgroundColour. Otherwise, an uninitialised colour will be returned. */ - wxColour GetThemeBackgroundColour(); + virtual wxColour GetThemeBackgroundColour() const; /** Returns the index of the tab at the specified position or @c wxNOT_FOUND - if none. If @e flags parameter is non-@NULL, the position of the point + if none. If @a flags parameter is non-@NULL, the position of the point inside the tab is returned as well. - + @param pt - Specifies the point for the hit test. - + Specifies the point for the hit test. @param flags - Return value for detailed information. One of the following values: - - wxBK_HITTEST_NOWHERE - - - There was no tab under this point. - - wxBK_HITTEST_ONICON - - - The point was over an icon (currently wxMSW only). - - wxBK_HITTEST_ONLABEL - - - The point was over a label (currently wxMSW only). - - wxBK_HITTEST_ONITEM - - - The point was over an item, but not on the label or icon. - - wxBK_HITTEST_ONPAGE - - - The point was over a currently selected page, not over any tab. Note that this - flag is present only if wxNOT_FOUND is returned. - + Return value for detailed information. One of the following values: + + + + + + + + wxBK_HITTEST_NOWHERE + + + + + There was no tab under this point. + + + + + + wxBK_HITTEST_ONICON + + + + + The point was over an icon (currently wxMSW only). + + + + + + wxBK_HITTEST_ONLABEL + + + + + The point was over a label (currently wxMSW only). + + + + + + wxBK_HITTEST_ONITEM + + + + + The point was over an item, but not on the label or icon. + + + + + + wxBK_HITTEST_ONPAGE + + + + + The point was over a currently selected page, not over any tab. Note that + this flag is present only if wxNOT_FOUND is returned. + @returns Returns the zero-based tab index or wxNOT_FOUND if there is no - tab is at the specified position. + tab is at the specified position. */ - int HitTest(const wxPoint& pt, long flags = @NULL); + virtual int HitTest(const wxPoint& pt, long* = NULL) const; /** Inserts a new page at the specified position. - + @param index - Specifies the position for the new page. - + Specifies the position for the new page. @param page - Specifies the new page. - + Specifies the new page. @param text - Specifies the text for the new page. - + Specifies the text for the new page. @param select - Specifies whether the page should be selected. - + Specifies whether the page should be selected. @param imageId - Specifies the optional image index for the new page. - + Specifies the optional image index for the new page. + @returns @true if successful, @false otherwise. - + @remarks Do not delete the page, it will be deleted by the notebook. - - @sa AddPage() + + @see AddPage() */ bool InsertPage(size_t index, wxNotebookPage* page, const wxString& text, - bool select = @false, + bool select = false, int imageId = -1); /** An event handler function, called when the page selection is changed. - - @sa wxNotebookEvent + + @see wxNotebookEvent */ void OnSelChange(wxNotebookEvent& event); @@ -372,45 +384,42 @@ public: /** Sets the image list for the page control. It does not take ownership of the image list, you must delete it yourself. - - @sa wxImageList, AssignImageList() + + @see wxImageList, AssignImageList() */ void SetImageList(wxImageList* imageList); /** Sets the amount of space around each page's icon and label, in pixels. - @b NB: The vertical padding cannot be changed in wxGTK. */ void SetPadding(const wxSize& padding); /** - Sets the image index for the given page. @e image is an index into + Sets the image index for the given page. @a image is an index into the image list which was set with SetImageList(). */ - bool SetPageImage(size_t page, int image); + virtual bool SetPageImage(size_t page, int image); /** Sets the width and height of the pages. - @b NB: This method is currently not implemented for wxGTK. */ - void SetPageSize(const wxSize& size); + virtual void SetPageSize(const wxSize& size); /** Sets the text for the given page. */ - bool SetPageText(size_t page, const wxString& text); + virtual bool SetPageText(size_t page, const wxString& text); /** 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 ChangeSelection() function instead. - - @sa GetSelection() + + @see GetSelection() */ - int SetSelection(size_t page); + virtual int SetSelection(size_t page); }; +