X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1e0c87227cf6b6215d169985d2bb5d2421a74512..b65ac702f1a44c042b1057cf79acf4741d714097:/wxPython/src/_button.i diff --git a/wxPython/src/_button.i b/wxPython/src/_button.i index d858873bf2..40c92dd711 100644 --- a/wxPython/src/_button.i +++ b/wxPython/src/_button.i @@ -16,10 +16,7 @@ //--------------------------------------------------------------------------- %newgroup; - -%{ - DECLARE_DEF_STRING(ButtonNameStr); -%} +MAKE_CONST_WXSTRING(ButtonNameStr); enum { wxBU_LEFT, @@ -34,65 +31,77 @@ enum { //--------------------------------------------------------------------------- DocStr(wxButton, - "A button is a control that contains a text string, and is one of the most\n" - "common elements of a GUI. It may be placed on a dialog box or panel, or\n" - "indeed almost any other window."); - -RefDoc(wxButton, " - Styles - wxBU_LEFT: Left-justifies the label. WIN32 only. - wxBU_TOP: Aligns the label to the top of the button. WIN32 only. - wxBU_RIGHT: Right-justifies the bitmap label. WIN32 only. - wxBU_BOTTOM: Aligns the label to the bottom of the button. WIN32 only. - wxBU_EXACTFIT: Creates the button as small as possible instead of making - it of the standard size (which is the default behaviour.) - - Events - EVT_BUTTON(win,id,func): - Sent when the button is clicked. +"A button is a control that contains a text string, and is one of the most +common elements of a GUI. It may be placed on a dialog box or panel, or +indeed almost any other window. + +Window Styles +------------- + ============== ========================================== + wx.BU_LEFT Left-justifies the label. WIN32 only. + wx.BU_TOP Aligns the label to the top of the button. + WIN32 only. + wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only. + wx.BU_BOTTOM Aligns the label to the bottom of the button. + WIN32 only. + wx.BU_EXACTFIT Creates the button as small as possible + instead of making it of the standard size + (which is the default behaviour.) + ============== ========================================== + +Events +------ + ============ ========================================== + EVT_BUTTON Sent when the button is clicked. + ============ ========================================== + +:see: `wx.BitmapButton` "); class wxButton : public wxControl { public: - %addtofunc wxButton "self._setOORInfo(self)" - %addtofunc wxButton() "" - - - DocStr(wxButton, "Create and show a button.") - wxButton(wxWindow* parent, wxWindowID id, const wxString& label, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxPyButtonNameStr); - - DocStr(wxButton(), "Precreate a Button for 2-phase creation."); - %name(PreButton)wxButton(); - - DocStr(Create, "Acutally create the GUI Button for 2-phase creation."); - bool Create(wxWindow* parent, wxWindowID id, const wxString& label, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxPyButtonNameStr); - - - DocStr(SetDefault, "This sets the button to be the default item for the panel or dialog box."); - void SetDefault(); - - -#ifdef __WXMSW__ - // show the image in the button in addition to the label - void SetImageLabel(const wxBitmap& bitmap); - - // set the margins around the image - void SetImageMargins(wxCoord x, wxCoord y); -#endif - - DocStr(GetDefaultButtonSize, "Returns the default button size for this platform."); - static wxSize GetDefaultSize(); + %pythonAppend wxButton "self._setOORInfo(self)" + %pythonAppend wxButton() "" + + + RefDoc(wxButton, ""); + DocCtorStr( + wxButton(wxWindow* parent, wxWindowID id, const wxString& label, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxPyButtonNameStr), + "Create and show a button."); + + DocCtorStrName( + wxButton(), + "Precreate a Button for 2-phase creation.", + PreButton); + + DocDeclStr( + bool , Create(wxWindow* parent, wxWindowID id, const wxString& label, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxPyButtonNameStr), + "Acutally create the GUI Button for 2-phase creation."); + + + + DocDeclStr( + void , SetDefault(), + "This sets the button to be the default item for the panel or dialog box."); + + + DocDeclStr( + static wxSize , GetDefaultSize(), + "Returns the default button size for this platform."); + + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); }; @@ -100,58 +109,111 @@ public: //--------------------------------------------------------------------------- -DocStr(wxBitmapButton, "A Buttont that contains a bitmap."); +DocStr(wxBitmapButton, +"A Button that contains a bitmap. A bitmap button can be supplied with a +single bitmap, and wxWidgets will draw all button states using this bitmap. If +the application needs more control, additional bitmaps for the selected state, +unpressed focused state, and greyed-out state may be supplied. + +Window Styles +------------- + ============== ============================================= + wx.BU_AUTODRAW If this is specified, the button will be drawn + automatically using the label bitmap only, + providing a 3D-look border. If this style is + not specified, the button will be drawn + without borders and using all provided + bitmaps. WIN32 only. + wx.BU_LEFT Left-justifies the label. WIN32 only. + wx.BU_TOP Aligns the label to the top of the button. WIN32 + only. + wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only. + wx.BU_BOTTOM Aligns the label to the bottom of the + button. WIN32 only. + wx.BU_EXACTFIT Creates the button as small as possible + instead of making it of the standard size + (which is the default behaviour.) + ============== ============================================= + +Events +------ + =========== ================================== + EVT_BUTTON Sent when the button is clicked. + =========== ================================== + +:see: `wx.Button`, `wx.Bitmap` +"); class wxBitmapButton : public wxButton { public: - %addtofunc wxBitmapButton "self._setOORInfo(self)" - %addtofunc wxBitmapButton() "" - - DocStr(wxBitmapButton, "Create and show a button.") - wxBitmapButton(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxBU_AUTODRAW, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxPyButtonNameStr); - - DocStr(wxBitmapButton(), "Precreate a BitmapButton for 2-phase creation."); - %name(PreBitmapButton)wxBitmapButton(); - - DocStr(Create, "Acutally create the GUI BitmapButton for 2-phase creation."); - bool Create(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap, + %pythonAppend wxBitmapButton "self._setOORInfo(self)" + %pythonAppend wxBitmapButton() "" + + RefDoc(wxBitmapButton, ""); // turn it off for the ctors + + DocCtorStr( + wxBitmapButton(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxBU_AUTODRAW, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxPyButtonNameStr), + "Create and show a button with a bitmap for the label."); + + DocCtorStrName( + wxBitmapButton(), + "Precreate a BitmapButton for 2-phase creation.", + PreBitmapButton); + + DocDeclStr( + bool , Create(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxBU_AUTODRAW, const wxValidator& validator = wxDefaultValidator, - const wxString& name = wxPyButtonNameStr); - - DocStr(GetBitmapLabel, "Returns the label bitmap (the one passed to the constructor)."); - wxBitmap GetBitmapLabel(); - - DocStr(GetBitmapDisabled, "Returns the bitmap for the disabled state."); - wxBitmap GetBitmapDisabled(); - - DocStr(GetBitmapFocus, "Returns the bitmap for the focused state."); - wxBitmap GetBitmapFocus(); - - DocStr(GetBitmapSelected, "Returns the bitmap for the selected state."); - wxBitmap GetBitmapSelected(); - - DocStr(SetBitmapDisabled, "Sets the bitmap for the disabled button appearance."); - void SetBitmapDisabled(const wxBitmap& bitmap); - - DocStr(SetBitmapFocus, "Sets the bitmap for the button appearance when it has the keyboard focus."); - void SetBitmapFocus(const wxBitmap& bitmap); - - DocStr(SetBitmapSelected, "Sets the bitmap for the selected (depressed) button appearance."); - void SetBitmapSelected(const wxBitmap& bitmap); - - DocStr(SetBitmapLabel, - "Sets the bitmap label for the button. This is the bitmap used for the\n" - "unselected state, and for all other states if no other bitmaps are provided."); - void SetBitmapLabel(const wxBitmap& bitmap); + const wxString& name = wxPyButtonNameStr), + "Acutally create the GUI BitmapButton for 2-phase creation."); + + + DocDeclStr( + wxBitmap , GetBitmapLabel(), + "Returns the label bitmap (the one passed to the constructor)."); + + DocDeclStr( + wxBitmap , GetBitmapDisabled(), + "Returns the bitmap for the disabled state."); + + DocDeclStr( + wxBitmap , GetBitmapFocus(), + "Returns the bitmap for the focused state."); + + + DocDeclStr( + wxBitmap , GetBitmapSelected(), + "Returns the bitmap for the selected state."); + + + DocDeclStr( + void , SetBitmapDisabled(const wxBitmap& bitmap), + "Sets the bitmap for the disabled button appearance."); + + + DocDeclStr( + void , SetBitmapFocus(const wxBitmap& bitmap), + "Sets the bitmap for the button appearance when it has the keyboard focus."); + + + DocDeclStr( + void , SetBitmapSelected(const wxBitmap& bitmap), + "Sets the bitmap for the selected (depressed) button appearance."); + + + DocDeclStr( + void , SetBitmapLabel(const wxBitmap& bitmap), + "Sets the bitmap label for the button. This is the bitmap used for the +unselected state, and for all other states if no other bitmaps are provided."); + void SetMargins(int x, int y); int GetMarginX() const;