\section{Tk\-Check\-Button Class Reference}
\label{class_tk_check_button}\index{TkCheckButton@{TkCheckButton}}
Represent \char`\"{}checkbutton\char`\"{} widget.  


{\tt \#include $<$tk\_\-checkbutton.h$>$}

Inheritance diagram for Tk\-Check\-Button::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=12cm]{class_tk_check_button}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
const {\bf Ptr}$<$ Tk\-Option\-Def $>$ $\ast$ {\bf get\-Option\-All} () const 
\begin{CompactList}\small\item\em Returns array of all avaliable options valid for specific widget type. \item\end{CompactList}\item 
const char $\ast$ {\bf get\-Type} () const 
\begin{CompactList}\small\item\em Return type of class. \item\end{CompactList}\item 
const char $\ast$ {\bf get\-Tk\-Class} () const 
\begin{CompactList}\small\item\em Returns type of widget. \item\end{CompactList}\item 
{\bf TObject} $\ast$ {\bf clone} ()
\begin{CompactList}\small\item\em Create deep-clone of object. \item\end{CompactList}\item 
void {\bf add\-Value\-Listener} ({\bf Tcl\-Var\-Listener} $\ast$listener)
\item 
void {\bf set\-Selected} (bool value)
\item 
bool {\bf is\-Selected} () const 
\item 
void {\bf set\-Text} (const string \&text)
\begin{CompactList}\small\item\em Sets text of widget. \item\end{CompactList}\item 
const string \& {\bf get\-Text} () const 
\begin{CompactList}\small\item\em Gets content of widget in text form. \item\end{CompactList}\item 
void {\bf set\-Variable} ({\bf Tcl\-Bool\-Var} $\ast$var)
\item 
{\bf Tcl\-Var} $\ast$ {\bf get\-Default\-Var} ()
\item 
void {\bf set\-Events\-Enabled} (bool value)
\begin{CompactList}\small\item\em Enables or disables events on widget. \item\end{CompactList}\item 
void {\bf set\-Background\-Color} (Tk\-Color\-Option $\ast$color)
\begin{CompactList}\small\item\em Set background color. \item\end{CompactList}\item 
{\bf Ptr}$<$ Tk\-Color\-Option $>$ \& {\bf get\-Background\-Color} () const 
\begin{CompactList}\small\item\em Returns background color of widget. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Represent \char`\"{}checkbutton\char`\"{} widget. 

Tk\-Check\-Button is bind to inner bool variable, via which can user set Tk\-Check\-Button checked/unchecked. Tk\-Check\-Button also contains some methods to retrieve/set this variable.

\begin{Desc}
\item[Date:]01-12-2006\end{Desc}
\begin{Desc}
\item[Author:]Ondrej Svejdar\end{Desc}
\begin{Desc}
\item[{\bf Todo}]\end{Desc}
\begin{Desc}
\item[{\bf Bug}]\end{Desc}




\subsection{Member Function Documentation}
\index{TkCheckButton@{Tk\-Check\-Button}!addValueListener@{addValueListener}}
\index{addValueListener@{addValueListener}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Check\-Button::add\-Value\-Listener ({\bf Tcl\-Var\-Listener} $\ast$ {\em listener})}\label{class_tk_check_button_5b4439b7801b5a75fa7dc2ba391a55c0}


Add listener to inner variable ({\bf Tcl\-Bool\-Var}{\rm (p.\,\pageref{class_tcl_bool_var})}) \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em listener}]listener \end{description}
\end{Desc}
\index{TkCheckButton@{Tk\-Check\-Button}!clone@{clone}}
\index{clone@{clone}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf TObject} $\ast$ Tk\-Check\-Button::clone ()\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_a57a4061e6b07e21891be7a967c53f91}


Create deep-clone of object. 

\begin{Desc}
\item[Returns:]deep-clone of object \end{Desc}


Implements {\bf Tk\-Base} {\rm (p.\,\pageref{class_tk_base_eeacc64c3f35a0f65819595fa0f5e3c6})}.\index{TkCheckButton@{Tk\-Check\-Button}!getBackgroundColor@{getBackgroundColor}}
\index{getBackgroundColor@{getBackgroundColor}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ptr}$<$ Tk\-Color\-Option $>$ \& Tk\-Check\-Button::get\-Background\-Color () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_03c0a2d825c5a3dce8fcd1404699eeca}


Returns background color of widget. 

\begin{Desc}
\item[Returns:]background color \end{Desc}


Implements {\bf Tk\-Base} {\rm (p.\,\pageref{class_tk_base_104d02d466da4b0894a099b72b12cb07})}.\index{TkCheckButton@{Tk\-Check\-Button}!getDefaultVar@{getDefaultVar}}
\index{getDefaultVar@{getDefaultVar}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Tcl\-Var} $\ast$ Tk\-Check\-Button::get\-Default\-Var ()\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_2d08d07ba1c3628e6b4bbe9cdd9652c7}


\begin{Desc}
\item[Returns:]default inner variable \end{Desc}


