The use of wxPopupWindow fo rhte autocomplete and calltip windows is

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

diff --git a/include/wx/ownerdrw.h b/include/wx/ownerdrw.h
index fa89707d20de265fecf5b6bdfdfc158d98fe85ff..f946e960ae0d6c6212f83c111e79d1bd28e2dc1f 100644 (file)
--- a/include/wx/ownerdrw.h
+++ b/include/wx/ownerdrw.h
@@ -2,7 +2,7 @@
 // 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>
@@ -12,11 +12,15 @@
 #ifndef   _OWNERDRW_H
 #define   _OWNERDRW_H
 
+#if wxUSE_OWNER_DRAWN
+
 #ifdef    __GNUG__
-#pragma interface "ownerdrw.h"
+    #pragma interface "ownerdrw.h"
 #endif
 
-#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
@@ -26,11 +30,12 @@
 // 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 wxString& str = "",
+  wxOwnerDrawn(const wxString& str = wxEmptyString,
                bool bCheckable = FALSE,
                bool bMenuItem = FALSE); // FIXME kludge for colors
   virtual ~wxOwnerDrawn() { }
@@ -52,12 +57,16 @@ public:
   wxColour& GetBackgroundColour() const
       { return (wxColour&) m_colBack ; }
 
-  void SetBitmaps(const wxBitmap& bmpChecked, 
+  void SetBitmaps(const wxBitmap& bmpChecked,
                   const wxBitmap& bmpUnchecked = wxNullBitmap)
       { m_bmpChecked = bmpChecked;
         m_bmpUnchecked = bmpUnchecked;
         m_bOwnerDrawn = TRUE; }
 
+  void SetBitmap(const wxBitmap& bmpChecked)
+      { m_bmpChecked = bmpChecked;
+        m_bOwnerDrawn = TRUE; }
+
   const wxBitmap& GetBitmap(bool bChecked = TRUE) const
       { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }
 
@@ -78,26 +87,31 @@ public:
   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; }
+  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
   // 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)
-  bool     IsOwnerDrawn()  const             { return m_bOwnerDrawn;   }
-  void     ResetOwnerDrawn()                 { m_bOwnerDrawn = FALSE;  }
+  bool IsOwnerDrawn() const { return m_bOwnerDrawn;   }
+  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)
+    wxODFocusChanged  = 0x0004    // keyboard focus changed (see Status.Focus)
   };
 
   enum wxODStatus
@@ -107,7 +121,7 @@ public:
     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
+    wxODDefault   = 0x0020          // item is the default item
   };
 
   // virtual functions to implement drawing (return TRUE if processed)
@@ -115,7 +129,8 @@ public:
   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
@@ -125,14 +140,16 @@ private:
             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_bmpUnchecked; // (checked is used also for 'uncheckable' items)
 
-  size_t      m_nHeight,      // font height
+  size_t    m_nHeight,      // font height
             m_nMarginWidth; // space occupied by bitmap to the left of the item
 };
 
+#endif // wxUSE_OWNER_DRAWN
+
 #endif
   // _OWNERDRW_H