add more pure virtuals to wxBrushBase; fix the GetColour() functions to return a...

[wxWidgets.git] / interface / treebook.h

diff --git a/interface/treebook.h b/interface/treebook.h
index f4502af7a5ef4b0a683089b3ba3187f8fec70eb8..bd5193b4fb824bed6f3a7cf502cf9a6f90a8fe20 100644 (file)
--- a/interface/treebook.h
+++ b/interface/treebook.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        treebook.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        treebook.h

-// Purpose:     documentation for wxTreebookEvent class
+// Purpose:     interface of wxTreebookEvent

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,31 +9,30 @@
 /**
     @class wxTreebookEvent
     @wxheader{treebook.h}
 /**
     @class wxTreebookEvent
     @wxheader{treebook.h}

-    
+

     This class represents the events generated by a treebook control: currently,
     there are four of them. The PAGE_CHANGING and PAGE_CHANGED - have exactly the
     same
     behaviour as wxNotebookEvent.
     This class represents the events generated by a treebook control: currently,
     there are four of them. The PAGE_CHANGING and PAGE_CHANGED - have exactly the
     same
     behaviour as wxNotebookEvent.

-    
+

     The other two NODE_COLLAPSED and NODE_EXPANDED are triggered when page node in
     the tree control
     is collapsed/expanded. The page index could be retreived by calling
     wxTreebookEvent::GetSelection.
     The other two NODE_COLLAPSED and NODE_EXPANDED are triggered when page node in
     the tree control
     is collapsed/expanded. The page index could be retreived by calling
     wxTreebookEvent::GetSelection.

-    
-    
+
+

     @library{wxcore}
     @category{events}
     @library{wxcore}
     @category{events}

-    
-    @seealso
-    wxNotebookEvent, wxTreebook
+
+    @see wxNotebookEvent, wxTreebook

 */
 class wxTreebookEvent : public wxNotifyEvent
 {
 public:
     /**
 */
 class wxTreebookEvent : public wxNotifyEvent
 {
 public:
     /**

-        @sa wxNotebookEvent
+        @see wxNotebookEvent

     */
     */

-    wxTreebookEvent(wxEventType commandType = wxEVT_@NULL, int id = 0,
+    wxTreebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,

                     int nSel = wxNOT_FOUND,
                     int nOldSel = wxNOT_FOUND);
 
                     int nSel = wxNOT_FOUND,
                     int nOldSel = wxNOT_FOUND);
 


@@ -41,40 +40,40 @@ public:
         Returns the page that was selected before the change, wxNOT_FOUND if none was
         selected.
     */
         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.
     */
 
     /**
         Returns the currently selected page, or wxNOT_FOUND if none was selected.
     */

-    int GetSelection();
+    int GetSelection() const;

 };
 
 
 };
 
 

+

 /**
     @class wxTreebook
     @wxheader{treebook.h}
 /**
     @class wxTreebook
     @wxheader{treebook.h}

-    
+

     This class is an extension of the Notebook class that allows a tree structured
     set of pages to be shown in a control.
     A classic example is a netscape preferences dialog that shows a tree
     of preference sections on the left and select section page on the right.
     This class is an extension of the Notebook class that allows a tree structured
     set of pages to be shown in a control.
     A classic example is a netscape preferences dialog that shows a tree
     of preference sections on the left and select section page on the right.

-    
+

     To use the class simply create it and populate with pages using
     wxTreebook::InsertPage,
     wxTreebook::InsertSubPage,
     wxTreebook::AddPage,
     wxTreebook::AddSubPage.
     To use the class simply create it and populate with pages using
     wxTreebook::InsertPage,
     wxTreebook::InsertSubPage,
     wxTreebook::AddPage,
     wxTreebook::AddSubPage.

-    
+

     If your tree is no more than 1 level in depth then you could
     If your tree is no more than 1 level in depth then you could

-    simply use wxTreebook::AddPage and 
+    simply use wxTreebook::AddPage and

     wxTreebook::AddSubPage to sequentially populate your tree
     by adding at every step a page or a subpage to the end of the tree.
     wxTreebook::AddSubPage to sequentially populate your tree
     by adding at every step a page or a subpage to the end of the tree.

-    
+

     @library{wxcore}
     @category{miscwnd}
     @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
     "notebook sample"
 */
 class wxTreebook : public wxBookCtrl overview


