940cc794a7
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@50596 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
87 lines
2.7 KiB
TeX
87 lines
2.7 KiB
TeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
%% Name: bitmaptglbtn.tex
|
|
%% Purpose: wxBitmapToggleButton documentation
|
|
%% Author: Robert Roebling
|
|
%% License: wxWindows license
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\section{\class{wxBitmapToggleButton}}\label{wxbitmaptogglebutton}
|
|
|
|
wxBitmapToggleButton is a \helpref{wxToggleButton}{wxtogglebutton}
|
|
that contains a bitmap instead of text.
|
|
|
|
This control emits an update UI event.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxControl}{wxcontrol}\\
|
|
\helpref{wxWindow}{wxwindow}\\
|
|
\helpref{wxEvtHandler}{wxevthandler}\\
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/tglbtn.h>
|
|
|
|
\wxheading{Library}
|
|
|
|
\helpref{wxCore}{librarieslist}
|
|
|
|
\wxheading{Window styles}
|
|
|
|
There are no special styles for wxBitmapToggleButton.
|
|
|
|
\wxheading{Event handling}
|
|
|
|
\twocolwidtha{7cm}
|
|
\begin{twocollist}\itemsep=0pt
|
|
\twocolitem{{\bf EVT\_TOGGLEBUTTON(id, func)}}{Handles a toggle button click event.}
|
|
\end{twocollist}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxBitmapToggleButton::wxBitmapToggleButton}\label{wxbitmaptogglebuttonconstr}
|
|
|
|
\func{}{wxBitmapToggleButton}{\void}
|
|
|
|
Default constructor.
|
|
|
|
\func{}{wxBitmapToggleButton}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
|
|
\param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
|
|
\param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
|
|
\param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
|
|
|
|
Constructor, creating and showing a toggle button with the bitmap {\it label}.
|
|
Internally calls Create().
|
|
|
|
\membersection{wxBitmapToggleButton::Create}\label{wxbitmaptogglebuttoncreate}
|
|
|
|
\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
|
|
\param{const wxBitmap\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
|
|
\param{const wxSize\& }{size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
|
|
\param{const wxValidator\& }{val}, \param{const wxString\& }{name = ``checkBox"}}
|
|
|
|
Create method for two-step construction.
|
|
|
|
\membersection{wxBitmapToggleButton::GetValue}\label{wxbitmaptogglebuttongetvalue}
|
|
|
|
\constfunc{bool}{GetValue}{\void}
|
|
|
|
Gets the state of the toggle button.
|
|
|
|
\wxheading{Return value}
|
|
|
|
Returns {\tt true} if it is pressed, {\tt false} otherwise.
|
|
|
|
\membersection{wxBitmapToggleButton::SetValue}\label{wxbitmaptogglebuttonsetvalue}
|
|
|
|
\func{void}{SetValue}{\param{bool}{ state}}
|
|
|
|
Sets the toggle button to the given state. This does not cause a
|
|
{\tt EVT\_TOGGLEBUTTON} event to be emitted.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{state}{If {\tt true}, the button is pressed.}
|
|
|