new stock buttons API

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@28967 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2004-08-30 14:42:51 +00:00
parent 598ddd96f4
commit 5f7bcb48fd
40 changed files with 497 additions and 829 deletions

View File

@@ -50,23 +50,16 @@ when the button is clicked.}
Default constructor.
\func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
\func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label = wxEmptyString},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
\func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},
\param{wxStockItemID}{ stock},\rtfsp
\param{const wxString\& }{descriptiveLabel = wxEmptyString},\rtfsp
\param{const wxPoint\& }{pos},\rtfsp
\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
Constructor, creating and showing a button.
The second form is used to create {\em stock} button. Stock buttons are
commonly used buttons such as OK or Cancel. They have standard label and
dimensions and may have different appearance on some platforms (e.g. GTK+ 2
decorates them with icons). Using this from is preferred way of creating
standard buttons.
The preferred way to create standard buttons is to use default value of
\arg{label}. If no label is supplied and \arg{id} is one of standard IDs from
\helpref{this list}{stockitems}, standard label will be used. In additon to
that, the button will be decorated with stock icons under GTK+ 2.
\wxheading{Parameters}
@@ -87,15 +80,6 @@ appropriately for the text.}
\docparam{name}{Window name.}
\docparam{stock}{Stock ID of the stock button to create. See the
\helpref{list of possible values}{stockitems}.}
\docparam{descriptiveLabel}{Optional label to be used on platforms where
standard buttons have descriptive rather than generic labels. Mac is one such
platforms, well-behaved Mac apps should use descriptive labels (e.g. "Save"
and "Don't Save" instead of "OK" and "Cancel"). This argument is ignored on
other platforms.}
\wxheading{See also}
\helpref{wxButton::Create}{wxbuttoncreate}, \helpref{wxValidator}{wxvalidator}
@@ -108,16 +92,10 @@ Destructor, destroying the button.
\membersection{wxButton::Create}\label{wxbuttoncreate}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label = wxEmptyString},\rtfsp
\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},
\param{wxStockItemID}{ stock},\rtfsp
\param{const wxString\& }{descriptiveLabel = wxEmptyString},\rtfsp
\param{const wxPoint\& }{pos},\rtfsp
\param{long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
Button creation function for two-step creation. For more details, see
\helpref{wxButton::wxButton}{wxbuttonconstr}.

View File

@@ -1,56 +1,57 @@
\section{Stock items}\label{stockitems}
Stock item IDs for use in \helpref{wxButton constructor}{wxbuttonconstr}:
Window IDs for which stock buttons are created
(see \helpref{wxButton constructor}{wxbuttonconstr}):
\begin{twocollist}\itemsep=0pt
\twocolitem{wxSTOCK\_ADD}{"Add"}
\twocolitem{wxSTOCK\_APPLY}{"\&Apply"}
\twocolitem{wxSTOCK\_BOLD}{"\&Bold"}
\twocolitem{wxSTOCK\_CANCEL}{"\&Cancel"}
\twocolitem{wxSTOCK\_CLEAR}{"\&Clear"}
\twocolitem{wxSTOCK\_CLOSE}{"\&Close"}
\twocolitem{wxSTOCK\_COPY}{"\&Copy"}
\twocolitem{wxSTOCK\_CUT}{"Cu\&t"}
\twocolitem{wxSTOCK\_DELETE}{"\&Delete"}
\twocolitem{wxSTOCK\_FIND}{"\&Find"}
\twocolitem{wxSTOCK\_FIND\_AND\_REPLACE}{"Find and rep\&lace"}
\twocolitem{wxSTOCK\_GO\_BACK}{"\&Back"}
\twocolitem{wxSTOCK\_GO\_DOWN}{"\&Down"}
\twocolitem{wxSTOCK\_GO\_FORWARD}{"\&Forward"}
\twocolitem{wxSTOCK\_GO\_UP}{"\&Up"}
\twocolitem{wxSTOCK\_HELP}{"\&Help"}
\twocolitem{wxSTOCK\_HOME}{"\&Home"}
\twocolitem{wxSTOCK\_INDENT}{"Indent"}
\twocolitem{wxSTOCK\_INDEX}{"\&Index"}
\twocolitem{wxSTOCK\_ITALIC}{"\&Italic"}
\twocolitem{wxSTOCK\_JUSTIFY\_CENTER}{"Centered"}
\twocolitem{wxSTOCK\_JUSTIFY\_FILL}{"Justified"}
\twocolitem{wxSTOCK\_JUSTIFY\_LEFT}{"Align Left"}
\twocolitem{wxSTOCK\_JUSTIFY\_RIGHT}{"Align Right"}
\twocolitem{wxSTOCK\_NEW}{"\&New"}
\twocolitem{wxSTOCK\_NO}{"\&No"}
\twocolitem{wxSTOCK\_OK}{"\&OK"}
\twocolitem{wxSTOCK\_OPEN}{"\&Open"}
\twocolitem{wxSTOCK\_PASTE}{"\&Paste"}
\twocolitem{wxSTOCK\_PREFERENCES}{"\&Preferences"}
\twocolitem{wxSTOCK\_PRINT}{"\&Print"}
\twocolitem{wxSTOCK\_PRINT\_PREVIEW}{"Print previe\&w"}
\twocolitem{wxSTOCK\_PROPERTIES}{"\&Properties"}
\twocolitem{wxSTOCK\_QUIT}{"\&Quit"}
\twocolitem{wxSTOCK\_REDO}{"\&Redo"}
\twocolitem{wxSTOCK\_REFRESH}{"Refresh"}
\twocolitem{wxSTOCK\_REMOVE}{"Remove"}
\twocolitem{wxSTOCK\_REVERT\_TO\_SAVED}{"Revert to Saved"}
\twocolitem{wxSTOCK\_SAVE}{"\&Save"}
\twocolitem{wxSTOCK\_SAVE\_AS}{"Save \&As..."}
\twocolitem{wxSTOCK\_STOP}{"\&Stop"}
\twocolitem{wxSTOCK\_UNDELETE}{"Undelete"}
\twocolitem{wxSTOCK\_UNDERLINE}{"\&Underline"}
\twocolitem{wxSTOCK\_UNDO}{"\&Undo"}
\twocolitem{wxSTOCK\_UNINDENT}{"\&Unindent"}
\twocolitem{wxSTOCK\_YES}{"\&Yes"}
\twocolitem{wxSTOCK\_ZOOM\_100}{"\&Actual Size"}
\twocolitem{wxSTOCK\_ZOOM\_FIT}{"Zoom to \&Fit"}
\twocolitem{wxSTOCK\_ZOOM\_IN}{"Zoom \&In"}
\twocolitem{wxSTOCK\_ZOOM\_OUT}{"Zoom \&Out"}
\twocolitem{wxID\_ADD}{"Add"}
\twocolitem{wxID\_APPLY}{"\&Apply"}
\twocolitem{wxID\_BOLD}{"\&Bold"}
\twocolitem{wxID\_CANCEL}{"\&Cancel"}
\twocolitem{wxID\_CLEAR}{"\&Clear"}
\twocolitem{wxID\_CLOSE}{"\&Close"}
\twocolitem{wxID\_COPY}{"\&Copy"}
\twocolitem{wxID\_CUT}{"Cu\&t"}
\twocolitem{wxID\_DELETE}{"\&Delete"}
\twocolitem{wxID\_FIND}{"\&Find"}
\twocolitem{wxID\_REPLACE}{"Find and rep\&lace"}
\twocolitem{wxID\_BACKWARD}{"\&Back"}
\twocolitem{wxID\_DOWN}{"\&Down"}
\twocolitem{wxID\_FORWARD}{"\&Forward"}
\twocolitem{wxID\_UP}{"\&Up"}
\twocolitem{wxID\_HELP}{"\&Help"}
\twocolitem{wxID\_HOME}{"\&Home"}
\twocolitem{wxID\_INDENT}{"Indent"}
\twocolitem{wxID\_INDEX}{"\&Index"}
\twocolitem{wxID\_ITALIC}{"\&Italic"}
\twocolitem{wxID\_JUSTIFY\_CENTER}{"Centered"}
\twocolitem{wxID\_JUSTIFY\_FILL}{"Justified"}
\twocolitem{wxID\_JUSTIFY\_LEFT}{"Align Left"}
\twocolitem{wxID\_JUSTIFY\_RIGHT}{"Align Right"}
\twocolitem{wxID\_NEW}{"\&New"}
\twocolitem{wxID\_NO}{"\&No"}
\twocolitem{wxID\_OK}{"\&OK"}
\twocolitem{wxID\_OPEN}{"\&Open"}
\twocolitem{wxID\_PASTE}{"\&Paste"}
\twocolitem{wxID\_PREFERENCES}{"\&Preferences"}
\twocolitem{wxID\_PRINT}{"\&Print"}
\twocolitem{wxID\_PREVIEW}{"Print previe\&w"}
\twocolitem{wxID\_PROPERTIES}{"\&Properties"}
\twocolitem{wxID\_EXIT}{"\&Quit"}
\twocolitem{wxID\_REDO}{"\&Redo"}
\twocolitem{wxID\_REFRESH}{"Refresh"}
\twocolitem{wxID\_REMOVE}{"Remove"}
\twocolitem{wxID\_REVERT\_TO\_SAVED}{"Revert to Saved"}
\twocolitem{wxID\_SAVE}{"\&Save"}
\twocolitem{wxID\_SAVEAS}{"Save \&As..."}
\twocolitem{wxID\_STOP}{"\&Stop"}
\twocolitem{wxID\_UNDELETE}{"Undelete"}
\twocolitem{wxID\_UNDERLINE}{"\&Underline"}
\twocolitem{wxID\_UNDO}{"\&Undo"}
\twocolitem{wxID\_UNINDENT}{"\&Unindent"}
\twocolitem{wxID\_YES}{"\&Yes"}
\twocolitem{wxID\_ZOOM\_100}{"\&Actual Size"}
\twocolitem{wxID\_ZOOM\_FIT}{"Zoom to \&Fit"}
\twocolitem{wxID\_ZOOM\_IN}{"Zoom \&In"}
\twocolitem{wxID\_ZOOM\_OUT}{"Zoom \&Out"}
\end{twocollist}\itemsep=0pt