X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7ef8bfc4c75374ffd4de538cdeaa0f81b69bf61f..e7c240da70308b5e54bf8bcc9813b5c4e4fece4d:/docs/latex/wx/button.tex?ds=sidebyside diff --git a/docs/latex/wx/button.tex b/docs/latex/wx/button.tex index 043d6d9d5e..afd59c4731 100644 --- a/docs/latex/wx/button.tex +++ b/docs/latex/wx/button.tex @@ -1,7 +1,7 @@ \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. @@ -20,11 +20,12 @@ almost any other window. \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxBU\_LEFT}}{Left-justifies the label. WIN32 only.} -\twocolitem{\windowstyle{wxBU\_TOP}}{Aligns the label to the top of the button. WIN32 only.} -\twocolitem{\windowstyle{wxBU\_RIGHT}}{Right-justifies the bitmap label. WIN32 only.} -\twocolitem{\windowstyle{wxBU\_BOTTOM}}{Aligns the label to the bottom of the button. WIN32 only.} +\twocolitem{\windowstyle{wxBU\_LEFT}}{Left-justifies the label. Windows and GTK+ only.} +\twocolitem{\windowstyle{wxBU\_TOP}}{Aligns the label to the top of the button. Windows and GTK+ only.} +\twocolitem{\windowstyle{wxBU\_RIGHT}}{Right-justifies the bitmap label. Windows and GTK+ only.} +\twocolitem{\windowstyle{wxBU\_BOTTOM}}{Aligns the label to the bottom of the button. Windows and GTK+ only.} \twocolitem{\windowstyle{wxBU\_EXACTFIT}}{Creates the button as small as possible instead of making it of the standard size (which is the default behaviour ).} +\twocolitem{\windowstyle{wxNO\_BORDER}}{Creates a flat button. Windows and GTK+ only.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -43,29 +44,34 @@ when the button is clicked.} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxButton::wxButton}\label{wxbuttonconstr} +\membersection{wxButton::wxButton}\label{wxbuttonctor} \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{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. +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.} -\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{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}.} @@ -78,7 +84,7 @@ appropriately for the text.} \helpref{wxButton::Create}{wxbuttoncreate}, \helpref{wxValidator}{wxvalidator} -\membersection{wxButton::\destruct{wxButton}} +\membersection{wxButton::\destruct{wxButton}}\label{wxbuttondtor} \func{}{\destruct{wxButton}}{\void} @@ -86,11 +92,12 @@ Destructor, destroying the button. \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 +\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 \helpref{wxButton::wxButton}{wxbuttonconstr}. +Button creation function for two-step creation. For more details, see +\helpref{wxButton::wxButton}{wxbuttonctor}. \membersection{wxButton::GetLabel}\label{wxbuttongetlabel} @@ -133,7 +140,7 @@ Note that under Motif, calling this function immediately after creation of a button and before the creation of other buttons will cause misalignment of the row of buttons, since default buttons are larger. To get around this, call {\it SetDefault}\rtfsp -after you have created a row of buttons: wxWindows will +after you have created a row of buttons: wxWidgets will then set the size of all buttons currently on the panel to the same size.