include/wx/ownerdrw.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        ownerdrw.h
   3 // Purpose:     interface for owner-drawn GUI elements
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     11.11.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _OWNERDRW_H
  13 #define   _OWNERDRW_H
  14
  15 #if wxUSE_OWNER_DRAWN
  16
  17 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  18     #pragma interface "ownerdrw.h"
  19 #endif
  20
  21 #include "wx/bitmap.h"
  22 #include "wx/colour.h"
  23 #include "wx/font.h"
  24
  25 // ----------------------------------------------------------------------------
  26 // wxOwnerDrawn - a mix-in base class, derive from it to implement owner-drawn
  27 //                behaviour
  28 //
  29 // wxOwnerDrawn supports drawing of an item with non standard font, color and
  30 // also supports 3 bitmaps: either a checked/unchecked bitmap for a checkable
  31 // element or one unchangeable bitmap otherwise.
  32 // ----------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxOwnerDrawn
  35 {
  36 public:
  37   // ctor & dtor
  38   wxOwnerDrawn(const wxString& str = wxEmptyString,
  39                bool bCheckable = false,
  40                bool bMenuItem = false); // FIXME kludge for colors
  41   virtual ~wxOwnerDrawn() { }
  42
  43   // fix appearance
  44   void SetFont(const wxFont& font)
  45       { m_font = font; m_bOwnerDrawn = true; }
  46
  47   wxFont& GetFont() const { return (wxFont &)m_font; }
  48
  49   void SetTextColour(const wxColour& colText)
  50       { m_colText = colText; m_bOwnerDrawn = true; }
  51
  52   wxColour& GetTextColour() const { return (wxColour&) m_colText; }
  53
  54   void SetBackgroundColour(const wxColour& colBack)
  55       { m_colBack = colBack; m_bOwnerDrawn = true; }
  56
  57   wxColour& GetBackgroundColour() const
  58       { return (wxColour&) m_colBack ; }
  59
  60   void SetBitmaps(const wxBitmap& bmpChecked,
  61                   const wxBitmap& bmpUnchecked = wxNullBitmap)
  62       { m_bmpChecked = bmpChecked;
  63         m_bmpUnchecked = bmpUnchecked;
  64         m_bOwnerDrawn = true; }
  65
  66   void SetBitmap(const wxBitmap& bmpChecked)
  67       { m_bmpChecked = bmpChecked;
  68         m_bOwnerDrawn = true; }
  69
  70   void SetDisabledBitmap( const wxBitmap& bmpDisabled )
  71       { m_bmpDisabled = bmpDisabled;
  72         m_bOwnerDrawn = true; }
  73
  74   const wxBitmap& GetBitmap(bool bChecked = true) const
  75       { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }
  76
  77   const wxBitmap& GetDisabledBitmap() const
  78       { return m_bmpDisabled; }
  79
  80   // the height of the menu checkmark (or bitmap) is determined by the font
  81   // for the current item, but the width should be always the same (for the
  82   // items to be aligned), so by default it's taken to be the same as for
  83   // the last item (and default width for the first one).
  84   //
  85   // NB: default is too small for bitmaps, but ok for checkmarks.
  86   void SetMarginWidth(int nWidth)
  87   {
  88       ms_nLastMarginWidth = m_nMarginWidth = (size_t) nWidth;
  89       if ( ((size_t) nWidth) != ms_nDefaultMarginWidth )
  90           m_bOwnerDrawn = true;
  91   }
  92
  93   int GetMarginWidth() const { return (int) m_nMarginWidth; }
  94   static int GetDefaultMarginWidth() { return (int) ms_nDefaultMarginWidth; }
  95
  96   // accessors
  97   void SetName(const wxString& strName)  { m_strName = strName; }
  98   const wxString& GetName() const { return m_strName;    }
  99   void SetCheckable(bool checkable) { m_bCheckable = checkable; }
 100   bool IsCheckable() const { return m_bCheckable; }
 101
 102   // this is for menu items only: accel string is drawn right aligned after the
 103   // menu item if not empty
 104   void SetAccelString(const wxString& strAccel) { m_strAccel = strAccel; }
 105
 106   // this function might seem strange, but if it returns false it means that
 107   // no non-standard attribute are set, so there is no need for this control
 108   // to be owner-drawn. Moreover, you can force owner-drawn to false if you
 109   // want to change, say, the color for the item but only if it is owner-drawn
 110   // (see wxMenuItem::wxMenuItem for example)
 111   bool IsOwnerDrawn() const { return m_bOwnerDrawn;   }
 112
 113   // switch on/off owner-drawing the item
 114   void SetOwnerDrawn(bool ownerDrawn = true) { m_bOwnerDrawn = ownerDrawn; }
 115   void ResetOwnerDrawn() { m_bOwnerDrawn = false;  }
 116
 117 public:
 118   // constants used in OnDrawItem
 119   // (they have the same values as corresponding Win32 constants)
 120   enum wxODAction
 121   {
 122     wxODDrawAll       = 0x0001,   // redraw entire control
 123     wxODSelectChanged = 0x0002,   // selection changed (see Status.Select)
 124     wxODFocusChanged  = 0x0004    // keyboard focus changed (see Status.Focus)
 125   };
 126
 127   enum wxODStatus
 128   {
 129     wxODSelected  = 0x0001,         // control is currently selected
 130     wxODGrayed    = 0x0002,         // item is to be grayed
 131     wxODDisabled  = 0x0004,         // item is to be drawn as disabled
 132     wxODChecked   = 0x0008,         // item is to be checked
 133     wxODHasFocus  = 0x0010,         // item has the keyboard focus
 134     wxODDefault   = 0x0020,         // item is the default item
 135     wxODHidePrefix= 0x0100          // hide keyboard cues (w2k and xp only)
 136   };
 137
 138   // virtual functions to implement drawing (return true if processed)
 139   virtual bool OnMeasureItem(size_t *pwidth, size_t *pheight);
 140   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 141
 142 protected:
 143   wxString  m_strName,      // label for a manu item
 144             m_strAccel;     // the accel string ("Ctrl-F17") if any
 145
 146 private:
 147   static size_t ms_nDefaultMarginWidth; // menu check mark width
 148   static size_t ms_nLastMarginWidth;    // handy for aligning all items
 149
 150   bool      m_bCheckable,   // used only for menu or check listbox items
 151             m_bOwnerDrawn;  // true if something is non standard
 152
 153   wxFont    m_font;         // font to use for drawing
 154   wxColour  m_colText,      // color ----"---"---"----
 155             m_colBack;      // background color
 156   wxBitmap  m_bmpChecked,   // bitmap to put near the item
 157             m_bmpUnchecked, // (checked is used also for 'uncheckable' items)
 158             m_bmpDisabled;
 159
 160   size_t    m_nHeight,      // font height
 161             m_nMinHeight,   // minimum height, as determined by user's system settings
 162             m_nMarginWidth; // space occupied by bitmap to the left of the item
 163 };
 164
 165 #endif // wxUSE_OWNER_DRAWN
 166
 167 #endif
 168   // _OWNERDRW_H