Implements {\bf IInner\-Variable} {\rm (p.\,\pageref{class_i_inner_variable_de0c2632ff3018462082e183674c24d8})}.\index{TkCheckButton@{Tk\-Check\-Button}!getOptionAll@{getOptionAll}}
\index{getOptionAll@{getOptionAll}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf Ptr}$<$ Tk\-Option\-Def $>$ $\ast$ Tk\-Check\-Button::get\-Option\-All () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_9fee034d6164ec34a26d3a3b98a9e61b}


Returns array of all avaliable options valid for specific widget type. 

\begin{Desc}
\item[Returns:]array of options \end{Desc}


Implements {\bf Tk\-Base} {\rm (p.\,\pageref{class_tk_base_89d93c80ff7a528f833e2ea45f1a10f6})}.\index{TkCheckButton@{Tk\-Check\-Button}!getText@{getText}}
\index{getText@{getText}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string \& Tk\-Check\-Button::get\-Text () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_d9082c02796bc7437e6e9eda2e7cb99f}


Gets content of widget in text form. 

\begin{Desc}
\item[Returns:]text content \end{Desc}


Implements {\bf ITextable} {\rm (p.\,\pageref{class_i_textable_2049c2afc0901cd5431316a2a5ef7700})}.\index{TkCheckButton@{Tk\-Check\-Button}!getTkClass@{getTkClass}}
\index{getTkClass@{getTkClass}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Tk\-Check\-Button::get\-Tk\-Class () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_4c84eb8aa0f24934d8c12ee757f622c1}


Returns type of widget. 

Example values are \char`\"{}button\char`\"{},\char`\"{}menu\char`\"{},\char`\"{}entry\char`\"{} etc. \begin{Desc}
\item[Returns:]widget type \end{Desc}


Implements {\bf Tk\-Base} {\rm (p.\,\pageref{class_tk_base_2e57ed30603b2d16c02812df67e1f2fd})}.\index{TkCheckButton@{Tk\-Check\-Button}!getType@{getType}}
\index{getType@{getType}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Tk\-Check\-Button::get\-Type () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_1413702cbda682553d02b08afccebfc3}


Return type of class. 

\begin{Desc}
\item[Returns:]type of class \end{Desc}


Reimplemented from {\bf TXml\-Object} {\rm (p.\,\pageref{class_t_xml_object_1413702cbda682553d02b08afccebfc3})}.\index{TkCheckButton@{Tk\-Check\-Button}!isSelected@{isSelected}}
\index{isSelected@{isSelected}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Tk\-Check\-Button::is\-Selected () const}\label{class_tk_check_button_178130cb830817a99e221caa0abcb5b9}


\begin{Desc}
\item[Returns:]true if checkbutton is checked \end{Desc}
\index{TkCheckButton@{Tk\-Check\-Button}!setBackgroundColor@{setBackgroundColor}}
\index{setBackgroundColor@{setBackgroundColor}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Check\-Button::set\-Background\-Color (Tk\-Color\-Option $\ast$ {\em color})\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_8afd70e6e3b95665d0c013f93c7fb9c5}


Set background color. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em color}]color value \end{description}
\end{Desc}


Implements {\bf Tk\-Base} {\rm (p.\,\pageref{class_tk_base_5b832cf60b0c72679e8460a876376226})}.\index{TkCheckButton@{Tk\-Check\-Button}!setEventsEnabled@{setEventsEnabled}}
\index{setEventsEnabled@{setEventsEnabled}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Check\-Button::set\-Events\-Enabled (bool {\em value})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{class_tk_check_button_d8f9371e9c83226baf78ad493f2d2598}


Enables or disables events on widget. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]if true events will be enabled \end{description}
\end{Desc}


Reimplemented from {\bf Tk\-Base} {\rm (p.\,\pageref{class_tk_base_d8f9371e9c83226baf78ad493f2d2598})}.\index{TkCheckButton@{Tk\-Check\-Button}!setSelected@{setSelected}}
\index{setSelected@{setSelected}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Check\-Button::set\-Selected (bool {\em value})}\label{class_tk_check_button_2a719312cb24e016b122d73e7e3da1fe}


Force checkbutton to be checked/unchecked \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]if true, button will be checked \end{description}
\end{Desc}
\index{TkCheckButton@{Tk\-Check\-Button}!setText@{setText}}
\index{setText@{setText}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Check\-Button::set\-Text (const string \& {\em text})\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_check_button_d1a82a922df991ada381313617e68b88}


Sets text of widget. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]text to set \end{description}
\end{Desc}


Implements {\bf ITextable} {\rm (p.\,\pageref{class_i_textable_8ff10158413b29d17006a6b0d08093d2})}.\index{TkCheckButton@{Tk\-Check\-Button}!setVariable@{setVariable}}
\index{setVariable@{setVariable}!TkCheckButton@{Tk\-Check\-Button}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Check\-Button::set\-Variable ({\bf Tcl\-Bool\-Var} $\ast$ {\em var})}\label{class_tk_check_button_637b0b5864afee589eefaf5db40961c8}


Replace default inner variable with user-defined one \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em var}]variable to be set \end{description}
\end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
H:/projs/dot\-NET/eda/src/tk/gui/tk\_\-checkbutton.h\item 
H:/projs/dot\-NET/eda/src/tk/gui/tk\_\-checkbutton.cpp\end{CompactItemize}
