From: Kevin Ollivier <kevino@theolliviers.com>
Date: Sun, 23 Jan 2005 07:32:19 +0000 (+0000)
Subject: Added documentation for wxStdDialogButtonSizer.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/76bdc1d23aebde78a36b26dc0475af869a33c7b8?hp=39104bc1bd99a5b1bb92d574f68777843cb5a0db

Added documentation for wxStdDialogButtonSizer.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31566 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index 4433a530e3..4cb6414a9a 100644
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -306,6 +306,7 @@
 \input statline.tex
 \input stattext.tex
 \input statusbr.tex
+\input stdbtnsz.tex
 \input stopwtch.tex
 \input strmbase.tex
 \input stream.tex
diff --git a/docs/latex/wx/stdbtnsz.tex b/docs/latex/wx/stdbtnsz.tex
new file mode 100644
index 0000000000..557dc543ff
--- /dev/null
+++ b/docs/latex/wx/stdbtnsz.tex
@@ -0,0 +1,67 @@
+\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.
+
+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. 
+
+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.
+
+\wxheading{Derived from}
+
+\helpref{wxBoxSizer}{wxboxsizer}\\
+\helpref{wxSizer}{wxsizer}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/sizer.h>
+
+\wxheading{See also}
+
+\helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
+
+\func{}{wxStdDialogButtonSizer}{\void}
+
+Constructor for a wxStdDialogButtonSizer.
+
+\membersection{wxStdDialogButtonSizer::AddButton}\label{wxstddialogbuttonsizeraddbutton}
+
+\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
+\end{itemize}
+
+\membersection{wxStdDialogButtonSizer::Finalise}\label{wxstddialogbuttonsizerfinalise}
+
+\func{void}{Finalise}{\void}
+
+Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
+
+\membersection{wxStdDialogButtonSizer::SetAffirmativeButton}\label{wxstddialogbuttonsizersetaffirmativebutton}
+
+\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.
+
+\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.
+
+\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.