Filter out subframes from the ie backend history and the sample. Also document that...

[wxWidgets.git] / interface / wx / aui / auibook.h

diff --git a/interface/wx/aui/auibook.h b/interface/wx/aui/auibook.h
index b4d933eab3c631b0889980b63947fcb183330754..b96cf4eb5be0026b9e5cce8b708a0d46584336b1 100644 (file)
--- a/interface/wx/aui/auibook.h
+++ b/interface/wx/aui/auibook.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxAuiNotebook
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxAuiNotebook
-    @headerfile auibook.h wx/aui/auibook.h
 
     wxAuiNotebook is part of the wxAUI class framework.
     See also @ref overview_aui.
@@ -21,7 +20,7 @@
     the control's look and feel.
 
     An effort has been made to try to maintain an API as similar to that of
-    wxNotebook.
+    wxNotebook (note that wxAuiNotebook does not derive from wxNotebook!).
 
     The default theme that is used is wxAuiDefaultTabArt, which provides a modern,
     glossy look and feel.
@@ -55,12 +54,37 @@
            With this style, tabs are drawn along the bottom of the notebook.
     @endStyleTable
 
+
+    @beginEventEmissionTable{wxAuiNotebookEvent}
+    @event{EVT_AUINOTEBOOK_PAGE_CLOSE(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_PAGE_CHANGED(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_PAGE_CHANGING(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_BUTTON(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_BEGIN_DRAG(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_END_DRAG(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_DRAG_MOTION(id, func)}
+        Provide description.
+    @event{EVT_AUINOTEBOOK_ALLOW_DND(id, func)}
+        Provide description.
+    @endEventTable
+
+    @todo provide description for the events above.
+
     @library{wxaui}
     @category{aui}
 */
 class wxAuiNotebook : public wxControl
 {
 public:
+    /**
+        Default ctor.
+    */
     wxAuiNotebook();
 
     /**
@@ -224,8 +248,8 @@ public:
         The @a direction argument specifies where the pane should go, it should be one
         of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.
     */
-    void SetUniformBitmapSize(const wxSize& size);
-    void Split(size_t page, int direction);
+    virtual void SetUniformBitmapSize(const wxSize& size);
+    virtual void Split(size_t page, int direction);
     //@}
 
     /**
@@ -239,7 +263,6 @@ public:
 
 /**
     @class wxAuiTabArt
-    @headerfile auibook.h wx/aui/auibook.h
 
     Tab art class.
 
@@ -317,6 +340,20 @@ public:
     */
     virtual void SetSelectedFont(const wxFont& font) = 0;
 
+    /**
+        Sets the colour of the inactive tabs.
+
+        @since 2.9.2
+    */
+    virtual void SetColour(const wxColour& colour) = 0;
+
+    /**
+        Sets the colour of the selected tab.
+
+        @since 2.9.2
+    */
+    virtual void SetActiveColour(const wxColour& colour) = 0;
+
     /**
         Sets sizing information.
     */