interface/wx/anybutton.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        anybutton.h
   3 // Purpose:     interface of wxAnyButton
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id: button.h 69135 2011-09-18 04:38:01Z RD $
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 #define wxBU_LEFT            0x0040
  10 #define wxBU_TOP             0x0080
  11 #define wxBU_RIGHT           0x0100
  12 #define wxBU_BOTTOM          0x0200
  13 #define wxBU_ALIGN_MASK      ( wxBU_LEFT | wxBU_TOP | wxBU_RIGHT | wxBU_BOTTOM )
  14
  15 #define wxBU_EXACTFIT        0x0001
  16 #define wxBU_NOTEXT          0x0002
  17 #define wxBU_AUTODRAW        0x0004
  18
  19
  20 /**
  21    @class wxAnyButton
  22
  23    A class for common button functionality used as the base for the
  24    various button classes.
  25 */
  26 class wxAnyButton : public wxControl
  27 {
  28 public:
  29     wxAnyButton();
  30     ~wxAnyButton();
  31
  32     /**
  33         Return the bitmap shown by the button.
  34
  35         The returned bitmap may be invalid only if the button doesn't show any
  36         images.
  37
  38         @see SetBitmap()
  39
  40         @since 2.9.1
  41      */
  42     wxBitmap GetBitmap() const;
  43
  44     /**
  45         Returns the bitmap used when the mouse is over the button, which may be
  46         invalid.
  47
  48         @see SetBitmapCurrent()
  49
  50         @since 2.9.1 (available as wxBitmapButton::GetBitmapHover() in previous
  51             versions)
  52     */
  53     wxBitmap GetBitmapCurrent() const;
  54
  55     /**
  56         Returns the bitmap for the disabled state, which may be invalid.
  57
  58         @see SetBitmapDisabled()
  59
  60         @since 2.9.1 (available in wxBitmapButton only in previous versions)
  61     */
  62     wxBitmap GetBitmapDisabled() const;
  63
  64     /**
  65         Returns the bitmap for the focused state, which may be invalid.
  66
  67         @see SetBitmapFocus()
  68
  69         @since 2.9.1 (available in wxBitmapButton only in previous versions)
  70     */
  71     wxBitmap GetBitmapFocus() const;
  72
  73     /**
  74         Returns the bitmap for the normal state.
  75
  76         This is exactly the same as GetBitmap() but uses a name
  77         backwards-compatible with wxBitmapButton.
  78
  79         @see SetBitmap(), SetBitmapLabel()
  80
  81         @since 2.9.1 (available in wxBitmapButton only in previous versions)
  82     */
  83     wxBitmap GetBitmapLabel() const;
  84
  85     /**
  86         Returns the bitmap for the pressed state, which may be invalid.
  87
  88         @see SetBitmapPressed()
  89
  90         @since 2.9.1 (available as wxBitmapButton::GetBitmapSelected() in
  91             previous versions)
  92     */
  93     wxBitmap GetBitmapPressed() const;
  94
  95
  96     /**
  97         Sets the bitmap to display in the button.
  98
  99         The bitmap is displayed together with the button label. This method
 100         sets up a single bitmap which is used in all button states, use
 101         SetBitmapDisabled(), SetBitmapPressed(), SetBitmapCurrent() or
 102         SetBitmapFocus() to change the individual images used in different
 103         states.
 104
 105         @param bitmap
 106             The bitmap to display in the button. May be invalid to remove any
 107             currently displayed bitmap.
 108         @param dir
 109             The position of the bitmap inside the button. By default it is
 110             positioned to the left of the text, near to the left button border.
 111             Other possible values include wxRIGHT, wxTOP and wxBOTTOM.
 112
 113         @see SetBitmapPosition(), SetBitmapMargins()
 114
 115         @since 2.9.1
 116      */
 117     void SetBitmap(const wxBitmap& bitmap, wxDirection dir = wxLEFT);
 118
 119     /**
 120         Sets the bitmap to be shown when the mouse is over the button.
 121
 122         @see GetBitmapCurrent()
 123
 124         @since 2.9.1 (available as wxBitmapButton::SetBitmapHover() in previous
 125             versions)
 126     */
 127     void SetBitmapCurrent(const wxBitmap& bitmap);
 128
 129     /**
 130         Sets the bitmap for the disabled button appearance.
 131
 132         @see GetBitmapDisabled(), SetBitmapLabel(),
 133              SetBitmapPressed(), SetBitmapFocus()
 134
 135         @since 2.9.1 (available in wxBitmapButton only in previous versions)
 136     */
 137     void SetBitmapDisabled(const wxBitmap& bitmap);
 138
 139     /**
 140         Sets the bitmap for the button appearance when it has the keyboard
 141         focus.
 142
 143         @see GetBitmapFocus(), SetBitmapLabel(),
 144              SetBitmapPressed(), SetBitmapDisabled()
 145
 146         @since 2.9.1 (available in wxBitmapButton only in previous versions)
 147     */
 148     void SetBitmapFocus(const wxBitmap& bitmap);
 149
 150     /**
 151         Sets the bitmap label for the button.
 152
 153         @remarks This is the bitmap used for the unselected state, and for all
 154                  other states if no other bitmaps are provided.
 155
 156         @see SetBitmap(), GetBitmapLabel()
 157
 158         @since 2.9.1 (available in wxBitmapButton only in previous versions)
 159     */
 160     void SetBitmapLabel(const wxBitmap& bitmap);
 161
 162     /**
 163         Sets the bitmap for the selected (depressed) button appearance.
 164
 165         @since 2.9.1 (available as wxBitmapButton::SetBitmapSelected() in
 166             previous versions)
 167     */
 168     void SetBitmapPressed(const wxBitmap& bitmap);
 169
 170
 171     /**
 172         Get the margins between the bitmap and the text of the button.
 173
 174         @see SetBitmapMargins()
 175
 176         @since 2.9.1
 177      */
 178     wxSize GetBitmapMargins();
 179
 180     /**
 181         Set the margins between the bitmap and the text of the button.
 182
 183         This method is currently only implemented under MSW. If it is not
 184         called, default margin is used around the bitmap.
 185
 186         @see SetBitmap(), SetBitmapPosition()
 187
 188         @since 2.9.1
 189      */
 190     //@{
 191     void SetBitmapMargins(wxCoord x, wxCoord y);
 192     void SetBitmapMargins(const wxSize& sz);
 193     //@}
 194
 195     /**
 196         Set the position at which the bitmap is displayed.
 197
 198         This method should only be called if the button does have an associated
 199         bitmap.
 200
 201         @since 2.9.1
 202
 203         @param dir
 204             Direction in which the bitmap should be positioned, one of wxLEFT,
 205             wxRIGHT, wxTOP or wxBOTTOM.
 206      */
 207     void SetBitmapPosition(wxDirection dir);
 208 };
 209