]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/stdbtnsz.tex
another patch bring the docs more up to date (patch 1717776)
[wxWidgets.git] / docs / latex / wx / stdbtnsz.tex
index cd804ce2deebf999cfe2ce25939ca07cdcd1a87f..be6fcd54e8bf7f3c3518d75a5ffc3055af3839f7 100644 (file)
@@ -1,12 +1,19 @@
 \section{\class{wxStdDialogButtonSizer}}\label{wxstddialogbuttonsizer}
 
-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.
+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.
 
-When there aren't interface guidelines defined for a particular platform or toolkit, wxStdDialogButtonSizer reverts to the Windows implementation. 
+When there aren't interface guidelines defined for a particular platform or toolkit, wxStdDialogButtonSizer reverts
+to the Windows implementation. 
 
-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. 
+To use this class, first add buttons to the sizer by calling AddButton (or SetAffirmativeButton, SetNegativeButton,
+or SetCancelButton) and then call Realize in order to create the actual button layout used. Other than these special
+operations, this sizer works like any other sizer. 
 
-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.
+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.
 
 \wxheading{Derived from}
 
@@ -20,7 +27,9 @@ ALSO NOTE: If you add a button with wxID_SAVE, on Mac OS X the button will be re
 
 \wxheading{See also}
 
-\helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
+\helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}, \helpref{wxDialog::CreateButtonSizer}{wxdialogcreatebuttonsizer}
+
+\membersection{wxStdDialogButtonSizer::wxStdDialogButtonSizer}\label{wxstddialogbuttonsizerctor}
 
 \func{}{wxStdDialogButtonSizer}{\void}
 
@@ -30,22 +39,23 @@ Constructor for a wxStdDialogButtonSizer.
 
 \func{void}{AddButton}{\param{wxButton* }{button}}
 
-Adds a button to the wxStdDialogButtonSizer. The button must have one of the following IDs:
-
-\begin{itemize}
-       \item wxID_OK
-       \item wxID_YES
-       \item wxID_SAVE
-       \item wxID_APPLY
-       \item wxID_NO
-       \item wxID_CANCEL
-       \item wxID_HELP
-       \item wxID_CONTEXT_HELP
+Adds a button to the wxStdDialogButtonSizer. The button must have one of the following identifiers:
+
+\begin{itemize}\itemsep=0pt
+\item wxID\_OK
+\item wxID\_YES
+\item wxID\_SAVE
+\item wxID\_APPLY
+\item wxID\_CLOSE
+\item wxID\_NO
+\item wxID\_CANCEL
+\item wxID\_HELP
+\item wxID\_CONTEXT\_HELP
 \end{itemize}
 
-\membersection{wxStdDialogButtonSizer::Finalise}\label{wxstddialogbuttonsizerfinalise}
+\membersection{wxStdDialogButtonSizer::Realize}\label{wxstddialogbuttonsizerrealize}
 
-\func{void}{Finalise}{\void}
+\func{void}{Realize}{\void}
 
 Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
 
@@ -53,16 +63,17 @@ Rearranges the buttons and applies proper spacing between buttons to make them m
 
 \func{void}{SetAffirmativeButton}{\param{wxButton* }{button}}
 
-Sets the affirmative button for the sizer. This allows you to use IDs other than the standard IDs outlined above.
+Sets the affirmative button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above.
 
 \membersection{wxStdDialogButtonSizer::SetCancelButton}\label{wxstddialogbuttonsizersetcancelbutton}
 
 \func{void}{SetCancelButton}{\param{wxButton* }{button}}
 
-Sets the cancel button for the sizer. This allows you to use IDs other than the standard IDs outlined above.
+Sets the cancel button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above.
 
 \membersection{wxStdDialogButtonSizer::SetNegativeButton}\label{wxstddialogbuttonsizersetnegativebutton}
 
 \func{void}{SetNegativeButton}{\param{wxButton* }{button}}
 
-Sets the negative button for the sizer. This allows you to use IDs other than the standard IDs outlined above.
+Sets the negative button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above.
+