X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c2dcfdef634e097f7efe2288aa13511efb43ae28..5687a67ce1e365d010c6282aa57b4f99f7f5ea29:/include/wx/ownerdrw.h diff --git a/include/wx/ownerdrw.h b/include/wx/ownerdrw.h index fa89707d20..a8b5a1b8ad 100644 --- a/include/wx/ownerdrw.h +++ b/include/wx/ownerdrw.h @@ -2,21 +2,25 @@ // 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 -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _OWNERDRW_H #define _OWNERDRW_H -#ifdef __GNUG__ -#pragma interface "ownerdrw.h" +#if wxUSE_OWNER_DRAWN + +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) + #pragma interface "ownerdrw.h" #endif -#include +#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,41 +30,53 @@ // 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 = "", - bool bCheckable = FALSE, - bool bMenuItem = FALSE); // FIXME kludge for colors + wxOwnerDrawn(const wxString& str = wxEmptyString, + bool bCheckable = false, + bool bMenuItem = false); // FIXME kludge for colors virtual ~wxOwnerDrawn() { } // fix appearance void SetFont(const wxFont& font) - { m_font = font; m_bOwnerDrawn = TRUE; } + { m_font = font; m_bOwnerDrawn = true; } wxFont& GetFont() const { return (wxFont &)m_font; } void SetTextColour(const wxColour& colText) - { m_colText = colText; m_bOwnerDrawn = TRUE; } + { m_colText = colText; m_bOwnerDrawn = true; } wxColour& GetTextColour() const { return (wxColour&) m_colText; } void SetBackgroundColour(const wxColour& colBack) - { m_colBack = colBack; m_bOwnerDrawn = TRUE; } + { m_colBack = colBack; m_bOwnerDrawn = true; } 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; } + m_bOwnerDrawn = true; } + + void SetBitmap(const wxBitmap& bmpChecked) + { m_bmpChecked = bmpChecked; + m_bOwnerDrawn = true; } + + void SetDisabledBitmap( const wxBitmap& bmpDisabled ) + { m_bmpDisabled = bmpDisabled; + m_bOwnerDrawn = true; } - const wxBitmap& GetBitmap(bool bChecked = TRUE) const + 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 // items to be aligned), so by default it's taken to be the same as for @@ -71,33 +87,41 @@ public: { ms_nLastMarginWidth = m_nMarginWidth = (size_t) nWidth; if ( ((size_t) nWidth) != ms_nDefaultMarginWidth ) - m_bOwnerDrawn = TRUE; + m_bOwnerDrawn = true; } int GetMarginWidth() const { return (int) m_nMarginWidth; } 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 + // 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 + // 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; } + + // 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 - { + { 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,15 +131,16 @@ 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) + // 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: - 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 +150,18 @@ 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) + 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 }; +#endif // wxUSE_OWNER_DRAWN + #endif // _OWNERDRW_H