Minor doc corrections for [q-r] in ticket #9581 (most of the patch was applied alread...

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

diff --git a/interface/aui/auibook.h b/interface/aui/auibook.h
index e7ed67a043c24dda4e8a0ff2e054a9e6f3450204..b4d933eab3c631b0889980b63947fcb183330754 100644 (file)
--- a/interface/aui/auibook.h
+++ b/interface/aui/auibook.h
@@ -28,30 +28,30 @@
     The theme can be changed by calling wxAuiNotebook::SetArtProvider.
 
     @beginStyleTable
-    @style{wxAUI_NB_DEFAULT_STYLE}:
+    @style{wxAUI_NB_DEFAULT_STYLE}
            Defined as wxAUI_NB_TOP | wxAUI_NB_TAB_SPLIT | wxAUI_NB_TAB_MOVE |
            wxAUI_NB_SCROLL_BUTTONS | wxAUI_NB_CLOSE_ON_ACTIVE_TAB.
-    @style{wxAUI_NB_TAB_SPLIT}:
+    @style{wxAUI_NB_TAB_SPLIT}
            Allows the tab control to be split by dragging a tab.
-    @style{wxAUI_NB_TAB_MOVE}:
+    @style{wxAUI_NB_TAB_MOVE}
            Allows a tab to be moved horizontally by dragging.
-    @style{wxAUI_NB_TAB_EXTERNAL_MOVE}:
+    @style{wxAUI_NB_TAB_EXTERNAL_MOVE}
            Allows a tab to be moved to another tab control.
-    @style{wxAUI_NB_TAB_FIXED_WIDTH}:
+    @style{wxAUI_NB_TAB_FIXED_WIDTH}
            With this style, all tabs have the same width.
-    @style{wxAUI_NB_SCROLL_BUTTONS}:
+    @style{wxAUI_NB_SCROLL_BUTTONS}
            With this style, left and right scroll buttons are displayed.
-    @style{wxAUI_NB_WINDOWLIST_BUTTON}:
+    @style{wxAUI_NB_WINDOWLIST_BUTTON}
            With this style, a drop-down list of windows is available.
-    @style{wxAUI_NB_CLOSE_BUTTON}:
+    @style{wxAUI_NB_CLOSE_BUTTON}
            With this style, a close button is available on the tab bar.
-    @style{wxAUI_NB_CLOSE_ON_ACTIVE_TAB}:
+    @style{wxAUI_NB_CLOSE_ON_ACTIVE_TAB}
            With this style, the close button is visible on the active tab.
-    @style{wxAUI_NB_CLOSE_ON_ALL_TABS}:
+    @style{wxAUI_NB_CLOSE_ON_ALL_TABS}
            With this style, the close button is visible on all tabs.
-    @style{wxAUI_NB_TOP}:
+    @style{wxAUI_NB_TOP}
            With this style, tabs are drawn along the top of the notebook.
-    @style{wxAUI_NB_BOTTOM}:
+    @style{wxAUI_NB_BOTTOM}
            With this style, tabs are drawn along the bottom of the notebook.
     @endStyleTable
 
@@ -125,7 +125,7 @@ public:
     size_t GetPageCount() const;
 
     /**
-        Returns the page index for the specified window. 
+        Returns the page index for the specified window.
         If the window is not found in the notebook, wxNOT_FOUND is returned.
     */
     int GetPageIndex(wxWindow* page_wnd) const;
@@ -170,7 +170,7 @@ public:
         Sets the font for drawing the tab labels, using a bold version of the font for
         selected tab labels.
     */
-    bool SetFont(const wxFont& font);
+    virtual bool SetFont(const wxFont& font);
 
     /**
         Sets the font for measuring tab labels.
@@ -213,7 +213,7 @@ public:
         Specifying -1 as the height will return the control to its default auto-sizing
         behaviour.
     */
-    void SetTabCtrlHeight(int height);
+    virtual void SetTabCtrlHeight(int height);
 
     //@{
     /**
@@ -259,85 +259,67 @@ public:
     /**
         Clones the art object.
     */
-    wxAuiTabArt* Clone();
+    virtual wxAuiTabArt* Clone() = 0;
 
     /**
         Draws a background on the given area.
     */
-    void DrawBackground(wxDC& dc, wxWindow* wnd, const wxRect& rect);
+    virtual void DrawBackground(wxDC& dc, wxWindow* wnd, const wxRect& rect) = 0;
 
     /**
         Draws a button.
     */
-    void DrawButton(wxDC& dc, wxWindow* wnd, const wxRect& in_rect,
-                    int bitmap_id,
-                    int button_state,
-                    int orientation,
-                    const wxBitmap& bitmap_override,
-                    wxRect* out_rect);
+    virtual void DrawButton(wxDC& dc, wxWindow* wnd, const wxRect& in_rect,
+                            int bitmap_id, int button_state, int orientation,
+                            wxRect* out_rect) = 0;
 
     /**
         Draws a tab.
     */
-    void DrawTab(wxDC& dc, wxWindow* wnd, const wxRect& in_rect,
-                 const wxString& caption,
-                 const wxBitmap& bitmap,
-                 bool active,
-                 int close_button_state,
-                 wxRect* out_tab_rect,
-                 wxRect* out_button_rect,
-                 int* x_extent);
+    virtual void DrawTab(wxDC& dc, wxWindow* wnd, const wxAuiNotebookPage& page,
+                         const wxRect& rect, int close_button_state,
+                         wxRect* out_tab_rect, wxRect* out_button_rect, int* x_extent) = 0;
 
     /**
         Returns the tab control size.
     */
-    int GetBestTabCtrlSize(wxWindow* wnd,
-                           wxAuiNotebookPageArray& pages);
+    virtual int GetBestTabCtrlSize(wxWindow*, const wxAuiNotebookPageArray&, const wxSize&) = 0;
 
     /**
         Returns the indent size.
     */
-    int GetIndentSize();
+    virtual int GetIndentSize() = 0;
 
     /**
         Returns the tab size for the given caption, bitmap and state.
     */
-    wxSize GetTabSize(wxDC& dc, wxWindow* wnd,
-                      const wxString& caption,
-                      const wxBitmap& bitmap,
-                      bool active,
-                      int close_button_state,
-                      int* x_extent);
+    virtual wxSize GetTabSize(wxDC& dc, wxWindow* wnd, const wxString& caption,
+                              const wxBitmap& bitmap, bool active,
+                              int close_button_state, int* x_extent) = 0;
 
     /**
         Sets flags.
     */
-    void SetFlags(unsigned int flags);
+    virtual void SetFlags(unsigned int flags) = 0;
 
     /**
         Sets the font used for calculating measurements.
     */
-    void SetMeasuringFont(const wxFont& font);
+    virtual void SetMeasuringFont(const wxFont& font) = 0;
 
     /**
         Sets the normal font for drawing labels.
     */
-    void SetNormalFont(const wxFont& font);
+    virtual void SetNormalFont(const wxFont& font) = 0;
 
     /**
         Sets the font for drawing text for selected UI elements.
     */
-    void SetSelectedFont(const wxFont& font);
+    virtual void SetSelectedFont(const wxFont& font) = 0;
 
     /**
         Sets sizing information.
     */
-    void SetSizingInfo(const wxSize& tab_ctrl_size, size_t tab_count);
-
-    /**
-        Pops up a menu to show the list of windows managed by wxAui.
-    */
-    int ShowWindowList(wxWindow* wnd, const wxArrayString& items,
-                       int active_idx);
+    virtual void SetSizingInfo(const wxSize& tab_ctrl_size, size_t tab_count) = 0;
 };