]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/button.tex
don't make read-only text controls editable when enabled
[wxWidgets.git] / docs / latex / wx / button.tex
index ac32dad9e187a9c978eb5fae8385803aaa9e6df8..dabfe69091aa5209ab0365fbb22d74268a3e60df 100644 (file)
@@ -1,7 +1,7 @@
 \section{\class{wxButton}}\label{wxbutton}
 
 A button is a control that contains a text string,
 \section{\class{wxButton}}\label{wxbutton}
 
 A button is a control that contains a text string,
-and is one of the commonest elements of a GUI. It may be placed on a
+and is one of the most common elements of a GUI. It may be placed on a
 \rtfsp\helpref{dialog box}{wxdialog} or \helpref{panel}{wxpanel}, or indeed
 almost any other window.
 
 \rtfsp\helpref{dialog box}{wxdialog} or \helpref{panel}{wxpanel}, or indeed
 almost any other window.
 
@@ -44,41 +44,34 @@ when the button is clicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxButton::wxButton}\label{wxbuttonconstr}
+\membersection{wxButton::wxButton}\label{wxbuttonctor}
 
 \func{}{wxButton}{\void}
 
 Default constructor.
 
 
 \func{}{wxButton}{\void}
 
 Default constructor.
 
-\func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\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"}}
+\func{}{wxButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label = wxEmptyString},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
+\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``button"}}
 
 Constructor, creating and showing a 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 addition to
+that, the button will be decorated with stock icons under GTK+ 2.
 
 \wxheading{Parameters}
 
 \docparam{parent}{Parent window. Must not be NULL.}
 
 
 \wxheading{Parameters}
 
 \docparam{parent}{Parent window. Must not be NULL.}
 
-\docparam{id}{Button identifier. A value of -1 indicates a default value.}
+\docparam{id}{Button identifier. A value of \texttt{wxID\_ANY} indicates a default value.}
 
 \docparam{label}{Text to be displayed on the button.}
 
 \docparam{pos}{Button position.}
 
 
 \docparam{label}{Text to be displayed on the button.}
 
 \docparam{pos}{Button position.}
 
-\docparam{size}{Button size. If the default size (-1, -1) is specified then the button is sized
+\docparam{size}{Button size. If the default size is specified then the button is sized
 appropriately for the text.}
 
 \docparam{style}{Window style. See \helpref{wxButton}{wxbutton}.}
 appropriately for the text.}
 
 \docparam{style}{Window style. See \helpref{wxButton}{wxbutton}.}
@@ -87,20 +80,11 @@ appropriately for the text.}
 
 \docparam{name}{Window name.}
 
 
 \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}
 
 \wxheading{See also}
 
 \helpref{wxButton::Create}{wxbuttoncreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxButton::\destruct{wxButton}}
+\membersection{wxButton::\destruct{wxButton}}\label{wxbuttondtor}
 
 \func{}{\destruct{wxButton}}{\void}
 
 
 \func{}{\destruct{wxButton}}{\void}
 
@@ -108,18 +92,12 @@ Destructor, destroying the button.
 
 \membersection{wxButton::Create}\label{wxbuttoncreate}
 
 
 \membersection{wxButton::Create}\label{wxbuttoncreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\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
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label = wxEmptyString},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\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
 \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}.
+\helpref{wxButton::wxButton}{wxbuttonctor}.
 
 \membersection{wxButton::GetLabel}\label{wxbuttongetlabel}
 
 
 \membersection{wxButton::GetLabel}\label{wxbuttongetlabel}
 
@@ -156,7 +134,7 @@ Under Windows, only dialog box buttons respond to this function.  As
 normal under Windows and Motif, pressing return causes the default button to
 be depressed when the return key is pressed. See also \helpref{wxWindow::SetFocus}{wxwindowsetfocus}\rtfsp
 which sets the keyboard focus for windows and text panel items,\rtfsp
 normal under Windows and Motif, pressing return causes the default button to
 be depressed when the return key is pressed. See also \helpref{wxWindow::SetFocus}{wxwindowsetfocus}\rtfsp
 which sets the keyboard focus for windows and text panel items,\rtfsp
-and \helpref{wxPanel::SetDefaultItem}{wxpanelsetdefaultitem}.
+and \helpref{wxTopLevelWindow::SetDefaultItem}{wxtoplevelwindowsetdefaultitem}.
 
 Note that under Motif, calling this function immediately after
 creation of a button and before the creation of other buttons
 
 Note that under Motif, calling this function immediately after
 creation of a button and before the creation of other buttons