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 license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _OWNERDRW_H
  13 #define   _OWNERDRW_H
  14
  15 #ifdef    __GNUG__
  16 #pragma interface "ownerdrw.h"
  17 #endif
  18
  19 typedef   wxColour      wxColor;
  20
  21 // No, don't do this: BC++ 5 complains that size_t already been defined.
  22 // typedef   unsigned int  size_t;
  23 #include <stddef.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 class WXDLLEXPORT wxOwnerDrawn
  34 {
  35 public:
  36   // ctor & dtor
  37   wxOwnerDrawn(const wxString& str = "",
  38                bool bCheckable = FALSE,
  39                bool bMenuItem = FALSE); // @@ kludge for colors
  40   virtual ~wxOwnerDrawn() { }
  41
  42   // fix appearance
  43   inline void SetFont(const wxFont& font)
  44   { m_font = font; m_bOwnerDrawn = TRUE; }
  45
  46   inline wxFont& GetFont() const { return (wxFont &)m_font; }
  47
  48   inline void SetTextColour(const wxColour& colText)
  49   { m_colText = colText; m_bOwnerDrawn = TRUE; }
  50
  51   inline wxColour& GetTextColour() const { return (wxColour&) m_colText; }
  52
  53   inline void SetBackgroundColour(const wxColour& colBack)
  54   { m_colBack = colBack; m_bOwnerDrawn = TRUE; }
  55
  56   inline wxColour& GetBackgroundColour() const
  57   { return (wxColour&) m_colBack ; }
  58
  59   inline void SetBitmaps(const wxBitmap& bmpChecked,
  60                          const wxBitmap& bmpUnchecked = wxNullBitmap)
  61   { m_bmpChecked = bmpChecked;
  62     m_bmpUnchecked = bmpUnchecked;
  63     m_bOwnerDrawn = TRUE;          }
  64
  65   inline const wxBitmap& GetBitmap(bool bChecked = TRUE) const
  66   { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }
  67
  68   // the height of the menu checkmark (or bitmap) is determined by the font
  69   // for the current item, but the width should be always the same (for the
  70   // items to be aligned), so by default it's taken to be the same as for
  71   // the last item (and default width for the first one).
  72   //
  73   // NB: default is too small for bitmaps, but ok for checkmarks.
  74   inline void SetMarginWidth(int nWidth)
  75   { ms_nLastMarginWidth = m_nMarginWidth = (size_t) nWidth;
  76     if ( ((size_t) nWidth) != ms_nDefaultMarginWidth ) m_bOwnerDrawn = TRUE; }
  77
  78   inline int GetMarginWidth() const { return (int) m_nMarginWidth; }
  79   inline static int GetDefaultMarginWidth() { return (int) ms_nDefaultMarginWidth; }
  80
  81   // accessors
  82   void            SetName(const wxString& strName)  { m_strName = strName; }
  83   const wxString& GetName()       const             { return m_strName;    }
  84   bool            IsCheckable()   const             { return m_bCheckable; }
  85
  86   // this function might seem strange, but if it returns FALSE it means that
  87   // no non-standard attribute are set, so there is no need for this control
  88   // to be owner-drawn. Moreover, you can force owner-drawn to FALSE if you
  89   // want to change, say, the color for the item but only if it is owner-drawn
  90   // (see wxMenuItem::wxMenuItem for example)
  91   inline bool     IsOwnerDrawn()  const             { return m_bOwnerDrawn;   }
  92   inline void     ResetOwnerDrawn()                 { m_bOwnerDrawn = FALSE;  }
  93
  94 public:
  95   // constants used in OnDrawItem
  96   // (they have the same values as corresponding Win32 constants)
  97   enum wxODAction
  98   {
  99     wxODDrawAll       = 0x0001,   // redraw entire control
 100     wxODSelectChanged = 0x0002,   // selection changed (see Status.Select)
 101     wxODFocusChanged  = 0x0004,   // keyboard focus changed (see Status.Focus)
 102   };
 103
 104   enum wxODStatus
 105   {
 106     wxODSelected  = 0x0001,         // control is currently selected
 107     wxODGrayed    = 0x0002,         // item is to be grayed
 108     wxODDisabled  = 0x0004,         // item is to be drawn as disabled
 109     wxODChecked   = 0x0008,         // item is to be checked
 110     wxODHasFocus  = 0x0010,         // item has the keyboard focus
 111     wxODDefault   = 0x0020,         // item is the default item
 112   };
 113
 114   // virtual functions to implement drawing (return TRUE if processed)
 115   virtual bool OnMeasureItem(size_t *pwidth, size_t *pheight);
 116   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 117
 118 protected:
 119   wxString  m_strName;      // label for a manu item
 120
 121 private:
 122   static size_t ms_nDefaultMarginWidth; // menu check mark width
 123   static size_t ms_nLastMarginWidth;    // handy for aligning all items
 124
 125   bool      m_bCheckable,   // used only for menu or check listbox items
 126             m_bOwnerDrawn;  // true if something is non standard
 127
 128   wxFont    m_font;         // font to use for drawing
 129   wxColor   m_colText,      // color ----"---"---"----
 130             m_colBack;      // background color
 131   wxBitmap  m_bmpChecked,   // bitmap to put near the item
 132             m_bmpUnchecked; // (checked is used also for 'uncheckable' items)
 133
 134   size_t      m_nHeight,      // font height
 135             m_nMarginWidth; // space occupied by bitmap to the left of the item
 136 };
 137
 138 #endif
 139   // _OWNERDRW_H