\section{Tk\-Base Class Reference}
\label{class_tk_base}\index{TkBase@{TkBase}}
Base class for all type of widgets.  


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

Inheritance diagram for Tk\-Base::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=12cm]{class_tk_base}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Ptr}$<$ {\bf TXml\-Object} $>$ \& {\bf get\-Constraints} ()
\begin{CompactList}\small\item\em Return layout constraints (if any). \item\end{CompactList}\item 
void {\bf set\-Constraints} ({\bf Ptr}$<$ {\bf TXml\-Object} $>$ \&constraints)
\begin{CompactList}\small\item\em Set layout constrains. \item\end{CompactList}\item 
void {\bf invalidate} ()
\begin{CompactList}\small\item\em Forces layout to redisplay widget. \item\end{CompactList}\item 
{\bf Ptr}$<$ {\bf Tcl\-Interp} $>$ \& {\bf get\-Interp} ()
\begin{CompactList}\small\item\em Returns reference to interpret, in which was widget created. \item\end{CompactList}\item 
const t\_\-option\_\-set \& {\bf get\-Option\-Set} () const 
\begin{CompactList}\small\item\em Returns option set. \item\end{CompactList}\item 
bool {\bf is\-Created} () const 
\begin{CompactList}\small\item\em Test if widget is created. \item\end{CompactList}\item 
Tk\_\-Window {\bf get\-Window} () const 
\begin{CompactList}\small\item\em Returns Tk identifier of the widget window. \item\end{CompactList}\item 
{\bf Tk\-Container} $\ast$ {\bf get\-Parent} ()
\begin{CompactList}\small\item\em Returns parent of widget (if any) otherwise NULL. \item\end{CompactList}\item 
Tk\_\-Uid {\bf get\-Uid} () const 
\begin{CompactList}\small\item\em Returns Tk unique widget identifier. \item\end{CompactList}\item 
const string \& {\bf get\-Generated\-Id} () const 
\begin{CompactList}\small\item\em Returns unique ID, generated for widget. \item\end{CompactList}\item 
const string \& {\bf get\-Name} () const 
\begin{CompactList}\small\item\em Return user-defined name for widger. \item\end{CompactList}\item 
virtual const char $\ast$ {\bf get\-Tk\-Class} () const =0
\begin{CompactList}\small\item\em Returns type of widget. \item\end{CompactList}\item 
virtual const {\bf Ptr}$<$ Tk\-Option\-Def $>$ $\ast$ {\bf get\-Option\-All} () const =0
\begin{CompactList}\small\item\em Returns array of all avaliable options valid for specific widget type. \item\end{CompactList}\item 
bool {\bf compare\-To} ({\bf TObject} $\ast$object) const 
\begin{CompactList}\small\item\em Compare two objects. \item\end{CompactList}\item 
{\bf TObject} $\ast$ {\bf clone} ()=0
\begin{CompactList}\small\item\em Create deep-clone of object. \item\end{CompactList}\item 
{\bf Ptr}$<$ {\bf TXml\-Object} $>$ \& {\bf get\-Tag} ()
\begin{CompactList}\small\item\em Return tag. \item\end{CompactList}\item 
void {\bf set\-Tag} ({\bf TXml\-Object} $\ast$tag)
\begin{CompactList}\small\item\em Sets tag. \item\end{CompactList}\item 
{\bf Tk\-Base} ({\bf Ptr}$<$ {\bf Tcl\-Interp} $>$ \&interp)
\item 
virtual void {\bf create} ()\label{class_tk_base_21140cdbfc5adac008803f2a52633d13}

