include/wx/aui/dockart.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/aui/dockart.h
   3 // Purpose:     wxaui: wx advanced user interface - docking window manager
   4 // Author:      Benjamin I. Williams
   5 // Modified by:
   6 // Created:     2005-05-17
   7 // RCS-ID:      $Id$
   8 // Copyright:   (C) Copyright 2005, Kirix Corporation, All Rights Reserved.
   9 // Licence:     wxWindows Library Licence, Version 3.1
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DOCKART_H_
  13 #define _WX_DOCKART_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_AUI
  22
  23 #include "wx/pen.h"
  24 #include "wx/brush.h"
  25 #include "wx/bitmap.h"
  26 #include "wx/colour.h"
  27
  28 // dock art provider code - a dock provider provides all drawing
  29 // functionality to the wxAui dock manager.  This allows the dock
  30 // manager to have plugable look-and-feels
  31
  32 class WXDLLIMPEXP_AUI wxAuiDockArt
  33 {
  34 public:
  35
  36     wxAuiDockArt() { }
  37     virtual ~wxAuiDockArt() { }
  38
  39     virtual int GetMetric(int id) = 0;
  40     virtual void SetMetric(int id, int newVal) = 0;
  41     virtual void SetFont(int id, const wxFont& font) = 0;
  42     virtual wxFont GetFont(int id) = 0;
  43     virtual wxColour GetColour(int id) = 0;
  44     virtual void SetColour(int id, const wxColor& colour) = 0;
  45     wxColour GetColor(int id) { return GetColour(id); }
  46     void SetColor(int id, const wxColour& color) { SetColour(id, color); }
  47
  48     virtual void DrawSash(wxDC& dc,
  49                           wxWindow* window,
  50                           int orientation,
  51                           const wxRect& rect) = 0;
  52
  53     virtual void DrawBackground(wxDC& dc,
  54                           wxWindow* window,
  55                           int orientation,
  56                           const wxRect& rect) = 0;
  57
  58     virtual void DrawCaption(wxDC& dc,
  59                           wxWindow* window,
  60                           const wxString& text,
  61                           const wxRect& rect,
  62                           wxAuiPaneInfo& pane) = 0;
  63
  64     virtual void DrawGripper(wxDC& dc,
  65                           wxWindow* window,
  66                           const wxRect& rect,
  67                           wxAuiPaneInfo& pane) = 0;
  68
  69     virtual void DrawBorder(wxDC& dc,
  70                           wxWindow* window,
  71                           const wxRect& rect,
  72                           wxAuiPaneInfo& pane) = 0;
  73
  74     virtual void DrawPaneButton(wxDC& dc,
  75                           wxWindow* window,
  76                           int button,
  77                           int buttonState,
  78                           const wxRect& rect,
  79                           wxAuiPaneInfo& pane) = 0;
  80 };
  81
  82
  83 // this is the default art provider for wxAuiManager.  Dock art
  84 // can be customized by creating a class derived from this one,
  85 // or replacing this class entirely
  86
  87 class WXDLLIMPEXP_AUI wxAuiDefaultDockArt : public wxAuiDockArt
  88 {
  89 public:
  90
  91     wxAuiDefaultDockArt();
  92
  93     int GetMetric(int metricId);
  94     void SetMetric(int metricId, int newVal);
  95     wxColour GetColour(int id);
  96     void SetColour(int id, const wxColor& colour);
  97     void SetFont(int id, const wxFont& font);
  98     wxFont GetFont(int id);
  99
 100     void DrawSash(wxDC& dc,
 101                   wxWindow *window,
 102                   int orientation,
 103                   const wxRect& rect);
 104
 105     void DrawBackground(wxDC& dc,
 106                   wxWindow *window,
 107                   int orientation,
 108                   const wxRect& rect);
 109
 110     void DrawCaption(wxDC& dc,
 111                   wxWindow *window,
 112                   const wxString& text,
 113                   const wxRect& rect,
 114                   wxAuiPaneInfo& pane);
 115
 116     void DrawGripper(wxDC& dc,
 117                   wxWindow *window,
 118                   const wxRect& rect,
 119                   wxAuiPaneInfo& pane);
 120
 121     void DrawBorder(wxDC& dc,
 122                   wxWindow *window,
 123                   const wxRect& rect,
 124                   wxAuiPaneInfo& pane);
 125
 126     void DrawPaneButton(wxDC& dc,
 127                   wxWindow *window,
 128                   int button,
 129                   int buttonState,
 130                   const wxRect& rect,
 131                   wxAuiPaneInfo& pane);
 132
 133     void DrawIcon(wxDC& dc,
 134                   const wxRect& rect,
 135                   wxAuiPaneInfo& pane);
 136
 137 protected:
 138
 139     void DrawCaptionBackground(wxDC& dc, const wxRect& rect, bool active);
 140
 141     void InitBitmaps();
 142
 143 protected:
 144
 145     wxPen m_borderPen;
 146     wxBrush m_sashBrush;
 147     wxBrush m_backgroundBrush;
 148     wxBrush m_gripperBrush;
 149     wxFont m_captionFont;
 150     wxBitmap m_inactiveCloseBitmap;
 151     wxBitmap m_inactivePinBitmap;
 152     wxBitmap m_inactiveMaximizeBitmap;
 153     wxBitmap m_inactiveRestoreBitmap;
 154     wxBitmap m_activeCloseBitmap;
 155     wxBitmap m_activePinBitmap;
 156     wxBitmap m_activeMaximizeBitmap;
 157     wxBitmap m_activeRestoreBitmap;
 158     wxPen m_gripperPen1;
 159     wxPen m_gripperPen2;
 160     wxPen m_gripperPen3;
 161     wxColour m_baseColour;
 162     wxColour m_activeCaptionColour;
 163     wxColour m_activeCaptionGradientColour;
 164     wxColour m_activeCaptionTextColour;
 165     wxColour m_inactiveCaptionColour;
 166     wxColour m_inactiveCaptionGradientColour;
 167     wxColour m_inactiveCaptionTextColour;
 168     int m_borderSize;
 169     int m_captionSize;
 170     int m_sashSize;
 171     int m_buttonSize;
 172     int m_gripperSize;
 173     int m_gradientType;
 174 };
 175
 176
 177
 178 #endif // wxUSE_AUI
 179 #endif //_WX_DOCKART_H_