]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/button.tex
Small tweaks for WinCE compatibility
[wxWidgets.git] / docs / latex / wx / button.tex
1 \section{\class{wxButton}}\label{wxbutton}
2
3 A button is a control that contains a text string,
4 and is one of the commonest elements of a GUI. It may be placed on a
5 \rtfsp\helpref{dialog box}{wxdialog} or \helpref{panel}{wxpanel}, or indeed
6 almost any other window.
7
8 \wxheading{Derived from}
9
10 \helpref{wxControl}{wxcontrol}\\
11 \helpref{wxWindow}{wxwindow}\\
12 \helpref{wxEvtHandler}{wxevthandler}\\
13 \helpref{wxObject}{wxobject}
14
15 \wxheading{Include files}
16
17 <wx/button.h>
18
19 \wxheading{Window styles}
20
21 \twocolwidtha{5cm}%
22 \begin{twocollist}\itemsep=0pt
23 \twocolitem{\windowstyle{wxBU\_LEFT}}{Left-justifies the label. WIN32 only.}
24 \twocolitem{\windowstyle{wxBU\_TOP}}{Aligns the label to the top of the button. WIN32 only.}
25 \twocolitem{\windowstyle{wxBU\_RIGHT}}{Right-justifies the bitmap label. WIN32 only.}
26 \twocolitem{\windowstyle{wxBU\_BOTTOM}}{Aligns the label to the bottom of the button. WIN32 only.}
27 \twocolitem{\windowstyle{wxBU\_EXACTFIT}}{Creates the button as small as possible instead of making it of the standard size (which is the default behaviour ).}
28 \end{twocollist}
29
30 See also \helpref{window styles overview}{windowstyles}.
31
32 \wxheading{Event handling}
33
34 \twocolwidtha{7cm}%
35 \begin{twocollist}\itemsep=0pt
36 \twocolitem{{\bf EVT\_BUTTON(id, func)}}{Process a wxEVT\_COMMAND\_BUTTON\_CLICKED event,
37 when the button is clicked.}
38 \end{twocollist}
39
40 \wxheading{See also}
41
42 \helpref{wxBitmapButton}{wxbitmapbutton}
43
44 \latexignore{\rtfignore{\wxheading{Members}}}
45
46 \membersection{wxButton::wxButton}\label{wxbuttonconstr}
47
48 \func{}{wxButton}{\void}
49
50 Default constructor.
51
52 \func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
53 \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
54 \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
55
56 Constructor, creating and showing a button.
57
58 \wxheading{Parameters}
59
60 \docparam{parent}{Parent window. Must not be NULL.}
61
62 \docparam{id}{Button identifier. A value of -1 indicates a default value.}
63
64 \docparam{label}{Text to be displayed on the button.}
65
66 \docparam{pos}{Button position.}
67
68 \docparam{size}{Button size. If the default size (-1, -1) is specified then the button is sized
69 appropriately for the text.}
70
71 \docparam{style}{Window style. See \helpref{wxButton}{wxbutton}.}
72
73 \docparam{validator}{Window validator.}
74
75 \docparam{name}{Window name.}
76
77 \wxheading{See also}
78
79 \helpref{wxButton::Create}{wxbuttoncreate}, \helpref{wxValidator}{wxvalidator}
80
81 \membersection{wxButton::\destruct{wxButton}}
82
83 \func{}{\destruct{wxButton}}{\void}
84
85 Destructor, destroying the button.
86
87 \membersection{wxButton::Create}\label{wxbuttoncreate}
88
89 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
90 \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
91 \param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
92
93 Button creation function for two-step creation. For more details, see \helpref{wxButton::wxButton}{wxbuttonconstr}.
94
95 \membersection{wxButton::GetLabel}\label{wxbuttongetlabel}
96
97 \constfunc{wxString}{GetLabel}{\void}
98
99 Returns the string label for the button.
100
101 \wxheading{Return value}
102
103 The button's label.
104
105 \wxheading{See also}
106
107 \helpref{wxButton::SetLabel}{wxbuttonsetlabel}
108
109 \membersection{wxButton::GetDefaultSize}\label{wxbuttongetdefaultsize}
110
111 \func{wxSize}{GetDefaultSize}{\void}
112
113 Returns the default size for the buttons. It is advised to make all the dialog
114 buttons of the same size and this function allows to retrieve the (platform and
115 current font dependent size) which should be the best suited for this.
116
117 \membersection{wxButton::SetDefault}\label{wxbuttonsetdefault}
118
119 \func{void}{SetDefault}{\void}
120
121 This sets the button to be the default item for the panel or dialog
122 box.
123
124 \wxheading{Remarks}
125
126 Under Windows, only dialog box buttons respond to this function. As
127 normal under Windows and Motif, pressing return causes the default button to
128 be depressed when the return key is pressed. See also \helpref{wxWindow::SetFocus}{wxwindowsetfocus}\rtfsp
129 which sets the keyboard focus for windows and text panel items,\rtfsp
130 and \helpref{wxPanel::SetDefaultItem}{wxpanelsetdefaultitem}.
131
132 Note that under Motif, calling this function immediately after
133 creation of a button and before the creation of other buttons
134 will cause misalignment of the row of buttons, since default
135 buttons are larger. To get around this, call {\it SetDefault}\rtfsp
136 after you have created a row of buttons: wxWindows will
137 then set the size of all buttons currently on the panel to
138 the same size.
139
140 \membersection{wxButton::SetLabel}\label{wxbuttonsetlabel}
141
142 \func{void}{SetLabel}{\param{const wxString\& }{label}}
143
144 Sets the string label for the button.
145
146 \wxheading{Parameters}
147
148 \docparam{label}{The label to set.}
149
150 \wxheading{See also}
151
152 \helpref{wxButton::GetLabel}{wxbuttongetlabel}
153