synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / treebook.h

diff --git a/interface/wx/treebook.h b/interface/wx/treebook.h
index 77f75a97325d2e6c4808530399a6c38c4c38ba38..776b2afca3e9688787bd8f7bab8c11dde2f55d43 100644 (file)
--- a/interface/wx/treebook.h
+++ b/interface/wx/treebook.h
@@ -3,9 +3,15 @@
 // Purpose:     interface of wxTreebook
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxTreebook
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+
+wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED;
+wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING;
+wxEventType wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED;
+wxEventType wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED;
+

 /**
     @class wxTreebook
 
 /**
     @class wxTreebook
 


@@ -21,24 +27,24 @@
     AddPage() and AddSubPage() to sequentially populate your tree by adding at
     every step a page or a subpage to the end of the tree.
 
     AddPage() and AddSubPage() to sequentially populate your tree by adding at
     every step a page or a subpage to the end of the tree.
 

-    @beginEventTable{wxBookCtrlEvent}
+    @beginEventEmissionTable{wxBookCtrlEvent}

     @event{EVT_TREEBOOK_PAGE_CHANGED(id, func)}
     @event{EVT_TREEBOOK_PAGE_CHANGED(id, func)}

-        The page selection was changed. Processes a @c
-        wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED event.
+        The page selection was changed.
+        Processes a @c wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED event.

     @event{EVT_TREEBOOK_PAGE_CHANGING(id, func)}
     @event{EVT_TREEBOOK_PAGE_CHANGING(id, func)}

-        The page selection is about to be changed. Processes a @c
-        wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING event. This event can be @ref
-        wxNotifyEvent::Veto() "vetoed".
+        The page selection is about to be changed.
+        Processes a @c wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING event.
+        This event can be @ref wxNotifyEvent::Veto() "vetoed".

     @event{EVT_TREEBOOK_NODE_COLLAPSED(id, func)}
     @event{EVT_TREEBOOK_NODE_COLLAPSED(id, func)}

-        The page node is going to be collapsed. Processes a @c
-        wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED event.
+        The page node is going to be collapsed.
+        Processes a @c wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED event.

     @event{EVT_TREEBOOK_NODE_EXPANDED(id, func)}
     @event{EVT_TREEBOOK_NODE_EXPANDED(id, func)}

-        The page node is going to be expanded. Processes a @c
-        wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED event.
+        The page node is going to be expanded.
+        Processes a @c wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED event.

     @endEventTable
 
     @library{wxcore}
     @endEventTable
 
     @library{wxcore}

-    @category{miscwnd}
+    @category{bookctrl}

 
     @see wxBookCtrl, wxBookCtrlEvent, wxNotebook, wxTreeCtrl, wxImageList,
          @ref overview_bookctrl, @ref page_samples_notebook
 
     @see wxBookCtrl, wxBookCtrlEvent, wxNotebook, wxTreeCtrl, wxImageList,
          @ref overview_bookctrl, @ref page_samples_notebook


@@ -74,8 +80,8 @@ public:
                const wxString& name = wxEmptyString);
 
     /**
                const wxString& name = wxEmptyString);
 
     /**

-        Destroys the wxTreebook object. Also deletes all the pages owned by the
-        control (inserted previously into it).
+        Destroys the wxTreebook object.
+        Also deletes all the pages owned by the control (inserted previously into it).

     */
     virtual ~wxTreebook();
 
     */
     virtual ~wxTreebook();
 


@@ -93,23 +99,6 @@ public:
     virtual bool AddSubPage(wxWindow* page, const wxString& text,
                             bool bSelect = false, int imageId = wxNOT_FOUND);
 
     virtual bool AddSubPage(wxWindow* page, const wxString& text,
                             bool bSelect = false, int imageId = wxNOT_FOUND);
 

