include/wx/effects.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        effects.h
   3 // Purpose:     wxEffects class
   4 //              Draws 3D effects.
   5 // Author:      Julian Smart et al
   6 // Modified by:
   7 // Created:     25/4/2000
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) Julian Smart
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_EFFECTS_H_
  14 #define _WX_EFFECTS_H_
  15
  16 /*
  17  * wxEffects: various 3D effects
  18  */
  19
  20 class WXDLLEXPORT wxEffects: public wxObject
  21 {
  22 DECLARE_CLASS(wxEffects)
  23
  24 public:
  25     // Assume system colours
  26     wxEffects() ;
  27     // Going from lightest to darkest
  28     wxEffects(const wxColour& highlightColour, const wxColour& lightShadow,
  29               const wxColour& faceColour, const wxColour& mediumShadow,
  30               const wxColour& darkShadow) ;
  31
  32     // Accessors
  33     wxColour GetHighlightColour() const { return m_highlightColour; }
  34     wxColour GetLightShadow() const { return m_lightShadow; }
  35     wxColour GetFaceColour() const { return m_faceColour; }
  36     wxColour GetMediumShadow() const { return m_mediumShadow; }
  37     wxColour GetDarkShadow() const { return m_darkShadow; }
  38
  39     void SetHighlightColour(const wxColour& c) { m_highlightColour = c; }
  40     void SetLightShadow(const wxColour& c) { m_lightShadow = c; }
  41     void SetFaceColour(const wxColour& c) { m_faceColour = c; }
  42     void SetMediumShadow(const wxColour& c) { m_mediumShadow = c; }
  43     void SetDarkShadow(const wxColour& c) { m_darkShadow = c; }
  44
  45     void Set(const wxColour& highlightColour, const wxColour& lightShadow,
  46              const wxColour& faceColour, const wxColour& mediumShadow,
  47              const wxColour& darkShadow)
  48     {
  49         SetHighlightColour(highlightColour);
  50         SetLightShadow(lightShadow);
  51         SetFaceColour(faceColour);
  52         SetMediumShadow(mediumShadow);
  53         SetDarkShadow(darkShadow);
  54     }
  55
  56     // Draw a sunken edge
  57     void DrawSunkenEdge(wxDC& dc, const wxRect& rect, int borderSize = 1);
  58
  59     // Tile a bitmap
  60     bool TileBitmap(const wxRect& rect, wxDC& dc, const wxBitmap& bitmap);
  61
  62 protected:
  63     wxColour    m_highlightColour;  // Usually white
  64     wxColour    m_lightShadow;      // Usually light grey
  65     wxColour    m_faceColour;       // Usually grey
  66     wxColour    m_mediumShadow;     // Usually dark grey
  67     wxColour    m_darkShadow;       // Usually black
  68 };
  69
  70 #endif
  71