]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_button.i
Updated layout test
[wxWidgets.git] / wxPython / src / _button.i
CommitLineData
d14a1e28
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: _button.i
3// Purpose: SWIG interface defs for wxButton, wxBitmapButton
4//
5// Author: Robin Dunn
6//
7// Created: 10-June-1998
8// RCS-ID: $Id$
9// Copyright: (c) 2003 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
13// Not a %module
14
15
16//---------------------------------------------------------------------------
17%newgroup;
18
b2dc1044 19MAKE_CONST_WXSTRING(ButtonNameStr);
d14a1e28
RD
20
21enum {
22 wxBU_LEFT,
23 wxBU_TOP,
24 wxBU_RIGHT,
25 wxBU_BOTTOM,
26
27 wxBU_EXACTFIT,
28 wxBU_AUTODRAW,
29};
30
31//---------------------------------------------------------------------------
32
1e0c8722 33DocStr(wxButton,
dce2bd22
RD
34"A button is a control that contains a text string, and is one of the most
35common elements of a GUI. It may be placed on a dialog box or panel, or
36indeed almost any other window.
37
38Window Styles
39-------------
40 ============== ==========================================
41 wx.BU_LEFT Left-justifies the label. WIN32 only.
42 wx.BU_TOP Aligns the label to the top of the button.
43 WIN32 only.
44 wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only.
45 wx.BU_BOTTOM Aligns the label to the bottom of the button.
46 WIN32 only.
47 wx.BU_EXACTFIT Creates the button as small as possible
48 instead of making it of the standard size
49 (which is the default behaviour.)
50 ============== ==========================================
51
52Events
53------
54 ============ ==========================================
55 EVT_BUTTON Sent when the button is clicked.
56 ============ ==========================================
57
58:see: `wx.BitmapButton`
1e0c8722
RD
59");
60
d14a1e28
RD
61class wxButton : public wxControl
62{
63public:
2b9048c5
RD
64 %pythonAppend wxButton "self._setOORInfo(self)"
65 %pythonAppend wxButton() ""
d14a1e28
RD
66
67
b2dc1044 68 RefDoc(wxButton, "");
dce2bd22
RD
69 DocCtorStr(
70 wxButton(wxWindow* parent, wxWindowID id, const wxString& label,
71 const wxPoint& pos = wxDefaultPosition,
72 const wxSize& size = wxDefaultSize,
73 long style = 0,
74 const wxValidator& validator = wxDefaultValidator,
75 const wxString& name = wxPyButtonNameStr),
76 "Create and show a button.");
77
78 DocCtorStrName(
79 wxButton(),
80 "Precreate a Button for 2-phase creation.",
81 PreButton);
82
83 DocDeclStr(
84 bool , Create(wxWindow* parent, wxWindowID id, const wxString& label,
85 const wxPoint& pos = wxDefaultPosition,
86 const wxSize& size = wxDefaultSize,
87 long style = 0,
88 const wxValidator& validator = wxDefaultValidator,
89 const wxString& name = wxPyButtonNameStr),
90 "Acutally create the GUI Button for 2-phase creation.");
91
d14a1e28 92
d14a1e28 93
dce2bd22
RD
94 DocDeclStr(
95 void , SetDefault(),
96 "This sets the button to be the default item for the panel or dialog box.");
97
d14a1e28 98
dce2bd22
RD
99 DocDeclStr(
100 static wxSize , GetDefaultSize(),
101 "Returns the default button size for this platform.");
d14a1e28
RD
102};
103
104
105
106//---------------------------------------------------------------------------
107
1e0c8722 108
856bf319
RD
109DocStr(wxBitmapButton,
110"A Button that contains a bitmap. A bitmap button can be supplied with a
dce2bd22 111single bitmap, and wxWidgets will draw all button states using this bitmap. If
856bf319
RD
112the application needs more control, additional bitmaps for the selected state,
113unpressed focused state, and greyed-out state may be supplied.
856bf319 114
dce2bd22
RD
115Window Styles
116-------------
117 ============== =============================================
118 wx.BU_AUTODRAW If this is specified, the button will be drawn
119 automatically using the label bitmap only,
120 providing a 3D-look border. If this style is
121 not specified, the button will be drawn
122 without borders and using all provided
856bf319 123 bitmaps. WIN32 only.
dce2bd22
RD
124 wx.BU_LEFT Left-justifies the label. WIN32 only.
125 wx.BU_TOP Aligns the label to the top of the button. WIN32
126 only.
127 wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only.
128 wx.BU_BOTTOM Aligns the label to the bottom of the
129 button. WIN32 only.
130 wx.BU_EXACTFIT Creates the button as small as possible
131 instead of making it of the standard size
132 (which is the default behaviour.)
133 ============== =============================================
134
135Events
136------
137 =========== ==================================
138 EVT_BUTTON Sent when the button is clicked.
139 =========== ==================================
140
141:see: `wx.Button`, `wx.Bitmap`
856bf319 142");
1e0c8722 143
d14a1e28
RD
144class wxBitmapButton : public wxButton
145{
146public:
2b9048c5
RD
147 %pythonAppend wxBitmapButton "self._setOORInfo(self)"
148 %pythonAppend wxBitmapButton() ""
d14a1e28 149
e029dde7 150 RefDoc(wxBitmapButton, ""); // turn it off for the ctors
dce2bd22
RD
151
152 DocCtorStr(
153 wxBitmapButton(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap,
154 const wxPoint& pos = wxDefaultPosition,
155 const wxSize& size = wxDefaultSize,
156 long style = wxBU_AUTODRAW,
157 const wxValidator& validator = wxDefaultValidator,
158 const wxString& name = wxPyButtonNameStr),
159 "Create and show a button with a bitmap for the label.");
160
161 DocCtorStrName(
162 wxBitmapButton(),
163 "Precreate a BitmapButton for 2-phase creation.",
164 PreBitmapButton);
165
166 DocDeclStr(
167 bool , Create(wxWindow* parent, wxWindowID id, const wxBitmap& bitmap,
1e0c8722
RD
168 const wxPoint& pos = wxDefaultPosition,
169 const wxSize& size = wxDefaultSize,
170 long style = wxBU_AUTODRAW,
171 const wxValidator& validator = wxDefaultValidator,
dce2bd22
RD
172 const wxString& name = wxPyButtonNameStr),
173 "Acutally create the GUI BitmapButton for 2-phase creation.");
174
1e0c8722 175
dce2bd22
RD
176 DocDeclStr(
177 wxBitmap , GetBitmapLabel(),
178 "Returns the label bitmap (the one passed to the constructor).");
179
180 DocDeclStr(
181 wxBitmap , GetBitmapDisabled(),
182 "Returns the bitmap for the disabled state.");
183
184 DocDeclStr(
185 wxBitmap , GetBitmapFocus(),
186 "Returns the bitmap for the focused state.");
187
1e0c8722 188
dce2bd22
RD
189 DocDeclStr(
190 wxBitmap , GetBitmapSelected(),
191 "Returns the bitmap for the selected state.");
192
1e0c8722 193
dce2bd22
RD
194 DocDeclStr(
195 void , SetBitmapDisabled(const wxBitmap& bitmap),
196 "Sets the bitmap for the disabled button appearance.");
197
1e0c8722 198
dce2bd22
RD
199 DocDeclStr(
200 void , SetBitmapFocus(const wxBitmap& bitmap),
201 "Sets the bitmap for the button appearance when it has the keyboard focus.");
202
1e0c8722 203
dce2bd22
RD
204 DocDeclStr(
205 void , SetBitmapSelected(const wxBitmap& bitmap),
206 "Sets the bitmap for the selected (depressed) button appearance.");
207
1e0c8722 208
dce2bd22
RD
209 DocDeclStr(
210 void , SetBitmapLabel(const wxBitmap& bitmap),
211 "Sets the bitmap label for the button. This is the bitmap used for the
212unselected state, and for all other states if no other bitmaps are provided.");
213
d14a1e28
RD
214
215 void SetMargins(int x, int y);
216 int GetMarginX() const;
217 int GetMarginY() const;
218};
219
220
221//---------------------------------------------------------------------------