| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: wx/button.h |
| 3 | // Purpose: wxButtonBase class |
| 4 | // Author: Vadim Zetlin |
| 5 | // Modified by: |
| 6 | // Created: 15.08.00 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) Vadim Zetlin |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_BUTTON_H_BASE_ |
| 13 | #define _WX_BUTTON_H_BASE_ |
| 14 | |
| 15 | #include "wx/defs.h" |
| 16 | |
| 17 | // ---------------------------------------------------------------------------- |
| 18 | // wxButton flags shared with other classes |
| 19 | // ---------------------------------------------------------------------------- |
| 20 | |
| 21 | #if wxUSE_TOGGLEBTN || wxUSE_BUTTON |
| 22 | |
| 23 | // These flags affect label alignment |
| 24 | #define wxBU_LEFT 0x0040 |
| 25 | #define wxBU_TOP 0x0080 |
| 26 | #define wxBU_RIGHT 0x0100 |
| 27 | #define wxBU_BOTTOM 0x0200 |
| 28 | #define wxBU_ALIGN_MASK ( wxBU_LEFT | wxBU_TOP | wxBU_RIGHT | wxBU_BOTTOM ) |
| 29 | #endif |
| 30 | |
| 31 | #if wxUSE_BUTTON |
| 32 | |
| 33 | // ---------------------------------------------------------------------------- |
| 34 | // wxButton specific flags |
| 35 | // ---------------------------------------------------------------------------- |
| 36 | |
| 37 | // These two flags are obsolete |
| 38 | #define wxBU_NOAUTODRAW 0x0000 |
| 39 | #define wxBU_AUTODRAW 0x0004 |
| 40 | |
| 41 | // by default, the buttons will be created with some (system dependent) |
| 42 | // minimal size to make them look nicer, giving this style will make them as |
| 43 | // small as possible |
| 44 | #define wxBU_EXACTFIT 0x0001 |
| 45 | |
| 46 | // this flag can be used to disable using the text label in the button: it is |
| 47 | // mostly useful when creating buttons showing bitmap and having stock id as |
| 48 | // without it both the standard label corresponding to the stock id and the |
| 49 | // bitmap would be shown |
| 50 | #define wxBU_NOTEXT 0x0002 |
| 51 | |
| 52 | |
| 53 | #include "wx/bitmap.h" |
| 54 | #include "wx/control.h" |
| 55 | |
| 56 | extern WXDLLIMPEXP_DATA_CORE(const char) wxButtonNameStr[]; |
| 57 | |
| 58 | // ---------------------------------------------------------------------------- |
| 59 | // wxButton: a push button |
| 60 | // ---------------------------------------------------------------------------- |
| 61 | |
| 62 | class WXDLLIMPEXP_CORE wxButtonBase : public wxControl |
| 63 | { |
| 64 | public: |
| 65 | wxButtonBase() { } |
| 66 | |
| 67 | // show the authentication needed symbol on the button: this is currently |
| 68 | // only implemented on Windows Vista and newer (on which it shows the UAC |
| 69 | // shield symbol) |
| 70 | void SetAuthNeeded(bool show = true) { DoSetAuthNeeded(show); } |
| 71 | bool GetAuthNeeded() const { return DoGetAuthNeeded(); } |
| 72 | |
| 73 | // show the image in the button in addition to the label: this method is |
| 74 | // supported on all (major) platforms |
| 75 | void SetBitmap(const wxBitmap& bitmap, wxDirection dir = wxLEFT) |
| 76 | { |
| 77 | SetBitmapLabel(bitmap); |
| 78 | SetBitmapPosition(dir); |
| 79 | } |
| 80 | |
| 81 | wxBitmap GetBitmap() const { return DoGetBitmap(State_Normal); } |
| 82 | |
| 83 | // Methods for setting individual images for different states: normal, |
| 84 | // selected (meaning pushed or pressed), focused (meaning normal state for |
| 85 | // a focused button), disabled or hover (a.k.a. hot or current). |
| 86 | // |
| 87 | // Remember that SetBitmap() itself must be called before any other |
| 88 | // SetBitmapXXX() methods (except for SetBitmapLabel() which is a synonym |
| 89 | // for it anyhow) and that all bitmaps passed to these functions should be |
| 90 | // of the same size. |
| 91 | void SetBitmapLabel(const wxBitmap& bitmap) |
| 92 | { DoSetBitmap(bitmap, State_Normal); } |
| 93 | void SetBitmapPressed(const wxBitmap& bitmap) |
| 94 | { DoSetBitmap(bitmap, State_Pressed); } |
| 95 | void SetBitmapDisabled(const wxBitmap& bitmap) |
| 96 | { DoSetBitmap(bitmap, State_Disabled); } |
| 97 | void SetBitmapCurrent(const wxBitmap& bitmap) |
| 98 | { DoSetBitmap(bitmap, State_Current); } |
| 99 | void SetBitmapFocus(const wxBitmap& bitmap) |
| 100 | { DoSetBitmap(bitmap, State_Focused); } |
| 101 | |
| 102 | wxBitmap GetBitmapLabel() const { return DoGetBitmap(State_Normal); } |
| 103 | wxBitmap GetBitmapPressed() const { return DoGetBitmap(State_Pressed); } |
| 104 | wxBitmap GetBitmapDisabled() const { return DoGetBitmap(State_Disabled); } |
| 105 | wxBitmap GetBitmapCurrent() const { return DoGetBitmap(State_Current); } |
| 106 | wxBitmap GetBitmapFocus() const { return DoGetBitmap(State_Focused); } |
| 107 | |
| 108 | |
| 109 | // set the margins around the image |
| 110 | void SetBitmapMargins(wxCoord x, wxCoord y) { DoSetBitmapMargins(x, y); } |
| 111 | void SetBitmapMargins(const wxSize& sz) { DoSetBitmapMargins(sz.x, sz.y); } |
| 112 | wxSize GetBitmapMargins() { return DoGetBitmapMargins(); } |
| 113 | |
| 114 | // set the image position relative to the text, i.e. wxLEFT means that the |
| 115 | // image is to the left of the text (this is the default) |
| 116 | void SetBitmapPosition(wxDirection dir); |
| 117 | |
| 118 | |
| 119 | // make this button the default button in its top level window |
| 120 | // |
| 121 | // returns the old default item (possibly NULL) |
| 122 | virtual wxWindow *SetDefault(); |
| 123 | |
| 124 | // Buttons on MSW can look bad if they are not native colours, because |
| 125 | // then they become owner-drawn and not theme-drawn. Disable it here |
| 126 | // in wxButtonBase to make it consistent. |
| 127 | virtual bool ShouldInheritColours() const { return false; } |
| 128 | |
| 129 | // returns the default button size for this platform |
| 130 | static wxSize GetDefaultSize(); |
| 131 | |
| 132 | // wxUniv-compatible and deprecated equivalents to SetBitmapXXX() |
| 133 | #if WXWIN_COMPATIBILITY_2_8 |
| 134 | void SetImageLabel(const wxBitmap& bitmap) { SetBitmap(bitmap); } |
| 135 | void SetImageMargins(wxCoord x, wxCoord y) { SetBitmapMargins(x, y); } |
| 136 | #endif // WXWIN_COMPATIBILITY_2_8 |
| 137 | |
| 138 | // backwards compatible names for pressed/current bitmaps: they're not |
| 139 | // deprecated as there is nothing really wrong with using them and no real |
| 140 | // advantage to using the new names but the new names are still preferred |
| 141 | wxBitmap GetBitmapSelected() const { return GetBitmapPressed(); } |
| 142 | wxBitmap GetBitmapHover() const { return GetBitmapCurrent(); } |
| 143 | |
| 144 | void SetBitmapSelected(const wxBitmap& bitmap) { SetBitmapPressed(bitmap); } |
| 145 | void SetBitmapHover(const wxBitmap& bitmap) { SetBitmapCurrent(bitmap); } |
| 146 | |
| 147 | |
| 148 | // this enum is not part of wx public API, it is public because it is used |
| 149 | // in non wxButton-derived classes internally |
| 150 | // |
| 151 | // also notice that MSW code relies on the values of the enum elements, do |
| 152 | // not change them without revising src/msw/button.cpp |
| 153 | enum State |
| 154 | { |
| 155 | State_Normal, |
| 156 | State_Current, // a.k.a. hot or "hovering" |
| 157 | State_Pressed, // a.k.a. "selected" in public API for some reason |
| 158 | State_Disabled, |
| 159 | State_Focused, |
| 160 | State_Max |
| 161 | }; |
| 162 | |
| 163 | // return true if this button shouldn't show the text label, either because |
| 164 | // it doesn't have it or because it was explicitly disabled with wxBU_NOTEXT |
| 165 | bool DontShowLabel() const |
| 166 | { |
| 167 | return HasFlag(wxBU_NOTEXT) || GetLabel().empty(); |
| 168 | } |
| 169 | |
| 170 | // return true if we do show the label |
| 171 | bool ShowsLabel() const |
| 172 | { |
| 173 | return !DontShowLabel(); |
| 174 | } |
| 175 | |
| 176 | protected: |
| 177 | // choose the default border for this window |
| 178 | virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } |
| 179 | |
| 180 | virtual bool DoGetAuthNeeded() const { return false; } |
| 181 | virtual void DoSetAuthNeeded(bool WXUNUSED(show)) { } |
| 182 | |
| 183 | virtual wxBitmap DoGetBitmap(State WXUNUSED(which)) const |
| 184 | { return wxBitmap(); } |
| 185 | virtual void DoSetBitmap(const wxBitmap& WXUNUSED(bitmap), |
| 186 | State WXUNUSED(which)) |
| 187 | { } |
| 188 | |
| 189 | virtual wxSize DoGetBitmapMargins() const |
| 190 | { return wxSize(0, 0); } |
| 191 | |
| 192 | virtual void DoSetBitmapMargins(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y)) |
| 193 | { } |
| 194 | |
| 195 | virtual void DoSetBitmapPosition(wxDirection WXUNUSED(dir)) |
| 196 | { } |
| 197 | |
| 198 | |
| 199 | wxDECLARE_NO_COPY_CLASS(wxButtonBase); |
| 200 | }; |
| 201 | |
| 202 | #if defined(__WXUNIVERSAL__) |
| 203 | #include "wx/univ/button.h" |
| 204 | #elif defined(__WXMSW__) |
| 205 | #include "wx/msw/button.h" |
| 206 | #elif defined(__WXMOTIF__) |
| 207 | #include "wx/motif/button.h" |
| 208 | #elif defined(__WXGTK20__) |
| 209 | #include "wx/gtk/button.h" |
| 210 | #elif defined(__WXGTK__) |
| 211 | #include "wx/gtk1/button.h" |
| 212 | #elif defined(__WXMAC__) |
| 213 | #include "wx/osx/button.h" |
| 214 | #elif defined(__WXCOCOA__) |
| 215 | #include "wx/cocoa/button.h" |
| 216 | #elif defined(__WXPM__) |
| 217 | #include "wx/os2/button.h" |
| 218 | #elif defined(__WXPALMOS__) |
| 219 | #include "wx/palmos/button.h" |
| 220 | #endif |
| 221 | |
| 222 | #endif // wxUSE_BUTTON |
| 223 | |
| 224 | #endif |
| 225 | // _WX_BUTTON_H_BASE_ |