wxThread::Sleep() is the same as wxMilliSleep() on all platforms but Mac (and maybe...

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

diff --git a/interface/aui/dockart.h b/interface/aui/dockart.h
index 118eebd57332f835193be5f976fcac3702d1ad0e..34ae018422c36decf1f7c580caf23e7039bd01eb 100644 (file)
--- a/interface/aui/dockart.h
+++ b/interface/aui/dockart.h
@@ -1,35 +1,96 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        aui/dockart.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        aui/dockart.h

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

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

+
+/**
+    @todo TOWRITE
+*/
+enum wxAuiPaneDockArtSetting
+{
+    wxAUI_DOCKART_SASH_SIZE = 0,
+    wxAUI_DOCKART_CAPTION_SIZE = 1,
+    wxAUI_DOCKART_GRIPPER_SIZE = 2,
+    wxAUI_DOCKART_PANE_BORDER_SIZE = 3,
+    wxAUI_DOCKART_PANE_BUTTON_SIZE = 4,
+    wxAUI_DOCKART_BACKGROUND_COLOUR = 5,
+    wxAUI_DOCKART_SASH_COLOUR = 6,
+    wxAUI_DOCKART_ACTIVE_CAPTION_COLOUR = 7,
+    wxAUI_DOCKART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
+    wxAUI_DOCKART_INACTIVE_CAPTION_COLOUR = 9,
+    wxAUI_DOCKART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
+    wxAUI_DOCKART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
+    wxAUI_DOCKART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
+    wxAUI_DOCKART_BORDER_COLOUR = 13,
+    wxAUI_DOCKART_GRIPPER_COLOUR = 14,
+    wxAUI_DOCKART_CAPTION_FONT = 15,
+    wxAUI_DOCKART_GRADIENT_TYPE = 16
+};
+
+/**
+    @todo TOWRITE
+*/
+enum wxAuiPaneDockArtGradients
+{
+    wxAUI_GRADIENT_NONE = 0,
+    wxAUI_GRADIENT_VERTICAL = 1,
+    wxAUI_GRADIENT_HORIZONTAL = 2
+};
+
+/**
+    @todo TOWRITE
+*/
+enum wxAuiPaneButtonState
+{
+    wxAUI_BUTTON_STATE_NORMAL = 0,
+    wxAUI_BUTTON_STATE_HOVER = 1,
+    wxAUI_BUTTON_STATE_PRESSED = 2
+};
+
+/**
+    @todo TOWRITE
+*/
+enum wxAuiButtonId
+{
+    wxAUI_BUTTON_CLOSE = 101,
+    wxAUI_BUTTON_MAXIMIZE_RESTORE = 102,
+    wxAUI_BUTTON_MINIMIZE = 103,
+    wxAUI_BUTTON_PIN = 104,
+    wxAUI_BUTTON_OPTIONS = 105,
+    wxAUI_BUTTON_WINDOWLIST = 106,
+    wxAUI_BUTTON_LEFT = 107,
+    wxAUI_BUTTON_RIGHT = 108,
+    wxAUI_BUTTON_UP = 109,
+    wxAUI_BUTTON_DOWN = 110,
+    wxAUI_BUTTON_CUSTOM1 = 201,
+    wxAUI_BUTTON_CUSTOM2 = 202,
+    wxAUI_BUTTON_CUSTOM3 = 203
+};
+

 /**
     @class wxAuiDockArt
     @headerfile dockart.h wx/aui/dockart.h
 
     wxAuiDockArt is part of the wxAUI class framework.
 /**
     @class wxAuiDockArt
     @headerfile dockart.h wx/aui/dockart.h
 
     wxAuiDockArt is part of the wxAUI class framework.

-    See also @ref overview_wxauioverview "wxAUI overview".
+    See also @ref overview_aui.

 
 

-    Dock art provider code - a dock provider provides all drawing
-    functionality to the wxAui dock manager. This allows the dock
-    manager to have a plugable look-and-feel.
+    wxAuiDockArt is the art provider: provides all drawing functionality to the
+    wxAui dock manager. This allows the dock manager to have a plugable look-and-feel.

 
 

-    By default, a wxAuiManager uses an
-    instance of this class called @b wxAuiDefaultDockArt which
-    provides bitmap art and a colour scheme that is adapted to
-    the major platforms' look. You can either derive from that
-    class to alter its behaviour or write a completely new dock
-    art class. Call wxAuiManager::SetArtProvider
-    to make use this new dock art.
+    By default, a wxAuiManager uses an instance of this class called
+    wxAuiDefaultDockArt which provides bitmap art and a colour scheme that is
+    adapted to the major platforms' look. You can either derive from that class
+    to alter its behaviour or write a completely new dock art class.
+    Call wxAuiManager::SetArtProvider to force wxAUI to use your new dock art provider.

 
     @library{wxaui}
     @category{aui}
 
 
     @library{wxaui}
     @category{aui}
 

-    @seealso
-    wxAuiManager, wxAuiPaneInfo
+    @see wxAuiManager, wxAuiPaneInfo

 */
 class wxAuiDockArt
 {
 */
 class wxAuiDockArt
 {


@@ -42,102 +103,78 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxAuiDockArt();
+    virtual ~wxAuiDockArt();

 
     /**
         Draws a background.
     */
 
     /**
         Draws a background.
     */

-    virtual void DrawBackground(wxDC& dc, wxWindow* window,
-                                int orientation,
-                                const wxRect& rect);
+    virtual void DrawBackground(wxDC& dc, wxWindow* window, int orientation,
+                                const wxRect& rect) = 0;

 
     /**
         Draws a border.
     */
 
     /**
         Draws a border.
     */

-    virtual void DrawBorder(wxDC& dc, wxWindow* window,
-                            const wxRect& rect,
-                            wxAuiPaneInfo& pane);
+    virtual void DrawBorder(wxDC& dc, wxWindow* window, const wxRect& rect,
+                            wxAuiPaneInfo& pane) = 0;

 
     /**
         Draws a caption.
     */
 
     /**
         Draws a caption.
     */

-    virtual void DrawCaption(wxDC& dc, wxWindow* window,
-                             const wxString& text,
-                             const wxRect& rect,
-                             wxAuiPaneInfo& pane);
+    virtual void DrawCaption(wxDC& dc, wxWindow* window, const wxString& text,
+                             const wxRect& rect, wxAuiPaneInfo& pane) = 0;

 
     /**
         Draws a gripper.
     */
 
     /**
         Draws a gripper.
     */

-    virtual void DrawGripper(wxDC& dc, wxWindow* window,
-                             const wxRect& rect,
-                             wxAuiPaneInfo& pane);
+    virtual void DrawGripper(wxDC& dc, wxWindow* window, const wxRect& rect,
+                             wxAuiPaneInfo& pane) = 0;

 
     /**
         Draws a button in the pane's title bar.
 
     /**
         Draws a button in the pane's title bar.

-        
-        @e button can be one of the values of @b wxAuiButtonId.
-        
-        @e button_state can be one of the values of @b wxAuiPaneButtonState.
+        @a button can be one of the values of @b wxAuiButtonId.
+        @a button_state can be one of the values of @b wxAuiPaneButtonState.

     */
     */

-    virtual void DrawPaneButton(wxDC& dc, wxWindow* window,
-                                int button,
-                                int button_state,
-                                const wxRect& rect,
-                                wxAuiPaneInfo& pane);
+    virtual void DrawPaneButton(wxDC& dc, wxWindow* window, int button,
+                                int button_state, const wxRect& rect,
+                                wxAuiPaneInfo& pane) = 0;

 
     /**
         Draws a sash between two windows.
     */
 
     /**
         Draws a sash between two windows.
     */

-    virtual void DrawSash(wxDC& dc, wxWindow* window,
-                          int orientation,
-                          const wxRect& rect);
-
-    /**
-        The same as GetColour().
-    */
-    virtual wxColour GetColor(int id);
-
+    virtual void DrawSash(wxDC& dc, wxWindow* window, int orientation,
+                          const wxRect& rect) = 0;

     /**
         Get the colour of a certain setting.
     /**
         Get the colour of a certain setting.

-        
-        @e id can be one of the colour values of @b wxAuiPaneDockArtSetting.
+        @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.

     */
     */

-    virtual wxColour GetColour(int id);
+    virtual wxColour GetColour(int id) = 0;

 
     /**
         Get a font setting.
     */
 
     /**
         Get a font setting.
     */

-    virtual wxFont GetFont(int id);
+    virtual wxFont GetFont(int id) = 0;

 
     /**
         Get the value of a certain setting.
 
     /**
         Get the value of a certain setting.

-        
-        @e id can be one of the size values of @b wxAuiPaneDockArtSetting.
+        @a id can be one of the size values of @b wxAuiPaneDockArtSetting.

     */
     */

-    virtual int GetMetric(int id);
-
-    /**
-        The same as SetColour().
-    */
-    virtual void SetColor(int id, const wxColour& color);
+    virtual int GetMetric(int id) = 0;

 
     /**
         Set a certain setting with the value @e colour.
 
     /**
         Set a certain setting with the value @e colour.

-        
-        @e id can be one of the colour values of @b wxAuiPaneDockArtSetting.
+        @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.

     */
     */

-    virtual void SetColour(int id, const wxColor& colour);
+    virtual void SetColour(int id, const wxColour& colour) = 0;

 
     /**
         Set a font setting.
     */
 
     /**
         Set a font setting.
     */

-    virtual void SetFont(int id, const wxFont& font);
+    virtual void SetFont(int id, const wxFont& font) = 0;

 
     /**
         Set a certain setting with the value @e new_val.
 
     /**
         Set a certain setting with the value @e new_val.

-        
-        @e id can be one of the size values of @b wxAuiPaneDockArtSetting.
+        @a id can be one of the size values of @b wxAuiPaneDockArtSetting.

     */
     */

-    virtual void SetMetric(int id, int new_val);
+    virtual void SetMetric(int id, int new_val) = 0;

 };
 };

+