*** empty log message ***

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@24 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
1998-05-22 17:09:19 +00:00 · 1998-05-22 17:09:19 +00:00 · f6bf3066bb
commit f6bf3066bb
parent 99025f6e18
1 changed files with 131 additions and 0 deletions
--- a/include/wx/ownerdrw.h
+++ b/include/wx/ownerdrw.h
@ -0,0 +1,131 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        ownerdrw.h
+// Purpose:     interface for owner-drawn GUI elements
+// Author:      Vadim Zeitlin
+// Modified by: 
+// Created:     11.11.97
+// RCS-ID:      $Id$
+// Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
+// Licence:     wxWindows license
+///////////////////////////////////////////////////////////////////////////////
+
+#ifndef   _OWNERDRW_H
+#define   _OWNERDRW_H
+
+typedef   wxColour      wxColor;
+typedef   unsigned int  uint;
+
+// ----------------------------------------------------------------------------
+// wxOwnerDrawn - a mix-in base class, derive from it to implement owner-drawn
+//                behaviour
+//
+// wxOwnerDrawn supports drawing of an item with non standard font, color and
+// also supports 3 bitmaps: either a checked/unchecked bitmap for a checkable
+// element or one unchangeable bitmap otherwise.
+// ----------------------------------------------------------------------------
+class WXDLLEXPORT wxOwnerDrawn
+{
+public:
+  // ctor & dtor
+  wxOwnerDrawn(const wxTString& str = "",
+                        bool bCheckable = FALSE,
+                        bool bMenuItem = FALSE); // ## kludge for colors
+  virtual ~wxOwnerDrawn() { }
+
+  // fix appearance
+  inline void SetFont(const wxFont& font)
+  { m_font = font; m_bOwnerDrawn = TRUE; }
+
+  inline wxFont& GetFont() const { return (wxFont &)m_font; }
+
+  inline void SetTextColour(const wxColour& colText)
+  { m_colText = colText; m_bOwnerDrawn = TRUE; }
+
+  inline wxColour& GetTextColour() const { return (wxColour&) m_colText; }
+
+  inline void SetBackgroundColour(const wxColour& colBack)
+  { m_colBack = colBack; m_bOwnerDrawn = TRUE; }
+
+  inline wxColour& GetBackgroundColour() const
+  { return (wxColour&) m_colBack ; }
+
+  inline void SetBitmaps(const wxBitmap& bmpChecked, 
+                         const wxBitmap& bmpUnchecked = wxNullBitmap)
+  { m_bmpChecked = bmpChecked;
+    m_bmpUnchecked = bmpUnchecked; 
+    m_bOwnerDrawn = TRUE;          }
+
+  inline wxBitmap& GetBitmap(bool bChecked = TRUE) const
+  { return (wxBitmap &)(bChecked ? m_bmpChecked : m_bmpUnchecked); }
+
+  // the height of the menu checkmark (or bitmap) is determined by the font
+  // for the current item, but the width should be always the same (for the
+  // items to be aligned), so by default it's taken to be the same as for
+  // the last item (and default width for the first one).
+  //
+  // NB: default is too small for bitmaps, but ok for checkmarks.
+  inline void SetMarginWidth(int nWidth)
+  { ms_nLastMarginWidth = m_nMarginWidth = (uint) nWidth;
+    if ( ((uint) nWidth) != ms_nDefaultMarginWidth ) m_bOwnerDrawn = TRUE; }
+
+  inline int GetMarginWidth() const { return (int) m_nMarginWidth; }
+  inline static int GetDefaultMarginWidth() { return (int) ms_nDefaultMarginWidth; }
+
+  // accessors
+  void            SetName(const wxString& strName)  { m_strName = strName; }
+  const wxString& GetName()       const             { return m_strName;    }
+  bool            IsCheckable()   const             { return m_bCheckable; }
+
+  // this function might seem strange, but if it returns FALSE it means that
+  // no non-standard attribute are set, so there is no need for this control
+  // to be owner-drawn. Moreover, you can force owner-drawn to FALSE if you
+  // want to change, say, the color for the item but only if it is owner-drawn
+  // (see wxMenuItem::wxMenuItem for example)
+  inline bool     IsOwnerDrawn()  const             { return m_bOwnerDrawn;   }
+  inline void     ResetOwnerDrawn()                 { m_bOwnerDrawn = FALSE;  }
+
+public:
+  // constants used in OnDrawItem
+  // (they have the same values as corresponding Win32 constants)
+  enum wxODAction
+  { 
+    wxODDrawAll       = 0x0001,   // redraw entire control
+    wxODSelectChanged = 0x0002,   // selection changed (see Status.Select)
+    wxODFocusChanged  = 0x0004,   // keyboard focus changed (see Status.Focus)
+  };
+
+  enum wxODStatus
+  {
+    wxODSelected  = 0x0001,         // control is currently selected
+    wxODGrayed    = 0x0002,         // item is to be grayed
+    wxODDisabled  = 0x0004,         // item is to be drawn as disabled
+    wxODChecked   = 0x0008,         // item is to be checked
+    wxODHasFocus  = 0x0010,         // item has the keyboard focus
+    wxODDefault   = 0x0020,         // item is the default item
+  };
+
+  // virtual functions to implement drawing (return TRUE if processed)
+  virtual bool OnMeasureItem(uint *pwidth, uint *pheight);
+  virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
+
+protected:
+  wxString  m_strName;      // label for a manu item
+
+private:
+  static uint ms_nDefaultMarginWidth; // menu check mark width
+  static uint ms_nLastMarginWidth;    // handy for aligning all items
+
+  bool      m_bCheckable,   // used only for menu or check listbox items
+            m_bOwnerDrawn;  // true if something is non standard
+
+  wxFont    m_font;         // font to use for drawing
+  wxColor   m_colText,      // color ----"---"---"----
+            m_colBack;      // background color
+  wxBitmap  m_bmpChecked,   // bitmap to put near the item
+            m_bmpUnchecked; // (checked is used also for 'uncheckable' items)
+
+  uint      m_nHeight,      // font height
+            m_nMarginWidth; // space occupied by bitmap to the left of the item
+};
+
+#endif  //_OWNERDRW_H