added wxConvFileName which is a variable, not define as wxConvFile; added comments...

[wxWidgets.git] / include / wx / ownerdrw.h

diff --git a/include/wx/ownerdrw.h b/include/wx/ownerdrw.h
index 5a742f3dda790cece7e2ddd628b67b78a5b3ff51..46ddedab28407e0cf29ee79fa113bbb2ee9239a4 100644 (file)
--- a/include/wx/ownerdrw.h
+++ b/include/wx/ownerdrw.h
@@ -2,23 +2,27 @@
 // Name:        ownerdrw.h
 // Purpose:     interface for owner-drawn GUI elements
 // Author:      Vadim Zeitlin
 // Name:        ownerdrw.h
 // Purpose:     interface for owner-drawn GUI elements
 // Author:      Vadim Zeitlin

-// Modified by: 
+// Modified by:

 // Created:     11.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     11.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _OWNERDRW_H
 #define   _OWNERDRW_H
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _OWNERDRW_H
 #define   _OWNERDRW_H
 

-#ifdef    __GNUG__
-#pragma interface "ownerdrw.h"
+#include "wx/defs.h"
+
+#if wxUSE_OWNER_DRAWN
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "ownerdrw.h"

 #endif
 
 #endif
 

-// No, don't do this: BC++ 5 complains that size_t already been defined.
-// typedef   unsigned int  size_t;
-#include <stddef.h>
+#include "wx/bitmap.h"
+#include "wx/colour.h"
+#include "wx/font.h"

 
 // ----------------------------------------------------------------------------
 // wxOwnerDrawn - a mix-in base class, derive from it to implement owner-drawn
 
 // ----------------------------------------------------------------------------
 // wxOwnerDrawn - a mix-in base class, derive from it to implement owner-drawn


@@ -28,40 +32,52 @@
 // also supports 3 bitmaps: either a checked/unchecked bitmap for a checkable
 // element or one unchangeable bitmap otherwise.
 // ----------------------------------------------------------------------------
 // also supports 3 bitmaps: either a checked/unchecked bitmap for a checkable
 // element or one unchangeable bitmap otherwise.
 // ----------------------------------------------------------------------------

+

 class WXDLLEXPORT wxOwnerDrawn
 {
 public:
   // ctor & dtor
 class WXDLLEXPORT wxOwnerDrawn
 {
 public:
   // ctor & dtor

-  wxOwnerDrawn(const wxString& str = "",
-               bool bCheckable = FALSE,
-               bool bMenuItem = FALSE); // @@ kludge for colors
+  wxOwnerDrawn(const wxString& str = wxEmptyString,
+               bool bCheckable = false,
+               bool bMenuItem = false); // FIXME kludge for colors

   virtual ~wxOwnerDrawn() { }
 
   // fix appearance
   virtual ~wxOwnerDrawn() { }
 
   // fix appearance

-  inline void SetFont(const wxFont& font)
-  { m_font = font; m_bOwnerDrawn = TRUE; }
+  void SetFont(const wxFont& font)
+      { m_font = font; m_bOwnerDrawn = true; }
+
+  wxFont& GetFont() const { return (wxFont &)m_font; }
+
+  void SetTextColour(const wxColour& colText)
+      { m_colText = colText; m_bOwnerDrawn = true; }
+
+  wxColour& GetTextColour() const { return (wxColour&) m_colText; }

 
 

-  inline wxFont& GetFont() const { return (wxFont &)m_font; }
+  void SetBackgroundColour(const wxColour& colBack)
+      { m_colBack = colBack; m_bOwnerDrawn = true; }

 
 

-  inline void SetTextColour(const wxColour& colText)
-  { m_colText = colText; m_bOwnerDrawn = TRUE; }
+  wxColour& GetBackgroundColour() const
+      { return (wxColour&) m_colBack ; }

 
 

-  inline wxColour& GetTextColour() const { return (wxColour&) m_colText; }
+  void SetBitmaps(const wxBitmap& bmpChecked,
+                  const wxBitmap& bmpUnchecked = wxNullBitmap)
+      { m_bmpChecked = bmpChecked;
+        m_bmpUnchecked = bmpUnchecked;
+        m_bOwnerDrawn = true; }

 
 

-  inline void SetBackgroundColour(const wxColour& colBack)
-  { m_colBack = colBack; m_bOwnerDrawn = TRUE; }
+  void SetBitmap(const wxBitmap& bmpChecked)
+      { m_bmpChecked = bmpChecked;
+        m_bOwnerDrawn = true; }

 
 

-  inline wxColour& GetBackgroundColour() const
-  { return (wxColour&) m_colBack ; }
+  void SetDisabledBitmap( const wxBitmap& bmpDisabled )
+      { m_bmpDisabled = bmpDisabled;
+        m_bOwnerDrawn = true; }

 
 

-  inline void SetBitmaps(const wxBitmap& bmpChecked, 
-                         const wxBitmap& bmpUnchecked = wxNullBitmap)
-  { m_bmpChecked = bmpChecked;
-    m_bmpUnchecked = bmpUnchecked; 
-    m_bOwnerDrawn = TRUE;          }
+  const wxBitmap& GetBitmap(bool bChecked = true) const
+      { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }

 
 

-  inline const wxBitmap& GetBitmap(bool bChecked = TRUE) const
-  { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }
+  const wxBitmap& GetDisabledBitmap() const
+      { return m_bmpDisabled; }

 
   // 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
 
   // 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


@@ -69,34 +85,45 @@ public:
   // the last item (and default width for the first one).
   //
   // NB: default is too small for bitmaps, but ok for checkmarks.
   // 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 = (size_t) nWidth;
-    if ( ((size_t) nWidth) != ms_nDefaultMarginWidth ) m_bOwnerDrawn = TRUE; }
+  void SetMarginWidth(int nWidth)
+  {
+      ms_nLastMarginWidth = m_nMarginWidth = (size_t) nWidth;
+      if ( ((size_t) nWidth) != ms_nDefaultMarginWidth )
+          m_bOwnerDrawn = true;
+  }

 
 

-  inline int GetMarginWidth() const { return (int) m_nMarginWidth; }
-  inline static int GetDefaultMarginWidth() { return (int) ms_nDefaultMarginWidth; }
+  int GetMarginWidth() const { return (int) m_nMarginWidth; }
+  static int GetDefaultMarginWidth() { return (int) ms_nDefaultMarginWidth; }

 
   // accessors
 
   // accessors

-  void            SetName(const wxString& strName)  { m_strName = strName; }
-  const wxString& GetName()       const             { return m_strName;    }
-  bool            IsCheckable()   const             { return m_bCheckable; }
+  void SetName(const wxString& strName)  { m_strName = strName; }
+  const wxString& GetName() const { return m_strName;    }
+  void SetCheckable(bool checkable) { m_bCheckable = checkable; }
+  bool IsCheckable() const { return m_bCheckable; }
+
+  // this is for menu items only: accel string is drawn right aligned after the
+  // menu item if not empty
+  void SetAccelString(const wxString& strAccel) { m_strAccel = strAccel; }

 
 

-  // this function might seem strange, but if it returns FALSE it means that
+  // 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
   // 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
+  // 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)
   // 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;  }
+  bool IsOwnerDrawn() const { return m_bOwnerDrawn;   }
+
+  // switch on/off owner-drawing the item
+  void SetOwnerDrawn(bool ownerDrawn = true) { m_bOwnerDrawn = ownerDrawn; }
+  void ResetOwnerDrawn() { m_bOwnerDrawn = false;  }

 
 public:
   // constants used in OnDrawItem
   // (they have the same values as corresponding Win32 constants)
   enum wxODAction
 
 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)
     wxODDrawAll       = 0x0001,   // redraw entire control
     wxODSelectChanged = 0x0002,   // selection changed (see Status.Select)

