X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0aaf0255e451c8a599f622f49443a8a4347c9ee8..4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef:/interface/notebook.h?ds=sidebyside diff --git a/interface/notebook.h b/interface/notebook.h index a83726c0c0..7c1e6e70da 100644 --- a/interface/notebook.h +++ b/interface/notebook.h @@ -38,7 +38,7 @@ 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); @@ -49,7 +49,6 @@ public: /** 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 @@ -122,27 +121,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, @@ -159,49 +152,43 @@ public: /** 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. @@ -224,7 +211,6 @@ public: /** Deletes the specified page, and the associated window. - The call to this function generates the page changing events. */ bool DeletePage(size_t page); @@ -232,12 +218,12 @@ public: /** Returns the currently selected notebook page or @NULL. */ - wxWindow * GetCurrentPage(); + wxWindow* GetCurrentPage(); /** Returns the associated image list. - @sa wxImageList, SetImageList() + @see wxImageList, SetImageList() */ wxImageList* GetImageList(); @@ -268,7 +254,6 @@ public: /** 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 @@ -288,79 +273,106 @@ public: /** 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: + Return value for detailed information. One of the following values: + + + + + + + + wxBK_HITTEST_NOWHERE + + + + + There was no tab under this point. + - wxBK_HITTEST_NOWHERE - There was no tab under this point. - wxBK_HITTEST_ONICON + wxBK_HITTEST_ONICON - The point was over an icon (currently wxMSW only). - wxBK_HITTEST_ONLABEL + The point was over an icon (currently wxMSW only). - 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 + wxBK_HITTEST_ONLABEL - The point was over a currently selected page, not over any tab. Note that this - flag is present only if wxNOT_FOUND is returned. + + + 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); + int HitTest(const wxPoint& pt, long flags = NULL); /** 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); @@ -373,26 +385,24 @@ 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); /** Sets the width and height of the pages. - @b NB: This method is currently not implemented for wxGTK. */ void SetPageSize(const wxSize& size); @@ -404,13 +414,11 @@ public: /** 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); };