\section{Tk\-Listbox Class Reference}
\label{class_tk_listbox}\index{TkListbox@{TkListbox}}
Represent \char`\"{}listbox\char`\"{} widget.  


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

Inheritance diagram for Tk\-Listbox::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=12cm]{class_tk_listbox}
\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\-Variable} ({\bf Tcl\-List\-Var} $\ast$variable)
\item 
int {\bf get\-Cursor} ()
\item 
void {\bf delete\-Item} (int first\-Index, int last\-Index)
\item 
void {\bf delete\-Item} (int index)
\item 
string \& {\bf get} (int index)
\item 
void {\bf create} ()\label{class_tk_listbox_21140cdbfc5adac008803f2a52633d13}

\begin{CompactList}\small\item\em Creates widget in shell. \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}\end{CompactItemize}


\subsection{Detailed Description}
Represent \char`\"{}listbox\char`\"{} 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{TkListbox@{Tk\-Listbox}!clone@{clone}}
\index{clone@{clone}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf TObject} $\ast$ Tk\-Listbox::clone ()\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!deleteItem@{deleteItem}}
\index{deleteItem@{deleteItem}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Listbox::delete\-Item (int {\em index})\hspace{0.3cm}{\tt  [inline]}}\label{class_tk_listbox_b96550d84216def6ca8de9895106ea55}


Delete single item from listbox \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em index}]index of item \end{description}
\end{Desc}
\index{TkListbox@{Tk\-Listbox}!deleteItem@{deleteItem}}
\index{deleteItem@{deleteItem}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Listbox::delete\-Item (int {\em first\-Index}, int {\em last\-Index})\hspace{0.3cm}{\tt  [inline]}}\label{class_tk_listbox_7eb35477664e8ca61281d49405b77bad}


Delete range of items from listbox \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em first\-Index}]index of first item \item[{\em last\-Index}]index of last item \end{description}
\end{Desc}
\index{TkListbox@{Tk\-Listbox}!get@{get}}
\index{get@{get}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}string\& Tk\-Listbox::get (int {\em index})\hspace{0.3cm}{\tt  [inline]}}\label{class_tk_listbox_d2af46e758c333c3d89963c074979ed5}


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em index}]index of item \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]item at index index \end{Desc}
\index{TkListbox@{Tk\-Listbox}!getBackgroundColor@{getBackgroundColor}}
\index{getBackgroundColor@{getBackgroundColor}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Ptr}$<$ Tk\-Color\-Option $>$ \& Tk\-Listbox::get\-Background\-Color () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!getCursor@{getCursor}}
\index{getCursor@{getCursor}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Tk\-Listbox::get\-Cursor ()\hspace{0.3cm}{\tt  [inline]}}\label{class_tk_listbox_f5904f362d0a719457967805d97e35e6}


\begin{Desc}
\item[Returns:]cursor position of selected item, items are indexed from top, starting from index 0, -1 means no selected item \end{Desc}
\index{TkListbox@{Tk\-Listbox}!getOptionAll@{getOptionAll}}
\index{getOptionAll@{getOptionAll}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf Ptr}$<$ Tk\-Option\-Def $>$ $\ast$ Tk\-Listbox::get\-Option\-All () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!getTkClass@{getTkClass}}
\index{getTkClass@{getTkClass}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Tk\-Listbox::get\-Tk\-Class () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!getType@{getType}}
\index{getType@{getType}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ Tk\-Listbox::get\-Type () const\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!setBackgroundColor@{setBackgroundColor}}
\index{setBackgroundColor@{setBackgroundColor}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Listbox::set\-Background\-Color (Tk\-Color\-Option $\ast$ {\em color})\hspace{0.3cm}{\tt  [virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!setEventsEnabled@{setEventsEnabled}}
\index{setEventsEnabled@{setEventsEnabled}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Listbox::set\-Events\-Enabled (bool {\em value})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{class_tk_listbox_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{TkListbox@{Tk\-Listbox}!setVariable@{setVariable}}
\index{setVariable@{setVariable}!TkListbox@{Tk\-Listbox}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Tk\-Listbox::set\-Variable ({\bf Tcl\-List\-Var} $\ast$ {\em variable})\hspace{0.3cm}{\tt  [inline]}}\label{class_tk_listbox_b7f80934797453e027aa78151d747355}


Synchronize own variable with list, this variable has got value of item \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em variable}]\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\_\-listbox.h\item 
H:/projs/dot\-NET/eda/src/tk/gui/tk\_\-listbox.cpp\end{CompactItemize}