-    wxODFocusChanged  = 0x0004,   // keyboard focus changed (see Status.Focus)
+    wxODFocusChanged  = 0x0004    // keyboard focus changed (see Status.Focus)

   };
 
   enum wxODStatus
   };
 
   enum wxODStatus


@@ -107,14 +134,16 @@ public:
     wxODChecked   = 0x0008,         // item is to be checked
     wxODHasFocus  = 0x0010,         // item has the keyboard focus
     wxODDefault   = 0x0020,         // item is the default item
     wxODChecked   = 0x0008,         // item is to be checked
     wxODHasFocus  = 0x0010,         // item has the keyboard focus
     wxODDefault   = 0x0020,         // item is the default item

+    wxODHidePrefix= 0x0100          // hide keyboard cues (w2k and xp only)

   };
 
   };
 

-  // virtual functions to implement drawing (return TRUE if processed)
+  // virtual functions to implement drawing (return true if processed)

   virtual bool OnMeasureItem(size_t *pwidth, size_t *pheight);
   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 
 protected:
   virtual bool OnMeasureItem(size_t *pwidth, size_t *pheight);
   virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 
 protected:

-  wxString  m_strName;      // label for a manu item
+  wxString  m_strName,      // label for a manu item
+            m_strAccel;     // the accel string ("Ctrl-F17") if any

 
 private:
   static size_t ms_nDefaultMarginWidth; // menu check mark width
 
 private:
   static size_t ms_nDefaultMarginWidth; // menu check mark width


@@ -124,14 +153,18 @@ private:
             m_bOwnerDrawn;  // true if something is non standard
 
   wxFont    m_font;         // font to use for drawing
             m_bOwnerDrawn;  // true if something is non standard
 
   wxFont    m_font;         // font to use for drawing

-  wxColour   m_colText,      // color ----"---"---"----
+  wxColour  m_colText,      // color ----"---"---"----

             m_colBack;      // background color
   wxBitmap  m_bmpChecked,   // bitmap to put near the item
             m_colBack;      // background color
   wxBitmap  m_bmpChecked,   // bitmap to put near the item

-            m_bmpUnchecked; // (checked is used also for 'uncheckable' items)
+            m_bmpUnchecked, // (checked is used also for 'uncheckable' items)
+            m_bmpDisabled;

 
 

-  size_t      m_nHeight,      // font height
+  size_t    m_nHeight,      // font height
+            m_nMinHeight,   // minimum height, as determined by user's system settings

             m_nMarginWidth; // space occupied by bitmap to the left of the item
 };
 
             m_nMarginWidth; // space occupied by bitmap to the left of the item
 };
 

+#endif // wxUSE_OWNER_DRAWN
+

 #endif
   // _OWNERDRW_H
 #endif
   // _OWNERDRW_H