]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/stdbtnsz.tex
remove C++ comment
[wxWidgets.git] / docs / latex / wx / stdbtnsz.tex
... / ...
CommitLineData
1\section{\class{wxStdDialogButtonSizer}}\label{wxstddialogbuttonsizer}
2
3This class creates button layouts which conform to the standard button spacing and ordering defined by the platform
4or toolkit's user interface guidelines (if such things exist). By using this class, you can ensure that all your
5standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK+ and Mac OS X
6human interface guidelines.
7
8When there aren't interface guidelines defined for a particular platform or toolkit, wxStdDialogButtonSizer reverts
9to the Windows implementation.
10
11To use this class, first add buttons to the sizer by calling AddButton (or SetAffirmativeButton, SetNegativeButton,
12or SetCancelButton) and then call Realize in order to create the actual button layout used. Other than these special
13operations, this sizer works like any other sizer.
14
15If you add a button with wxID\_SAVE, on Mac OS X the button will be renamed to "Save" and
16the wxID\_NO button will be renamed to "Don't Save" in accordance with the Mac OS X Human Interface Guidelines.
17
18\wxheading{Derived from}
19
20\helpref{wxBoxSizer}{wxboxsizer}\\
21\helpref{wxSizer}{wxsizer}\\
22\helpref{wxObject}{wxobject}
23
24\wxheading{Include files}
25
26<wx/sizer.h>
27
28\wxheading{Library}
29
30\helpref{wxCore}{librarieslist}
31
32\wxheading{See also}
33
34\helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}, \helpref{wxDialog::CreateButtonSizer}{wxdialogcreatebuttonsizer}
35
36
37\latexignore{\rtfignore{\wxheading{Members}}}
38
39\membersection{wxStdDialogButtonSizer::wxStdDialogButtonSizer}\label{wxstddialogbuttonsizerctor}
40
41\func{}{wxStdDialogButtonSizer}{\void}
42
43Constructor for a wxStdDialogButtonSizer.
44
45\membersection{wxStdDialogButtonSizer::AddButton}\label{wxstddialogbuttonsizeraddbutton}
46
47\func{void}{AddButton}{\param{wxButton* }{button}}
48
49Adds a button to the wxStdDialogButtonSizer. The button must have one of the following identifiers:
50
51\begin{itemize}\itemsep=0pt
52\item wxID\_OK
53\item wxID\_YES
54\item wxID\_SAVE
55\item wxID\_APPLY
56\item wxID\_CLOSE
57\item wxID\_NO
58\item wxID\_CANCEL
59\item wxID\_HELP
60\item wxID\_CONTEXT\_HELP
61\end{itemize}
62
63\membersection{wxStdDialogButtonSizer::Realize}\label{wxstddialogbuttonsizerrealize}
64
65\func{void}{Realize}{\void}
66
67Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
68
69\membersection{wxStdDialogButtonSizer::SetAffirmativeButton}\label{wxstddialogbuttonsizersetaffirmativebutton}
70
71\func{void}{SetAffirmativeButton}{\param{wxButton* }{button}}
72
73Sets the affirmative button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above.
74
75\membersection{wxStdDialogButtonSizer::SetCancelButton}\label{wxstddialogbuttonsizersetcancelbutton}
76
77\func{void}{SetCancelButton}{\param{wxButton* }{button}}
78
79Sets the cancel button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above.
80
81\membersection{wxStdDialogButtonSizer::SetNegativeButton}\label{wxstddialogbuttonsizersetnegativebutton}
82
83\func{void}{SetNegativeButton}{\param{wxButton* }{button}}
84
85Sets the negative button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above.
86