X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..a1c3cdc4a2c4cc2b15d7fdf60c1be228f9fbc520:/docs/latex/wx/bbutton.tex diff --git a/docs/latex/wx/bbutton.tex b/docs/latex/wx/bbutton.tex index 48e4395af9..390898a6f6 100644 --- a/docs/latex/wx/bbutton.tex +++ b/docs/latex/wx/bbutton.tex @@ -4,6 +4,7 @@ A bitmap button is a control that contains a bitmap. It may be placed on a \helpref{dialog box}{wxdialog} or \helpref{panel}{wxpanel}, or indeed almost any other window. + \wxheading{Derived from} \helpref{wxButton}{wxbutton}\\ @@ -12,16 +13,42 @@ almost any other window. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} + \wxheading{Include files} + \wxheading{Remarks} 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 focused state, and greyed-out state may be supplied. + +\wxheading{Button states} + +This class supports bitmaps for several different states: + +\twocolwidtha{5cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{normal}}{This is the bitmap shown in the default state, +it must be always valid while all the other bitmaps are optional and don't have +to be set.} +\twocolitem{\windowstyle{disabled}}{Bitmap shown when the button is disabled.} +\twocolitem{\windowstyle{selected}}{Bitmap shown when the button is pushed +(e.g. while the user keeps the mouse button pressed on it)} +\twocolitem{\windowstyle{focus}}{Bitmap shown when the button has keyboard +focus but is not pressed.} +\twocolitem{\windowstyle{hover}}{Bitmap shown when the mouse is over the +button (but it is not pressed). Notice that if hover bitmap is not specified +but the current platform UI uses hover images for the buttons (such as Windows +XP or GTK+), then the focus bitmap is used for hover state as well. This makes +it possible to set focus bitmap only to get reasonably good behaviour on all +platforms.} +\end{twocollist} + + \wxheading{Window styles} \twocolwidtha{5cm} @@ -36,8 +63,13 @@ provided bitmaps. 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} \twocolwidtha{7cm} @@ -46,13 +78,17 @@ See also \helpref{window styles overview}{windowstyles}. when the button is clicked.} \end{twocollist} + \wxheading{See also} \helpref{wxButton}{wxbutton} + + \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxBitmapButton::wxBitmapButton}\label{wxbitmapbuttonconstr} + +\membersection{wxBitmapButton::wxBitmapButton}\label{wxbitmapbuttonctor} \func{}{wxBitmapButton}{\void} @@ -103,25 +139,29 @@ 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} Destructor, destroying the button. + \membersection{wxBitmapButton::Create}\label{wxbitmapbuttoncreate} \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{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\&}{GetBitmapDisabled}{\void} +\constfunc{const wxBitmap\&}{GetBitmapDisabled}{\void} +\func{wxBitmap\&}{GetBitmapDisabled}{\void} -Returns the bitmap for the disabled state. +Returns the bitmap for the disabled state, may be invalid. \wxheading{Return value} @@ -131,11 +171,13 @@ A reference to the disabled state bitmap. \helpref{wxBitmapButton::SetBitmapDisabled}{wxbitmapbuttonsetbitmapdisabled} + \membersection{wxBitmapButton::GetBitmapFocus}\label{wxbitmapbuttongetbitmapfocus} -\constfunc{wxBitmap\&}{GetBitmapFocus}{\void} +\constfunc{const wxBitmap\&}{GetBitmapFocus}{\void} +\func{wxBitmap\&}{GetBitmapFocus}{\void} -Returns the bitmap for the focused state. +Returns the bitmap for the focused state, may be invalid. \wxheading{Return value} @@ -145,11 +187,25 @@ A reference to the focused state bitmap. \helpref{wxBitmapButton::SetBitmapFocus}{wxbitmapbuttonsetbitmapfocus} + +\membersection{wxBitmapButton::GetBitmapHover}\label{wxbitmapbuttongetbitmaphover} + +\constfunc{const wxBitmap\&}{GetBitmapHover}{\void} +\func{wxBitmap\&}{GetBitmapHover}{\void} + +Returns the bitmap used when the mouse is over the button, may be invalid. + +\wxheading{See also} + +\helpref{wxBitmapButton::SetBitmapHover}{wxbitmapbuttonsetbitmaphover} + + \membersection{wxBitmapButton::GetBitmapLabel}\label{wxbitmapbuttongetbitmaplabel} -\constfunc{wxBitmap\&}{GetBitmapLabel}{\void} +\constfunc{const wxBitmap\&}{GetBitmapLabel}{\void} +\func{wxBitmap\&}{GetBitmapLabel}{\void} -Returns the label bitmap (the one passed to the constructor). +Returns the label bitmap (the one passed to the constructor), always valid. \wxheading{Return value} @@ -159,6 +215,23 @@ A reference to the button's label bitmap. \helpref{wxBitmapButton::SetBitmapLabel}{wxbitmapbuttonsetbitmaplabel} + +\membersection{wxBitmapButton::GetBitmapSelected}\label{wxbitmapbuttongetbitmapselected} + +\constfunc{wxBitmap\&}{GetBitmapSelected}{\void} +\func{wxBitmap\&}{GetBitmapSelected}{\void} + +Returns the bitmap for the pushed button state, may be invalid. + +\wxheading{Return value} + +A reference to the selected state bitmap. + +\wxheading{See also} + +\helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected} + + \membersection{wxBitmapButton::GetBitmapSelected}\label{wxbitmapbuttongetbitmapselected} \constfunc{wxBitmap\&}{GetBitmapSelected}{\void} @@ -173,6 +246,7 @@ A reference to the selected state bitmap. \helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected} + \membersection{wxBitmapButton::SetBitmapDisabled}\label{wxbitmapbuttonsetbitmapdisabled} \func{void}{SetBitmapDisabled}{\param{const wxBitmap\& }{bitmap}} @@ -190,6 +264,7 @@ Sets the bitmap for the disabled button appearance. \helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected},\rtfsp \helpref{wxBitmapButton::SetBitmapFocus}{wxbitmapbuttonsetbitmapfocus} + \membersection{wxBitmapButton::SetBitmapFocus}\label{wxbitmapbuttonsetbitmapfocus} \func{void}{SetBitmapFocus}{\param{const wxBitmap\& }{bitmap}} @@ -207,6 +282,19 @@ Sets the bitmap for the button appearance when it has the keyboard focus. \helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected},\rtfsp \helpref{wxBitmapButton::SetBitmapDisabled}{wxbitmapbuttonsetbitmapdisabled} + +\membersection{wxBitmapButton::SetBitmapHover}\label{wxbitmapbuttonsetbitmaphover} + +\func{void}{SetBitmapHover}{\param{const wxBitmap\& }{bitmap}} + +Sets the bitmap to be shown when the mouse is over the button. + +\newsince{2.7.0} and the hover bitmap is currently only supported in wxMSW. + +\wxheading{See also} + +\helpref{wxBitmapButton::GetBitmapHover}{wxbitmapbuttongetbitmaphover} + \membersection{wxBitmapButton::SetBitmapLabel}\label{wxbitmapbuttonsetbitmaplabel} \func{void}{SetBitmapLabel}{\param{const wxBitmap\& }{bitmap}} @@ -226,6 +314,25 @@ if no other bitmaps are provided. \helpref{wxBitmapButton::GetBitmapLabel}{wxbitmapbuttongetbitmaplabel} + +\membersection{wxBitmapButton::SetBitmapSelected}\label{wxbitmapbuttonsetbitmapselected} + +\func{void}{SetBitmapSelected}{\param{const wxBitmap\& }{bitmap}} + +Sets the bitmap for the selected (depressed) button appearance. + +\wxheading{Parameters} + +\docparam{bitmap}{The bitmap to set.} + +\wxheading{See also} + +\helpref{wxBitmapButton::GetBitmapSelected}{wxbitmapbuttongetbitmapselected},\rtfsp +\helpref{wxBitmapButton::SetBitmapLabel}{wxbitmapbuttonsetbitmaplabel},\rtfsp +\helpref{wxBitmapButton::SetBitmapFocus}{wxbitmapbuttonsetbitmapfocus},\rtfsp +\helpref{wxBitmapButton::SetBitmapDisabled}{wxbitmapbuttonsetbitmapdisabled} + + \membersection{wxBitmapButton::SetBitmapSelected}\label{wxbitmapbuttonsetbitmapselected} \func{void}{SetBitmapSelected}{\param{const wxBitmap\& }{bitmap}}