//---------------------------------------------------------------------------
%newgroup;
-
-%{
- DECLARE_DEF_STRING(ButtonNameStr);
-%}
+MAKE_CONST_WXSTRING(ButtonNameStr);
enum {
wxBU_LEFT,
//---------------------------------------------------------------------------
-// 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.
-//
-// 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.
-//
+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
+ 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.
+");
+
class wxButton : public wxControl
{
public:
%addtofunc wxButton() ""
- // Constructor, creating and showing a button.
- //
- // parent: Parent window. Must not be None.
- // id: Button identifier. A value of -1 indicates a default value.
- // label: The text to be displayed on the button.
- // pos: The button position on it's parent.
- // size: Button size. If the default size (-1, -1) is specified then the
- // button is sized appropriately for the text.
- // style: Window style. See wxButton.
- // validator: Window validator.
- // name: Window name.
+ DocStr(wxButton, "Create and show a button.");
+ RefDoc(wxButton, "");
wxButton(wxWindow* parent, wxWindowID id, const wxString& label,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxPyButtonNameStr);
- // Default constructor
+ DocStr(wxButton(), "Precreate a Button for 2-phase creation.");
%name(PreButton)wxButton();
- // Button creation function for two-step creation.
+ 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,
const wxString& name = wxPyButtonNameStr);
- // This sets the button to be the default item for the panel or dialog box.
- //
- // Under Windows, only dialog box buttons respond to this function. As
- // normal under Windows and Motif, pressing return causes the default
- // button to be depressed when the return key is pressed. See also
- // wxWindow.SetFocus which sets the keyboard focus for windows and text
- // panel items, and wxPanel.SetDefaultItem.
+ DocStr(SetDefault, "This sets the button to be the default item for the panel or dialog box.");
void SetDefault();
void SetImageMargins(wxCoord x, wxCoord y);
#endif
- // returns the default button size for this platform
+ DocStr(GetDefaultButtonSize, "Returns the default button size for this platform.");
static wxSize GetDefaultSize();
};
//---------------------------------------------------------------------------
+
+DocStr(wxBitmapButton, "A Buttont that contains a 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,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxBU_AUTODRAW,
- const wxValidator& validator = wxDefaultValidator,
+ 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);
void SetMargins(int x, int y);
projects / wxWidgets.git / blobdiff