@@ -83,36 +82,30 @@ public:
     //@{
     /**
         Creates an empty TreeBook control.
     //@{
     /**
         Creates an empty TreeBook control.

-        
-        @param parent 
-        The parent window. Must be non-@NULL.
-        
-        @param id 
-        The window identifier.
-        
-        @param pos 
-        The window position.
-        
-        @param size 
-        The window size.
-        
-        @param style 
-        The window style. See wxNotebook.
-        
-        @param name 
-        The name of the control (used only under Motif).
+
+        @param parent
+            The parent window. Must be non-@NULL.
+        @param id
+            The window identifier.
+        @param pos
+            The window position.
+        @param size
+            The window size.
+        @param style
+            The window style. See wxNotebook.
+        @param name
+            The name of the control (used only under Motif).

     */
     wxTreebook();
     */
     wxTreebook();

-        wxTreebook(wxWindow* parent, wxWindowID id,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize,
-                   long style = wxTBK_DEFAULT,
-                   const wxString& name = wxEmptyString);
+    wxTreebook(wxWindow* parent, wxWindowID id,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = wxTBK_DEFAULT,
+               const wxString& name = wxEmptyString);

     //@}
 
     /**
         Destroys the wxTreebook object.
     //@}
 
     /**
         Destroys the wxTreebook object.

-        

         Also deletes all the pages owned by the control (inserted previously into it).
     */
     ~wxTreebook();
         Also deletes all the pages owned by the control (inserted previously into it).
     */
     ~wxTreebook();


@@ -122,7 +115,7 @@ public:
         @NULL could be specified for page to create an empty page.
     */
     bool AddPage(wxWindow* page, const wxString& text,
         @NULL could be specified for page to create an empty page.
     */
     bool AddPage(wxWindow* page, const wxString& text,

-                 bool bSelect = @false,
+                 bool bSelect = false,

                  int imageId = wxNOT_FOUND);
 
     /**
                  int imageId = wxNOT_FOUND);
 
     /**


@@ -130,19 +123,18 @@ public:
         @NULL could be specified for page to create an empty page.
     */
     bool AddSubPage(wxWindow* page, const wxString& text,
         @NULL could be specified for page to create an empty page.
     */
     bool AddSubPage(wxWindow* page, const wxString& text,

-                    bool bSelect = @false,
+                    bool bSelect = false,

                     int imageId = wxNOT_FOUND);
 
     /**
         Sets the image list for the page control and takes ownership of the list.
                     int imageId = wxNOT_FOUND);
 
     /**
         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.
     */
     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.
         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.


@@ -182,33 +174,32 @@ public:
         May generate page changing events (if selected page
         is under the collapsed branch, then its parent is autoselected).
     */
         May generate page changing events (if selected page
         is under the collapsed branch, then its parent is autoselected).
     */

-    bool ExpandNode(size_t pageId, bool expand = @true);
+    bool ExpandNode(size_t pageId, bool expand = true);

 
     /**
         Returns the image index for the given page.
     */
 
     /**
         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.
     */
 
     /**
         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.
     */
 
     /**
         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.
 
     /**
         Returns the currently selected page, or wxNOT_FOUND if none was selected.

-        

         Note that 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 wxTreebookEvent::GetSelection should be used
         instead in this case.
     */
         Note that 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 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.
 
     /**
         Inserts a new page just before the page indicated by pagePos.


@@ -217,29 +208,28 @@ public:
     */
     bool InsertPage(size_t pagePos, wxWindow* page,
                     const wxString& text,
     */
     bool InsertPage(size_t pagePos, wxWindow* page,
                     const wxString& text,

-                    bool bSelect = @false,
+                    bool bSelect = false,

                     int imageId = wxNOT_FOUND);
 
     /**
         Inserts a sub page under the specified page.
                     int imageId = wxNOT_FOUND);
 
     /**
         Inserts a sub page under the specified page.

-        

         @NULL could be specified for page to create an empty page.
     */
     bool InsertSubPage(size_t pagePos, wxWindow* page,
                        const wxString& text,
         @NULL could be specified for page to create an empty page.
     */
     bool InsertSubPage(size_t pagePos, wxWindow* page,
                        const wxString& text,

-                       bool bSelect = @false,
+                       bool bSelect = false,

                        int imageId = wxNOT_FOUND);
 
     /**
         Gets the pagePos page state -- whether it is expanded or collapsed
     */
                        int imageId = wxNOT_FOUND);
 
     /**
         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.
 
     /**
         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);
 
     */
     void SetImageList(wxImageList* imageList);
 


@@ -256,13 +246,12 @@ public:
 
     /**
         Sets the selection for the given page, returning the previous selection.
 
     /**
         Sets the selection for the given page, returning the previous selection.

-        

         The call to this function generates the page changing events.
         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.
         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 n);
 };
     */
     int SetSelection(size_t n);
 };

+