docs/latex/wx/stdbtnsz.tex

   1 \section{\class{wxStdDialogButtonSizer}}\label{wxstddialogbuttonsizer}
   2
   3 This class creates button layouts which conform to the standard button spacing and ordering defined by the platform or toolkit's user interface guidelines (if such things exist). By using this class, you can ensure that all your standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK and Mac OS X human interface guidelines.
   4
   5 When there aren't interface guidelines defined for a particular platform or toolkit, wxStdDialogButtonSizer reverts to the Windows implementation.
   6
   7 TO USE THIS CLASS: First, add buttons to the sizer by calling AddButton (or SetAffirmativeButton, SetNegativeButton, or SetCancelButton) and then call Finalise in order to create the actual button layout used. Other than these special operations, this sizer works like any other sizer.
   8
   9 ALSO NOTE: If you add a button with wxID\_SAVE, on Mac OS X the button will be renamed to "Save" and the wxID\_NO button will be renamed to "Don't Save" in accordance with the Mac OS X Human Interface Guidelines.
  10
  11 \wxheading{Derived from}
  12
  13 \helpref{wxBoxSizer}{wxboxsizer}\\
  14 \helpref{wxSizer}{wxsizer}\\
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/sizer.h>
  20
  21 \wxheading{See also}
  22
  23 \helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
  24
  25 \func{}{wxStdDialogButtonSizer}{\void}
  26
  27 Constructor for a wxStdDialogButtonSizer.
  28
  29 \membersection{wxStdDialogButtonSizer::AddButton}\label{wxstddialogbuttonsizeraddbutton}
  30
  31 \func{void}{AddButton}{\param{wxButton* }{button}}
  32
  33 Adds a button to the wxStdDialogButtonSizer. The button must have one of the following IDs:
  34
  35 \begin{itemize}
  36         \item wxID\_OK
  37         \item wxID\_YES
  38         \item wxID\_SAVE
  39         \item wxID\_APPLY
  40         \item wxID\_NO
  41         \item wxID\_CANCEL
  42         \item wxID\_HELP
  43         \item wxID\_CONTEXT\_HELP
  44 \end{itemize}
  45
  46 \membersection{wxStdDialogButtonSizer::Finalise}\label{wxstddialogbuttonsizerfinalise}
  47
  48 \func{void}{Finalise}{\void}
  49
  50 Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
  51
  52 \membersection{wxStdDialogButtonSizer::SetAffirmativeButton}\label{wxstddialogbuttonsizersetaffirmativebutton}
  53
  54 \func{void}{SetAffirmativeButton}{\param{wxButton* }{button}}
  55
  56 Sets the affirmative button for the sizer. This allows you to use IDs other than the standard IDs outlined above.
  57
  58 \membersection{wxStdDialogButtonSizer::SetCancelButton}\label{wxstddialogbuttonsizersetcancelbutton}
  59
  60 \func{void}{SetCancelButton}{\param{wxButton* }{button}}
  61
  62 Sets the cancel button for the sizer. This allows you to use IDs other than the standard IDs outlined above.
  63
  64 \membersection{wxStdDialogButtonSizer::SetNegativeButton}\label{wxstddialogbuttonsizersetnegativebutton}
  65
  66 \func{void}{SetNegativeButton}{\param{wxButton* }{button}}
  67
  68 Sets the negative button for the sizer. This allows you to use IDs other than the standard IDs outlined above.