interface/aui/dockart.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        aui/dockart.h
   3 // Purpose:     documentation for wxAuiDockArt class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxAuiDockArt
  11     @headerfile dockart.h wx/aui/dockart.h
  12
  13     wxAuiDockArt is part of the wxAUI class framework.
  14     See also @ref overview_wxauioverview.
  15
  16     Dock art provider code - a dock provider provides all drawing
  17     functionality to the wxAui dock manager. This allows the dock
  18     manager to have a plugable look-and-feel.
  19
  20     By default, a wxAuiManager uses an
  21     instance of this class called @b wxAuiDefaultDockArt which
  22     provides bitmap art and a colour scheme that is adapted to
  23     the major platforms' look. You can either derive from that
  24     class to alter its behaviour or write a completely new dock
  25     art class. Call wxAuiManager::SetArtProvider
  26     to make use this new dock art.
  27
  28     @library{wxaui}
  29     @category{aui}
  30
  31     @seealso
  32     wxAuiManager, wxAuiPaneInfo
  33 */
  34 class wxAuiDockArt
  35 {
  36 public:
  37     /**
  38         Constructor.
  39     */
  40     wxAuiDockArt();
  41
  42     /**
  43         Destructor.
  44     */
  45     ~wxAuiDockArt();
  46
  47     /**
  48         Draws a background.
  49     */
  50     virtual void DrawBackground(wxDC& dc, wxWindow* window,
  51                                 int orientation,
  52                                 const wxRect& rect);
  53
  54     /**
  55         Draws a border.
  56     */
  57     virtual void DrawBorder(wxDC& dc, wxWindow* window,
  58                             const wxRect& rect,
  59                             wxAuiPaneInfo& pane);
  60
  61     /**
  62         Draws a caption.
  63     */
  64     virtual void DrawCaption(wxDC& dc, wxWindow* window,
  65                              const wxString& text,
  66                              const wxRect& rect,
  67                              wxAuiPaneInfo& pane);
  68
  69     /**
  70         Draws a gripper.
  71     */
  72     virtual void DrawGripper(wxDC& dc, wxWindow* window,
  73                              const wxRect& rect,
  74                              wxAuiPaneInfo& pane);
  75
  76     /**
  77         Draws a button in the pane's title bar.
  78         @a button can be one of the values of @b wxAuiButtonId.
  79         @a button_state can be one of the values of @b wxAuiPaneButtonState.
  80     */
  81     virtual void DrawPaneButton(wxDC& dc, wxWindow* window,
  82                                 int button,
  83                                 int button_state,
  84                                 const wxRect& rect,
  85                                 wxAuiPaneInfo& pane);
  86
  87     /**
  88         Draws a sash between two windows.
  89     */
  90     virtual void DrawSash(wxDC& dc, wxWindow* window,
  91                           int orientation,
  92                           const wxRect& rect);
  93
  94     /**
  95         The same as GetColour().
  96     */
  97     virtual wxColour GetColor(int id);
  98
  99     /**
 100         Get the colour of a certain setting.
 101         @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
 102     */
 103     virtual wxColour GetColour(int id);
 104
 105     /**
 106         Get a font setting.
 107     */
 108     virtual wxFont GetFont(int id);
 109
 110     /**
 111         Get the value of a certain setting.
 112         @a id can be one of the size values of @b wxAuiPaneDockArtSetting.
 113     */
 114     virtual int GetMetric(int id);
 115
 116     /**
 117         The same as SetColour().
 118     */
 119     virtual void SetColor(int id, const wxColour& color);
 120
 121     /**
 122         Set a certain setting with the value @e colour.
 123         @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
 124     */
 125     virtual void SetColour(int id, const wxColor& colour);
 126
 127     /**
 128         Set a font setting.
 129     */
 130     virtual void SetFont(int id, const wxFont& font);
 131
 132     /**
 133         Set a certain setting with the value @e new_val.
 134         @a id can be one of the size values of @b wxAuiPaneDockArtSetting.
 135     */
 136     virtual void SetMetric(int id, int new_val);
 137 };