\begin{CompactList}\small\item\em Creates widget in shell. \item\end{CompactList}\item 
void {\bf set\-Option} (const {\bf Ptr}$<$ Tk\-Option\-Def $>$ \&def, {\bf TXml\-Object} $\ast$option)
\begin{CompactList}\small\item\em Sets value of one widget property. \item\end{CompactList}\item 
Tcl\_\-Obj $\ast$ {\bf get\-Option} (const {\bf Ptr}$<$ Tk\-Option\-Def $>$ \&def) const 
\begin{CompactList}\small\item\em Returns value of one widget property as Tcl\_\-Obj. \item\end{CompactList}\item 
const string \& {\bf get\-Str\-Option} (const {\bf Ptr}$<$ Tk\-Option\-Def $>$ \&def) const 
\begin{CompactList}\small\item\em Works just like get\-Option, but result is presented as string. \item\end{CompactList}\item 
void {\bf set\-Raw\-Option} (const string \&option\-Name, const string \&value)
\begin{CompactList}\small\item\em Set widget property in raw (string) format. Should be avoided. \item\end{CompactList}\item 
void {\bf set\-Name} (const string \&name)
\begin{CompactList}\small\item\em Set user-defined name for widget. \item\end{CompactList}\item 
virtual void {\bf set\-Events\-Enabled} (bool value)
\begin{CompactList}\small\item\em Enables or disables events on widget. \item\end{CompactList}\item 
bool {\bf is\-Events\-Enabled} () const 
\begin{CompactList}\small\item\em Returns state of event generation. \item\end{CompactList}\item 
const string \& {\bf to\-String} () const 
\begin{CompactList}\small\item\em Simple text dump. \item\end{CompactList}\item 
virtual void {\bf set\-Background\-Color} (Tk\-Color\-Option $\ast$color)=0
\begin{CompactList}\small\item\em Set background color. \item\end{CompactList}\item 
virtual {\bf Ptr}$<$ Tk\-Color\-Option $>$ \& {\bf get\-Background\-Color} () const =0
\begin{CompactList}\small\item\em Returns background color of widget. \item\end{CompactList}\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Tk\-Container}\label{class_tk_base_9f1fbce5fd1b886e4237b46fa44de549}

\item 
class {\bf Tk\-Top\-Level}\label{class_tk_base_0f44444d608a211c76519f1a7123899c}

\end{CompactItemize}


\subsection{Detailed Description}
Base class for all type of widgets. 

\begin{Desc}
\item[Date:]01-11-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{Constructor \& Destructor Documentation}
\index{TkBase@{Tk\-Base}!TkBase@{TkBase}}
\index{TkBase@{TkBase}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Tk\-Base::Tk\-Base ({\bf Ptr}$<$ {\bf Tcl\-Interp} $>$ \& {\em interp})}\label{class_tk_base_90e345d3143fbbf680c8a524bc0dbab6}


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em interp}]interpreter \end{description}
\end{Desc}


\subsection{Member Function Documentation}
\index{TkBase@{Tk\-Base}!clone@{clone}}
\index{clone@{clone}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf TObject}$\ast$ Tk\-Base::clone ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{class_tk_base_eeacc64c3f35a0f65819595fa0f5e3c6}


Create deep-clone of object. 

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


Reimplemented from {\bf TObject} {\rm (p.\,\pageref{class_t_object_a57a4061e6b07e21891be7a967c53f91})}.

