]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/bbutton.tex
Added some standard further identifiers to help with WinCE toolbars
[wxWidgets.git] / docs / latex / wx / bbutton.tex
index 80d0eae2787f7159b66f1645f9835713f145bc8e..14d993ffe5fc624b199318c267626d81aed125b0 100644 (file)
@@ -12,11 +12,15 @@ almost any other window.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/bmpbuttn.h>
+
 \wxheading{Remarks}
 
 A bitmap button can be supplied with a single bitmap, and wxWindows will draw
 all button states using this bitmap. If the application needs more control, additional bitmaps for
-the selected state, unpressed focussed state, and greyed-out state may be supplied.
+the selected state, unpressed focused state, and greyed-out state may be supplied.
 
 \wxheading{Window styles}
 
@@ -25,11 +29,23 @@ the selected state, unpressed focussed state, and greyed-out state may be suppli
 \twocolitem{\windowstyle{wxBU\_AUTODRAW}}{If
 this is specified, the button will be drawn automatically using the label bitmap only, providing
 a 3D-look border. If this style is not specified, the button will be drawn without borders and using all
-provided bitmaps.}
+provided bitmaps. WIN32 only.}
+\twocolitem{\windowstyle{wxBU\_LEFT}}{Left-justifies the bitmap label. WIN32 only.}
+\twocolitem{\windowstyle{wxBU\_TOP}}{Aligns the bitmap 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 bitmap label to the bottom of the button. WIN32 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{wxButton}{wxbutton}
@@ -42,9 +58,15 @@ See also \helpref{window styles overview}{windowstyles}.
 
 Default constructor.
 
-\func{}{wxBitmapButton}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp
-\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxBU\_AUTODRAW}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
+\func{}{wxBitmapButton}{
+\param{wxWindow* }{parent}, 
+\param{wxWindowID }{id}, 
+\param{const wxBitmap\& }{bitmap},\rtfsp
+\param{const wxPoint\& }{pos = wxDefaultPosition}, 
+\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
+\param{long }{style = wxBU\_AUTODRAW}, 
+\param{const wxValidator\& }{validator = wxDefaultValidator}, 
+\param{const wxString\& }{name = ``button"}}
 
 Constructor, creating and showing a button.
 
@@ -89,15 +111,15 @@ Destructor, destroying the button.
 
 \membersection{wxBitmapButton::Create}\label{wxbitmapbuttoncreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp
 \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = 0}, \param{const wxValidator\& }{validator}, \param{const wxString\& }{name = ``button"}}
+\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{wxBitmapButton::wxBitmapButton}{wxbitmapbuttonconstr}.
 
 \membersection{wxBitmapButton::GetBitmapDisabled}\label{wxbitmapbuttongetbitmapdisabled}
 
-\constfunc{wxBitmap\&}{GetBitmapLabel}{\void}
+\constfunc{wxBitmap\&}{GetBitmapDisabled}{\void}
 
 Returns the bitmap for the disabled state.
 
@@ -113,11 +135,11 @@ A reference to the disabled state bitmap.
 
 \constfunc{wxBitmap\&}{GetBitmapFocus}{\void}
 
-Returns the bitmap for the focussed state.
+Returns the bitmap for the focused state.
 
 \wxheading{Return value}
 
-A reference to the focussed state bitmap.
+A reference to the focused state bitmap.
 
 \wxheading{See also}