-    /**
-        Sets the image list for the page control and takes ownership of the
-        list.
-
-        @see wxImageList, SetImageList()
-    */
-    virtual 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_eventhandling_prog for more info.
-    */
-    virtual int ChangeSelection(size_t page);

 
     /**
         Shortcut for @ref wxTreebook::ExpandNode() "ExpandNode"( @a pageId,
 
     /**
         Shortcut for @ref wxTreebook::ExpandNode() "ExpandNode"( @a pageId,


@@ -128,29 +117,19 @@ public:
                 const wxString& name = wxEmptyString);
 
     /**
                 const wxString& name = wxEmptyString);
 
     /**

-        Deletes all pages inserted into the treebook. No event is generated.
-    */
-    virtual bool DeleteAllPages();
-
-    /**
-        Deletes the page at the specified position and all its children. Could
-        trigger page selection change in a case when selected page is removed.
+        Deletes the page at the specified position and all its children.
+        Could trigger page selection change in a case when selected page is removed.

         In that case its parent is selected (or the next page if no parent).
     */
     virtual bool DeletePage(size_t pagePos);
 
     /**
         In that case its parent is selected (or the next page if no parent).
     */
     virtual bool DeletePage(size_t pagePos);
 
     /**

-        Expands (collapses) the @a pageId node. Returns the previous state. May
-        generate page changing events (if selected page is under the collapsed
+        Expands (collapses) the @a pageId node. Returns the previous state.
+        May generate page changing events (if selected page is under the collapsed

         branch, then its parent is autoselected).
     */
     virtual bool ExpandNode(size_t pageId, bool expand = true);
 
         branch, then its parent is autoselected).
     */
     virtual bool ExpandNode(size_t pageId, bool expand = true);
 

-    /**
-        Returns the image index for the given page.
-    */
-    virtual 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.
     /**
         Returns the parent page of the given one or @c wxNOT_FOUND if this is a
         top-level page.


@@ -158,25 +137,19 @@ public:
     int GetPageParent(size_t page) const;
 
     /**
     int GetPageParent(size_t page) const;
 
     /**

-        Returns the string for the given page.
-    */
-    virtual wxString GetPageText(size_t n) const;
-
-    /**
-        Returns the currently selected page, or @c wxNOT_FOUND if none was
-        selected.
+        Returns the currently selected page, or @c wxNOT_FOUND if none was selected.

 
         @note This method may return either the previously or newly selected
 
         @note This method may return either the previously or newly selected

-            page when called from the EVT_TREEBOOK_PAGE_CHANGED() handler
-            depending on the platform and so wxBookCtrlEvent::GetSelection()
-            should be used instead in this case.
+              page when called from the EVT_TREEBOOK_PAGE_CHANGED() handler
+              depending on the platform and so wxBookCtrlEvent::GetSelection()
+              should be used instead in this case.

     */
     virtual int GetSelection() const;
 
     /**
     */
     virtual int GetSelection() const;
 
     /**

-        Inserts a new page just before the page indicated by @a pagePos. The new
-        page is placed before @a pagePos page and on the same level. @NULL could
-        be specified for page to create an empty page.
+        Inserts a new page just before the page indicated by @a pagePos.
+        The new page is placed before @a pagePos page and on the same level.
+        @NULL could be specified for page to create an empty page.

     */
     virtual bool InsertPage(size_t pagePos, wxWindow* page,
                             const wxString& text, bool bSelect = false,
     */
     virtual bool InsertPage(size_t pagePos, wxWindow* page,
                             const wxString& text, bool bSelect = false,


@@ -195,35 +168,5 @@ public:
         Returns @true if the page represented by @a pageId is expanded.
     */
     virtual bool IsNodeExpanded(size_t pageId) const;
         Returns @true if the page represented by @a pageId is expanded.
     */
     virtual 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()
-    */
-    virtual void SetImageList(wxImageList* imageList);
-
-    /**
-        Sets the image index for the given @a page. @a imageId is an index into
-        the image list which was set with SetImageList().
-    */
-    virtual bool SetPageImage(size_t page, int imageId);
-
-    /**
-        Sets the @a text for the given @a page.
-    */
-    virtual bool SetPageText(size_t page, const wxString& text);
-
-    /**
-        @deprecated Please use ChangeSelection() instead.
-
-        Sets the selection for the given page, returning the previous selection.
-
-        The call to this function generates page changing events.
-
-        @see GetSelection(), ChangeSelection()
-    */
-    virtual int SetSelection(size_t n);

 };
 
 };