\section{Tk\-Spin\-Box Class Reference}
\label{class_tk_spin_box}\index{TkSpinBox@{TkSpinBox}}
Represent \char`\"{}Tk\-Spin\-Box\char`\"{} Tk widget.  


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

Inheritance diagram for Tk\-Spin\-Box::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=12cm]{class_tk_spin_box}
\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 set\-Values} (const char $\ast$values[$\,$])
\item 
void {\bf set\-Values} (const list$<$ string $>$ \&values)
\item 
int {\bf get\-Values\-Index} () const 
\item 
void {\bf set\-Value} (double value)
\item 
void {\bf set\-Value} (int value)
\item 
void {\bf set\-Text} (const string \&text)
\begin{CompactList}\small\item\em Sets text of widget. \item\end{CompactList}\item 
int {\bf int\-Value} () const 
\item 
double {\bf double\-Value} () const 
\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\-Limit\-From} (double value)
\item 
void {\bf set\-Limit\-To} (double value)
\item 
void {\bf set\-Increment} (double value)
\item 
void {\bf set\-Range} (double from, double to, double increment)
\item 
{\bf Tcl\-Var} $\ast$ {\bf get\-Default\-Var} ()
\begin{CompactList}\small\item\em return pointer to default variable \item\end{CompactList}\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}\item 
void {\bf create} ()\label{class_tk_spin_box_21140cdbfc5adac008803f2a52633d13}

\begin{CompactList}\small\item\em Creates widget in shell. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Represent \char`\"{}Tk\-Spin\-Box\char`\"{} Tk widget. 

\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{TkSpinBox@{Tk\-Spin\-Box}!clone@{clone}}
\index{clone@{clone}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf TObject} $\ast$ Tk\-Spin\-Box::clone ()\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!doubleValue@{doubleValue}}
\index{doubleValue@{doubleValue}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}double Tk\-Spin\-Box::double\-Value () const}\label{class_tk_spin_box_493f927686fc45e4340cc8a393ef7516}


Return actual value of spinbox, converted to double \begin{Desc}
\item[Returns:]actual value \end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!getBackgroundColor@{getBackgroundColor}}
\index{getBackgroundColor@{getBackgroundColor}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ptr}$<$ Tk\-Color\-Option $>$ \& Tk\-Spin\-Box::get\-Background\-Color () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!getDefaultVar@{getDefaultVar}}
\index{getDefaultVar@{getDefaultVar}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Tcl\-Var}$\ast$ Tk\-Spin\-Box::get\-Default\-Var ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{class_tk_spin_box_2d08d07ba1c3628e6b4bbe9cdd9652c7}


return pointer to default variable 

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


Implements {\bf IInner\-Variable} {\rm (p.\,\pageref{class_i_inner_variable_de0c2632ff3018462082e183674c24d8})}.\index{TkSpinBox@{Tk\-Spin\-Box}!getOptionAll@{getOptionAll}}
\index{getOptionAll@{getOptionAll}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf Ptr}$<$ Tk\-Option\-Def $>$ $\ast$ Tk\-Spin\-Box::get\-Option\-All () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!getText@{getText}}
\index{getText@{getText}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string \& Tk\-Spin\-Box::get\-Text () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!getTkClass@{getTkClass}}
\index{getTkClass@{getTkClass}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Tk\-Spin\-Box::get\-Tk\-Class () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!getType@{getType}}
\index{getType@{getType}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Tk\-Spin\-Box::get\-Type () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!getValuesIndex@{getValuesIndex}}
\index{getValuesIndex@{getValuesIndex}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Tk\-Spin\-Box::get\-Values\-Index () const}\label{class_tk_spin_box_1011b82e505c297d523d81af186ab044}


Return index of active field if in values \char`\"{}mode\char`\"{} and value is from the value list. otherwise return -1. \begin{Desc}
\item[Returns:]\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!intValue@{intValue}}
\index{intValue@{intValue}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Tk\-Spin\-Box::int\-Value () const}\label{class_tk_spin_box_456d16dc41de69cc2169c363b0629e2a}


Return actual value of spinbox, converted to integer \begin{Desc}
\item[Returns:]actual value \end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setBackgroundColor@{setBackgroundColor}}
\index{setBackgroundColor@{setBackgroundColor}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Background\-Color (Tk\-Color\-Option $\ast$ {\em color})\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!setEventsEnabled@{setEventsEnabled}}
\index{setEventsEnabled@{setEventsEnabled}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Events\-Enabled (bool {\em value})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!setIncrement@{setIncrement}}
\index{setIncrement@{setIncrement}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Increment (double {\em value})}\label{class_tk_spin_box_9351309dbd01f30963360348893405d9}


Set speed of incrementation. Default is 1. This is mutually exclusive to using enumeration of values. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]speed of incrementation \end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setLimitFrom@{setLimitFrom}}
\index{setLimitFrom@{setLimitFrom}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Limit\-From (double {\em value})}\label{class_tk_spin_box_a886df5de38ff011f03773f92ea303d7}


Set minimal limit for spinbox value. This is mutually exclusive to using enumeration of values. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]minimal number to display \end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setLimitTo@{setLimitTo}}
\index{setLimitTo@{setLimitTo}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Limit\-To (double {\em value})}\label{class_tk_spin_box_feef912ccddb7ba0d465de10a2c0cd62}


Set maximal limit for spinbox value. This is mutually exclusive to using enumeration of values. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]maximal number to display \end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setRange@{setRange}}
\index{setRange@{setRange}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Range (double {\em from}, double {\em to}, double {\em increment})}\label{class_tk_spin_box_74a19acc0a1fe5794260af3e25c9cde0}


Set range for spinbox values. This is mutually exclusive to using enumeration of values. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em from}]minimal number \item[{\em to}]maximal number \item[{\em increment}]speed of incrementation \end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setText@{setText}}
\index{setText@{setText}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Text (const string \& {\em text})\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_spin_box_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{TkSpinBox@{Tk\-Spin\-Box}!setValue@{setValue}}
\index{setValue@{setValue}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Value (int {\em value})}\label{class_tk_spin_box_017bd9d234ff769042da87d5e8c73b2b}


Set spinbox actual value to value \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]\end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setValue@{setValue}}
\index{setValue@{setValue}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Value (double {\em value})}\label{class_tk_spin_box_40fbd033cdc225a9e395966fc5453ee5}


Set spinbox actual value to value \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em value}]\end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setValues@{setValues}}
\index{setValues@{setValues}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Values (const list$<$ string $>$ \& {\em values})}\label{class_tk_spin_box_faf614c7fe8da7f7bde10ecd65e6d1ce}


Spinbox will roll this enumeration of values \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em values}]list of values \end{description}
\end{Desc}
\index{TkSpinBox@{Tk\-Spin\-Box}!setValues@{setValues}}
\index{setValues@{setValues}!TkSpinBox@{Tk\-Spin\-Box}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Spin\-Box::set\-Values (const char $\ast$ {\em values}[$\,$])}\label{class_tk_spin_box_9f1114863df04d644d89f2f4f9da0524}


Spinbox will roll this enumeration of values. This is mutually exclusive to any \char`\"{}range\char`\"{} settings of spinbox \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em values\mbox{[}$\,$\mbox{]}}]list of values, use NULL to signalize last parameter \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\_\-spinbox.h\item 
H:/projs/dot\-NET/eda/src/tk/gui/tk\_\-spinbox.cpp\end{CompactItemize}