Implemented in {\bf Tk\-Button} {\rm (p.\,\pageref{class_tk_button_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Check\-Button} {\rm (p.\,\pageref{class_tk_check_button_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Entry} {\rm (p.\,\pageref{class_tk_entry_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Frame} {\rm (p.\,\pageref{class_tk_frame_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Label} {\rm (p.\,\pageref{class_tk_label_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Listbox} {\rm (p.\,\pageref{class_tk_listbox_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Menu} {\rm (p.\,\pageref{class_tk_menu_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Radio\-Button} {\rm (p.\,\pageref{class_tk_radio_button_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Scroll\-Bar} {\rm (p.\,\pageref{class_tk_scroll_bar_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Spin\-Box} {\rm (p.\,\pageref{class_tk_spin_box_a57a4061e6b07e21891be7a967c53f91})}, {\bf Tk\-Text} {\rm (p.\,\pageref{class_tk_text_a57a4061e6b07e21891be7a967c53f91})}, and {\bf Tk\-Top\-Level} {\rm (p.\,\pageref{class_tk_top_level_a57a4061e6b07e21891be7a967c53f91})}.\index{TkBase@{Tk\-Base}!compareTo@{compareTo}}
\index{compareTo@{compareTo}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Tk\-Base::compare\-To ({\bf TObject} $\ast$ {\em object}) const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{class_tk_base_982458dfa9736a7c6ca22b3b6b8e9a1d}


Compare two objects. 

\begin{Desc}
\item[Note:]If method is not overriden it throws {\bf Exception\-No\-Implementation}{\rm (p.\,\pageref{class_exception_no_implementation})} when called. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em object}]pointer to another object \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true if object are equal \end{Desc}


Reimplemented from {\bf TObject} {\rm (p.\,\pageref{class_t_object_982458dfa9736a7c6ca22b3b6b8e9a1d})}.\index{TkBase@{Tk\-Base}!getBackgroundColor@{getBackgroundColor}}
\index{getBackgroundColor@{getBackgroundColor}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Ptr}$<$Tk\-Color\-Option$>$\& Tk\-Base::get\-Background\-Color () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{class_tk_base_104d02d466da4b0894a099b72b12cb07}


Returns background color of widget. 

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


Implemented in {\bf Tk\-Button} {\rm (p.\,\pageref{class_tk_button_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Check\-Button} {\rm (p.\,\pageref{class_tk_check_button_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Entry} {\rm (p.\,\pageref{class_tk_entry_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Frame} {\rm (p.\,\pageref{class_tk_frame_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Label} {\rm (p.\,\pageref{class_tk_label_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Listbox} {\rm (p.\,\pageref{class_tk_listbox_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Menu} {\rm (p.\,\pageref{class_tk_menu_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Radio\-Button} {\rm (p.\,\pageref{class_tk_radio_button_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Scroll\-Bar} {\rm (p.\,\pageref{class_tk_scroll_bar_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Spin\-Box} {\rm (p.\,\pageref{class_tk_spin_box_03c0a2d825c5a3dce8fcd1404699eeca})}, {\bf Tk\-Text} {\rm (p.\,\pageref{class_tk_text_03c0a2d825c5a3dce8fcd1404699eeca})}, and {\bf Tk\-Top\-Level} {\rm (p.\,\pageref{class_tk_top_level_03c0a2d825c5a3dce8fcd1404699eeca})}.\index{TkBase@{Tk\-Base}!getConstraints@{getConstraints}}
\index{getConstraints@{getConstraints}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ptr}$<$ {\bf TXml\-Object} $>$ \& Tk\-Base::get\-Constraints ()}\label{class_tk_base_1d9e4f64492ff047726a96ddf4b8ca11}


Return layout constraints (if any). 

In case there aren't any returns empty {\bf TXml\-Object}{\rm (p.\,\pageref{class_t_xml_object})} \begin{Desc}
\item[Returns:]layout constraints \end{Desc}
\index{TkBase@{Tk\-Base}!getGeneratedId@{getGeneratedId}}
\index{getGeneratedId@{getGeneratedId}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string\& Tk\-Base::get\-Generated\-Id () const\hspace{0.3cm}{\tt  [inline]}}\label{class_tk_base_b49fec07d397bf6621c3911a36821d3c}


Returns unique ID, generated for widget. 

\begin{Desc}
\item[Returns:]widget generated id \end{Desc}
\index{TkBase@{Tk\-Base}!getInterp@{getInterp}}
\index{getInterp@{getInterp}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ptr}$<$ {\bf Tcl\-Interp} $>$ \& Tk\-Base::get\-Interp ()}\label{class_tk_base_0a2509a86fe7b2bb7dd0e1a312e02e61}


Returns reference to interpret, in which was widget created. 

\begin{Desc}
\item[Returns:]reference to interpret \end{Desc}
\index{TkBase@{Tk\-Base}!getName@{getName}}
\index{getName@{getName}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string \& Tk\-Base::get\-Name () const}\label{class_tk_base_233fbd39cb42a5f4340815d2190fd55d}


Return user-defined name for widger. 

\begin{Desc}
\item[Returns:]name of widget \end{Desc}
\index{TkBase@{Tk\-Base}!getOption@{getOption}}
\index{getOption@{getOption}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Tcl\_\-Obj $\ast$ Tk\-Base::get\-Option (const {\bf Ptr}$<$ Tk\-Option\-Def $>$ \& {\em def}) const}\label{class_tk_base_bdb1ff32c5190b189072e0c6ec7b9d3d}


Returns value of one widget property as Tcl\_\-Obj. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em def}]property definition, usually static member of specific widget \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]property value \end{Desc}
\index{TkBase@{Tk\-Base}!getOptionAll@{getOptionAll}}
\index{getOptionAll@{getOptionAll}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual const {\bf Ptr}$<$Tk\-Option\-Def$>$$\ast$ Tk\-Base::get\-Option\-All () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{class_tk_base_89d93c80ff7a528f833e2ea45f1a10f6}


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

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


Implemented in {\bf Tk\-Button} {\rm (p.\,\pageref{class_tk_button_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Check\-Button} {\rm (p.\,\pageref{class_tk_check_button_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Entry} {\rm (p.\,\pageref{class_tk_entry_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Frame} {\rm (p.\,\pageref{class_tk_frame_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Label} {\rm (p.\,\pageref{class_tk_label_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Listbox} {\rm (p.\,\pageref{class_tk_listbox_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Menu} {\rm (p.\,\pageref{class_tk_menu_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Radio\-Button} {\rm (p.\,\pageref{class_tk_radio_button_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Scroll\-Bar} {\rm (p.\,\pageref{class_tk_scroll_bar_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Spin\-Box} {\rm (p.\,\pageref{class_tk_spin_box_9fee034d6164ec34a26d3a3b98a9e61b})}, {\bf Tk\-Text} {\rm (p.\,\pageref{class_tk_text_9fee034d6164ec34a26d3a3b98a9e61b})}, and {\bf Tk\-Top\-Level} {\rm (p.\,\pageref{class_tk_top_level_9fee034d6164ec34a26d3a3b98a9e61b})}.\index{TkBase@{Tk\-Base}!getOptionSet@{getOptionSet}}
\index{getOptionSet@{getOptionSet}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const Tk\-Base::t\_\-option\_\-set \& Tk\-Base::get\-Option\-Set () const}\label{class_tk_base_2de609d33cff9ed990a75715c41851a3}


Returns option set. 

\begin{Desc}
\item[Returns:]option set \end{Desc}
\index{TkBase@{Tk\-Base}!getParent@{getParent}}
\index{getParent@{getParent}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Tk\-Container} $\ast$ Tk\-Base::get\-Parent ()}\label{class_tk_base_efab9fdcec9679867a353c35583386bc}


Returns parent of widget (if any) otherwise NULL. 

\begin{Desc}
\item[Returns:]pointer to parent widget \end{Desc}
\index{TkBase@{Tk\-Base}!getStrOption@{getStrOption}}
\index{getStrOption@{getStrOption}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string \& Tk\-Base::get\-Str\-Option (const {\bf Ptr}$<$ Tk\-Option\-Def $>$ \& {\em def}) const}\label{class_tk_base_a2a4dc21e7888c2d0a63420aeedd400d}


Works just like get\-Option, but result is presented as string. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em def}]property definition, usually static member of specific widget \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]property value \end{Desc}
\index{TkBase@{Tk\-Base}!getTag@{getTag}}
\index{getTag@{getTag}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ptr}$<$ {\bf TXml\-Object} $>$ \& Tk\-Base::get\-Tag ()}\label{class_tk_base_f31175101862e709c950b110b4eb9ac4}


Return tag. 

Each instance of class Tk\-Base can have one \char`\"{}general purpose\char`\"{} object - tag, it is free to use for application programmer.

\begin{Desc}
\item[Returns:]reference to tag (if any) or empty object \end{Desc}
\index{TkBase@{Tk\-Base}!getTkClass@{getTkClass}}
\index{getTkClass@{getTkClass}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual const char$\ast$ Tk\-Base::get\-Tk\-Class () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{class_tk_base_2e57ed30603b2d16c02812df67e1f2fd}


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}


Implemented in {\bf Tk\-Button} {\rm (p.\,\pageref{class_tk_button_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Check\-Button} {\rm (p.\,\pageref{class_tk_check_button_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Entry} {\rm (p.\,\pageref{class_tk_entry_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Frame} {\rm (p.\,\pageref{class_tk_frame_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Label} {\rm (p.\,\pageref{class_tk_label_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Listbox} {\rm (p.\,\pageref{class_tk_listbox_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Menu} {\rm (p.\,\pageref{class_tk_menu_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Radio\-Button} {\rm (p.\,\pageref{class_tk_radio_button_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Scroll\-Bar} {\rm (p.\,\pageref{class_tk_scroll_bar_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Spin\-Box} {\rm (p.\,\pageref{class_tk_spin_box_4c84eb8aa0f24934d8c12ee757f622c1})}, {\bf Tk\-Text} {\rm (p.\,\pageref{class_tk_text_4c84eb8aa0f24934d8c12ee757f622c1})}, and {\bf Tk\-Top\-Level} {\rm (p.\,\pageref{class_tk_top_level_4c84eb8aa0f24934d8c12ee757f622c1})}.\index{TkBase@{Tk\-Base}!getUid@{getUid}}
\index{getUid@{getUid}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Tk\_\-Uid Tk\-Base::get\-Uid () const}\label{class_tk_base_31e1eae6584048874a361983655e9a75}


Returns Tk unique widget identifier. 

\begin{Desc}
\item[Note:]This uid is sequenceof chars, equal to widget's name. Tk uses reference comparsion to hurry things up. \end{Desc}
\begin{Desc}
\item[Returns:]widget uid \end{Desc}
\index{TkBase@{Tk\-Base}!getWindow@{getWindow}}
\index{getWindow@{getWindow}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Tk\_\-Window Tk\-Base::get\-Window () const}\label{class_tk_base_6b68b02b635e5d05bbc08405adfb2387}


Returns Tk identifier of the widget window. 

That means toplevel window in which is widget placed. \begin{Desc}
\item[Returns:]Tk widget identifier \end{Desc}
\index{TkBase@{Tk\-Base}!invalidate@{invalidate}}
\index{invalidate@{invalidate}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::invalidate ()}\label{class_tk_base_8fb1128ae75dbf363456c845a54971ed}


Forces layout to redisplay widget. 

Does nothing if widget is not displayed. \index{TkBase@{Tk\-Base}!isCreated@{isCreated}}
\index{isCreated@{isCreated}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Tk\-Base::is\-Created () const}\label{class_tk_base_76541d07bb2426063e40a9e7631dd678}


Test if widget is created. 

\begin{Desc}
\item[Returns:]true if widget created in shell \end{Desc}
\index{TkBase@{Tk\-Base}!isEventsEnabled@{isEventsEnabled}}
\index{isEventsEnabled@{isEventsEnabled}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Tk\-Base::is\-Events\-Enabled () const}\label{class_tk_base_df979f259f53adf3b4a00e3bc7486864}


Returns state of event generation. 

\begin{Desc}
\item[Returns:]true if events are enabled \end{Desc}
\index{TkBase@{Tk\-Base}!setBackgroundColor@{setBackgroundColor}}
\index{setBackgroundColor@{setBackgroundColor}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Tk\-Base::set\-Background\-Color (Tk\-Color\-Option $\ast$ {\em color})\hspace{0.3cm}{\tt  [pure virtual]}}\label{class_tk_base_5b832cf60b0c72679e8460a876376226}


Set background color. 

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


Implemented in {\bf Tk\-Button} {\rm (p.\,\pageref{class_tk_button_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Check\-Button} {\rm (p.\,\pageref{class_tk_check_button_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Entry} {\rm (p.\,\pageref{class_tk_entry_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Frame} {\rm (p.\,\pageref{class_tk_frame_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Label} {\rm (p.\,\pageref{class_tk_label_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Listbox} {\rm (p.\,\pageref{class_tk_listbox_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Menu} {\rm (p.\,\pageref{class_tk_menu_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Radio\-Button} {\rm (p.\,\pageref{class_tk_radio_button_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Scroll\-Bar} {\rm (p.\,\pageref{class_tk_scroll_bar_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Spin\-Box} {\rm (p.\,\pageref{class_tk_spin_box_8afd70e6e3b95665d0c013f93c7fb9c5})}, {\bf Tk\-Text} {\rm (p.\,\pageref{class_tk_text_8afd70e6e3b95665d0c013f93c7fb9c5})}, and {\bf Tk\-Top\-Level} {\rm (p.\,\pageref{class_tk_top_level_8afd70e6e3b95665d0c013f93c7fb9c5})}.\index{TkBase@{Tk\-Base}!setConstraints@{setConstraints}}
\index{setConstraints@{setConstraints}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::set\-Constraints ({\bf Ptr}$<$ {\bf TXml\-Object} $>$ \& {\em constraints})}\label{class_tk_base_3f98fb4a9e3864169805e2ab628654b3}


Set layout constrains. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em constraints}]layout constrainst \end{description}
\end{Desc}
\index{TkBase@{Tk\-Base}!setEventsEnabled@{setEventsEnabled}}
\index{setEventsEnabled@{setEventsEnabled}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::set\-Events\-Enabled (bool {\em value})\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_base_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 in {\bf Tk\-Check\-Button} {\rm (p.\,\pageref{class_tk_check_button_d8f9371e9c83226baf78ad493f2d2598})}, {\bf Tk\-Entry} {\rm (p.\,\pageref{class_tk_entry_d8f9371e9c83226baf78ad493f2d2598})}, {\bf Tk\-Listbox} {\rm (p.\,\pageref{class_tk_listbox_d8f9371e9c83226baf78ad493f2d2598})}, and {\bf Tk\-Spin\-Box} {\rm (p.\,\pageref{class_tk_spin_box_d8f9371e9c83226baf78ad493f2d2598})}.\index{TkBase@{Tk\-Base}!setName@{setName}}
\index{setName@{setName}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::set\-Name (const string \& {\em name})}\label{class_tk_base_c4d0d23a36c284bb27f63fbbdd85fcdb}


Set user-defined name for widget. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]user-defined name for widget \end{description}
\end{Desc}
\index{TkBase@{Tk\-Base}!setOption@{setOption}}
\index{setOption@{setOption}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::set\-Option (const {\bf Ptr}$<$ Tk\-Option\-Def $>$ \& {\em def}, {\bf TXml\-Object} $\ast$ {\em option})}\label{class_tk_base_0654623d622516994fbe990a46c17fba}


Sets value of one widget property. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em def}]option definition, definition of this property \item[{\em option}]value \end{description}
\end{Desc}
\index{TkBase@{Tk\-Base}!setRawOption@{setRawOption}}
\index{setRawOption@{setRawOption}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::set\-Raw\-Option (const string \& {\em option\-Name}, const string \& {\em value})}\label{class_tk_base_57f7bfbce317b40e5633008d34979e1b}


Set widget property in raw (string) format. Should be avoided. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em option\-Name}]name of property \item[{\em value}]value \end{description}
\end{Desc}
\index{TkBase@{Tk\-Base}!setTag@{setTag}}
\index{setTag@{setTag}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Base::set\-Tag ({\bf TXml\-Object} $\ast$ {\em tag})}\label{class_tk_base_47006127db0a0bf4cee6de8af320ff96}


Sets tag. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em tag}]value \end{description}
\end{Desc}
\index{TkBase@{Tk\-Base}!toString@{toString}}
\index{toString@{toString}!TkBase@{Tk\-Base}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string \& Tk\-Base::to\-String () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_base_ca11bae3941982bbc2db10b06d450336}


Simple text dump. 

\begin{Desc}
\item[Returns:]if not overriden, it returns type of class \end{Desc}


Reimplemented from {\bf TObject} {\rm (p.\,\pageref{class_t_object_ca11bae3941982bbc2db10b06d450336})}.

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