X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..ea58aac5808a7617dd68c94b651ad70e038a324f:/interface/treebook.h?ds=sidebyside diff --git a/interface/treebook.h b/interface/treebook.h index d4d469e12e..bd5193b4fb 100644 --- a/interface/treebook.h +++ b/interface/treebook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: treebook.h -// Purpose: documentation for wxTreebookEvent class +// Purpose: interface of wxTreebookEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxcore} @category{events} - @seealso - wxNotebookEvent, wxTreebook + @see wxNotebookEvent, wxTreebook */ class wxTreebookEvent : public wxNotifyEvent { @@ -41,15 +40,16 @@ public: Returns the page that was selected before the change, wxNOT_FOUND if none was selected. */ - int GetOldSelection(); + int GetOldSelection() const; /** Returns the currently selected page, or wxNOT_FOUND if none was selected. */ - int GetSelection(); + int GetSelection() const; }; + /** @class wxTreebook @wxheader{treebook.h} @@ -73,8 +73,7 @@ public: @library{wxcore} @category{miscwnd} - @seealso - wxNotebook, wxTreebookEvent, wxImageList, @ref overview_samplenotebook + @see wxNotebook, wxTreebookEvent, wxImageList, @ref overview_samplenotebook "notebook sample" */ class wxTreebook : public wxBookCtrl overview @@ -83,7 +82,7 @@ public: //@{ /** Creates an empty TreeBook control. - + @param parent The parent window. Must be non-@NULL. @param id @@ -129,7 +128,7 @@ public: /** Sets the image list for the page control and takes ownership of the list. - + @see wxImageList, SetImageList() */ void AssignImageList(wxImageList* imageList); @@ -180,18 +179,18 @@ public: /** Returns the image index for the given page. */ - int GetPageImage(size_t n); + int GetPageImage(size_t n) const; /** Returns the parent page of the given one or @c wxNOT_FOUND if this is a top-level page. */ - int GetPageParent(size_t page); + int GetPageParent(size_t page) const; /** Returns the string for the given page. */ - wxString GetPageText(size_t n); + wxString GetPageText(size_t n) const; /** Returns the currently selected page, or wxNOT_FOUND if none was selected. @@ -200,7 +199,7 @@ public: depending on the platform and so wxTreebookEvent::GetSelection should be used instead in this case. */ - int GetSelection(); + int GetSelection() const; /** Inserts a new page just before the page indicated by pagePos. @@ -224,12 +223,12 @@ public: /** Gets the pagePos page state -- whether it is expanded or collapsed */ - bool IsNodeExpanded(size_t pageId); + bool IsNodeExpanded(size_t pageId) const; /** Sets the image list for the page control. It does not take ownership of the image list, you must delete it yourself. - + @see wxImageList, AssignImageList() */ void SetImageList(wxImageList* imageList); @@ -250,8 +249,9 @@ public: 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. - + @see GetSelection() */ int SetSelection(size_t n); }; +