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