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 SciTech Software, Inc. (www.scitechsoft.com)
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_COLSCHEM_H_
  13 #define _WX_UNIV_COLSCHEM_H_
  14
  15 class WXDLLEXPORT wxWindow;
  16
  17 #include "wx/colour.h"
  18 #include "wx/checkbox.h"
  19
  20 // ----------------------------------------------------------------------------
  21 // wxColourScheme
  22 // ----------------------------------------------------------------------------
  23
  24 class WXDLLEXPORT wxColourScheme
  25 {
  26 public:
  27     // the standard colours
  28     enum StdColour
  29     {
  30         // the background colour for a window
  31         WINDOW,
  32
  33         // the different background and text colours for the control
  34         CONTROL,
  35         CONTROL_PRESSED,
  36         CONTROL_CURRENT,
  37
  38         // the label text for the normal and the disabled state
  39         CONTROL_TEXT,
  40         CONTROL_TEXT_DISABLED,
  41         CONTROL_TEXT_DISABLED_SHADOW,
  42
  43         // the scrollbar background colour for the normal and pressed states
  44         SCROLLBAR,
  45         SCROLLBAR_PRESSED,
  46
  47         // the background and text colour for the highlighted item
  48         HIGHLIGHT,
  49         HIGHLIGHT_TEXT,
  50
  51         // these colours are used for drawing the shadows of 3D objects
  52         SHADOW_DARK,
  53         SHADOW_HIGHLIGHT,
  54         SHADOW_IN,
  55         SHADOW_OUT,
  56
  57         // the titlebar background colours for the normal and focused states
  58         TITLEBAR,
  59         TITLEBAR_ACTIVE,
  60
  61         // the titlebar text colours
  62         TITLEBAR_TEXT,
  63         TITLEBAR_ACTIVE_TEXT,
  64
  65         // the default gauge fill colour
  66         GAUGE,
  67
  68         // desktop background colour (only used by framebuffer ports)
  69         DESKTOP,
  70
  71         // wxFrame's background colour
  72         FRAME,
  73
  74         MAX
  75     };
  76
  77     // get a standard colour
  78     virtual wxColour Get(StdColour col) const = 0;
  79
  80     // get the background colour for the given window
  81     virtual wxColour GetBackground(wxWindow *win) const = 0;
  82
  83     // virtual dtor for any base class
  84     virtual ~wxColourScheme();
  85 };
  86
  87 // some people just can't spell it correctly :-)
  88 typedef wxColourScheme wxColorScheme;
  89
  90 // ----------------------------------------------------------------------------
  91 // macros
  92 // ----------------------------------------------------------------------------
  93
  94 // retrieve the default colour from the theme or the given scheme
  95 #define wxSCHEME_COLOUR(scheme, what) scheme->Get(wxColorScheme::what)
  96 #define wxTHEME_COLOUR(what) \
  97     wxSCHEME_COLOUR(wxTheme::Get()->GetColourScheme(), what)
  98
  99 // get the background colour for the window in the current theme
 100 #define wxTHEME_BG_COLOUR(win) \
 101     wxTheme::Get()->GetColourScheme()->GetBackground(win)
 102
 103 #endif // _WX_UNIV_COLSCHEM_H_