escape underscores and don't use abbreviations in text

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

diff --git a/docs/latex/wx/bbutton.tex b/docs/latex/wx/bbutton.tex
index be4160c6a39c872caaf78f3e407234e5d10a40b8..3aed0a9138e638f49f4e7ae4f1ba059a39bc0b6d 100644 (file)
--- a/docs/latex/wx/bbutton.tex
+++ b/docs/latex/wx/bbutton.tex
@@ -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
+A bitmap button can be supplied with a single bitmap, and wxWidgets 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,9 +29,17 @@ 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}
 
+Note that \windowstyle{wxBU\_EXACTFIT} supported by 
+\helpref{wxButton}{wxbutton} is \emph{not} used by this class as bitmap buttons
+don't have any minimal standard size by default.
+
 See also \helpref{window styles overview}{windowstyles}.
 
 \wxheading{Event handling}
@@ -44,15 +56,21 @@ when the button is clicked.}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxBitmapButton::wxBitmapButton}\label{wxbitmapbuttonconstr}
+\membersection{wxBitmapButton::wxBitmapButton}\label{wxbitmapbuttonctor}
 
 \func{}{wxBitmapButton}{\void}
 
 Default constructor.
 
-\func{}{wxBitmapButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id}, \param{const wxBitmap\& }{bitmap},\rtfsp
-\param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{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.
 
@@ -77,7 +95,7 @@ appropriately for the bitmap.}
 
 \wxheading{Remarks}
 
-The {\it bitmap} parameter is normally the only bitmap you need to provide, and wxWindows will
+The {\it bitmap} parameter is normally the only bitmap you need to provide, and wxWidgets will
 draw the button correctly in its different states. If you want more control, call
 any of the functions \helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected},\rtfsp
 \helpref{wxBitmapButton::SetBitmapFocus}{wxbitmapbuttonsetbitmapfocus},\rtfsp
@@ -89,7 +107,7 @@ Note that the bitmap passed is smaller than the actual button created.
 
 \helpref{wxBitmapButton::Create}{wxbitmapbuttoncreate}, \helpref{wxValidator}{wxvalidator}
 
-\membersection{wxBitmapButton::\destruct{wxBitmapButton}}
+\membersection{wxBitmapButton::\destruct{wxBitmapButton}}\label{wxbitmapbuttondtor}
 
 \func{}{\destruct{wxBitmapButton}}{\void}
 
@@ -101,11 +119,11 @@ Destructor, destroying the button.
 \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{wxBitmapButton::wxBitmapButton}{wxbitmapbuttonconstr}.
+Button creation function for two-step creation. For more details, see \helpref{wxBitmapButton::wxBitmapButton}{wxbitmapbuttonctor}.
 
 \membersection{wxBitmapButton::GetBitmapDisabled}\label{wxbitmapbuttongetbitmapdisabled}
 
-\constfunc{wxBitmap\&}{GetBitmapLabel}{\void}
+\constfunc{wxBitmap\&}{GetBitmapDisabled}{\void}
 
 Returns the bitmap for the disabled state.
 
@@ -121,11 +139,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}