include/wx/univ/colschem.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/colschem.h
   3 // Purpose:     wxColourScheme class provides the colours to use for drawing
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     19.08.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_COLSCHEM_H_
  13 #define _WX_UNIV_COLSCHEM_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "colschem.h"
  17 #endif
  18
  19 class WXDLLEXPORT wxWindow;
  20
  21 #include "wx/colour.h"
  22 #include "wx/checkbox.h"
  23
  24 // ----------------------------------------------------------------------------
  25 // wxColourScheme
  26 // ----------------------------------------------------------------------------
  27
  28 class WXDLLEXPORT wxColourScheme
  29 {
  30 public:
  31     // the standard colours
  32     enum StdColour
  33     {
  34         // the background colour for a window
  35         WINDOW,
  36
  37         // the different background and text colours for the control
  38         CONTROL,
  39         CONTROL_PRESSED,
  40         CONTROL_CURRENT,
  41
  42         // the label text for the normal and the disabled state
  43         CONTROL_TEXT,
  44         CONTROL_TEXT_DISABLED,
  45         CONTROL_TEXT_DISABLED_SHADOW,
  46
  47         // the scrollbar background colour for the normal and pressed states
  48         SCROLLBAR,
  49         SCROLLBAR_PRESSED,
  50
  51         // the background and text colour for the highlighted item
  52         HIGHLIGHT,
  53         HIGHLIGHT_TEXT,
  54
  55         // these colours are used for drawing the shadows of 3D objects
  56         SHADOW_DARK,
  57         SHADOW_HIGHLIGHT,
  58         SHADOW_IN,
  59         SHADOW_OUT,
  60
  61         MAX
  62     };
  63
  64     // get a standard colour
  65     virtual wxColour Get(StdColour col) const = 0;
  66
  67     // get the background colour for the given window
  68     virtual wxColour GetBackground(wxWindow *win) const = 0;
  69
  70     // virtual dtor for any base class
  71     virtual ~wxColourScheme();
  72 };
  73
  74 // some people just can't spell it correctly :-)
  75 typedef wxColourScheme wxColorScheme;
  76
  77 // ----------------------------------------------------------------------------
  78 // macros
  79 // ----------------------------------------------------------------------------
  80
  81 // retrieve the default colour from the theme or the given scheme
  82 #define wxSCHEME_COLOUR(scheme, what) scheme->Get(wxColorScheme::what)
  83 #define wxTHEME_COLOUR(what) \
  84     wxSCHEME_COLOUR(wxTheme::Get()->GetColourScheme(), what)
  85
  86 // get the background colour for the window in the current theme
  87 #define wxTHEME_BG_COLOUR(win) \
  88     wxTheme::Get()->GetColourScheme()->GetBackground(win)
  89
  90 #endif // _WX_UNIV_COLSCHEM_H_