include/wx/bmpbuttn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/bmpbutton.h
   3 // Purpose:     wxBitmapButton class interface
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     25.08.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 Vadim Zeitlin
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BMPBUTTON_H_BASE_
  13 #define _WX_BMPBUTTON_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_BMPBUTTON
  18
  19 #include "wx/bitmap.h"
  20 #include "wx/button.h"
  21
  22 WXDLLEXPORT_DATA(extern const wxChar*) wxButtonNameStr;
  23
  24 // ----------------------------------------------------------------------------
  25 // wxBitmapButton: a button which shows bitmaps instead of the usual string.
  26 // It has different bitmaps for different states (focused/disabled/pressed)
  27 // ----------------------------------------------------------------------------
  28
  29 class WXDLLEXPORT wxBitmapButtonBase : public wxButton
  30 {
  31 public:
  32     wxBitmapButtonBase()
  33         : m_bmpNormal(), m_bmpSelected(), m_bmpFocus(), m_bmpDisabled()
  34         , m_marginX(0), m_marginY(0)
  35         { }
  36
  37     // set the bitmaps
  38     void SetBitmapLabel(const wxBitmap& bitmap)
  39         { m_bmpNormal = bitmap; OnSetBitmap(); }
  40     void SetBitmapSelected(const wxBitmap& sel)
  41         { m_bmpSelected = sel; OnSetBitmap(); };
  42     void SetBitmapFocus(const wxBitmap& focus)
  43         { m_bmpFocus = focus; OnSetBitmap(); };
  44     void SetBitmapDisabled(const wxBitmap& disabled)
  45         { m_bmpDisabled = disabled; OnSetBitmap(); };
  46     void SetLabel(const wxBitmap& bitmap)
  47         { SetBitmapLabel(bitmap); }
  48
  49     // retrieve the bitmaps
  50     const wxBitmap& GetBitmapLabel() const { return m_bmpNormal; }
  51     const wxBitmap& GetBitmapSelected() const { return m_bmpSelected; }
  52     const wxBitmap& GetBitmapFocus() const { return m_bmpFocus; }
  53     const wxBitmap& GetBitmapDisabled() const { return m_bmpDisabled; }
  54     wxBitmap& GetBitmapLabel() { return m_bmpNormal; }
  55     wxBitmap& GetBitmapSelected() { return m_bmpSelected; }
  56     wxBitmap& GetBitmapFocus() { return m_bmpFocus; }
  57     wxBitmap& GetBitmapDisabled() { return m_bmpDisabled; }
  58
  59     // set/get the margins around the button
  60     virtual void SetMargins(int x, int y) { m_marginX = x; m_marginY = y; }
  61     int GetMarginX() const { return m_marginX; }
  62     int GetMarginY() const { return m_marginY; }
  63
  64     virtual void ApplyParentThemeBackground(const wxColour& bg)
  65         { SetBackgroundColour(bg); }
  66
  67
  68 protected:
  69     // function called when any of the bitmaps changes
  70     virtual void OnSetBitmap() { }
  71
  72     // the bitmaps for various states
  73     wxBitmap m_bmpNormal,
  74              m_bmpSelected,
  75              m_bmpFocus,
  76              m_bmpDisabled;
  77
  78     // the margins around the bitmap
  79     int m_marginX,
  80         m_marginY;
  81
  82 private:
  83     // Prevent Virtual function hiding warnings
  84     void SetLabel(const wxString& rsLabel)
  85         { wxWindowBase::SetLabel(rsLabel); }
  86
  87     DECLARE_NO_COPY_CLASS(wxBitmapButtonBase)
  88 };
  89
  90 #if defined(__WXUNIVERSAL__)
  91     #include "wx/univ/bmpbuttn.h"
  92 #elif defined(__WXMSW__)
  93     #include "wx/msw/bmpbuttn.h"
  94 #elif defined(__WXMOTIF__)
  95     #include "wx/motif/bmpbuttn.h"
  96 #elif defined(__WXGTK__)
  97     #include "wx/gtk/bmpbuttn.h"
  98 #elif defined(__WXMAC__)
  99     #include "wx/mac/bmpbuttn.h"
 100 #elif defined(__WXCOCOA__)
 101     #include "wx/cocoa/bmpbuttn.h"
 102 #elif defined(__WXPM__)
 103     #include "wx/os2/bmpbuttn.h"
 104 #endif
 105
 106 #endif // wxUSE_BMPBUTTON
 107
 108 #endif // _WX_BMPBUTTON_H_BASE_