wxPaletteBase introduction. wxPalette::GetColoursCount() in interface of all platform...

[wxWidgets.git] / docs / latex / wx / button.tex

diff --git a/docs/latex/wx/button.tex b/docs/latex/wx/button.tex
index 5abd58966e1ee56316838185649048308b64a8ce..be358e988195266f2574c5b932a713fcca472a74 100644 (file)
--- a/docs/latex/wx/button.tex
+++ b/docs/latex/wx/button.tex
@@ -12,30 +12,55 @@ almost any other window.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/button.h>
+
 \wxheading{Window styles}
 
-There are no special styles for wxButton.
+\twocolwidtha{5cm}%
+\begin{twocollist}\itemsep=0pt
+\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}.
 
+\wxheading{Event handling}
+
+\twocolwidtha{7cm}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_BUTTON(id, func)}}{Process a wxEVT\_COMMAND\_BUTTON\_CLICKED event,
+when the button is clicked.}
+\end{twocollist}
+
 \wxheading{See also}
 
 \helpref{wxBitmapButton}{wxbitmapbutton}
 
 \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
+\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"}}
+\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.}
@@ -59,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}
 
@@ -67,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
+\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"}}
 
-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}
 
@@ -87,6 +113,14 @@ The button's label.
 
 \helpref{wxButton::SetLabel}{wxbuttonsetlabel}
 
+\membersection{wxButton::GetDefaultSize}\label{wxbuttongetdefaultsize}
+
+\func{wxSize}{GetDefaultSize}{\void}
+
+Returns the default size for the buttons. It is advised to make all the dialog
+buttons of the same size and this function allows to retrieve the (platform and
+current font dependent size) which should be the best suited for this.
+
 \membersection{wxButton::SetDefault}\label{wxbuttonsetdefault}
 
 \func{void}{SetDefault}{\void}
@@ -100,13 +134,13 @@ 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
-and \helpref{wxWindow::GetDefaultItem}{wxwindowgetdefaultitem}.
+and \helpref{wxPanel::SetDefaultItem}{wxpanelsetdefaultitem}.
 
 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.