\section{Check}
\label{group__Check}\index{Check@{Check}}


The check widget allows for toggling a value between true and false.  


\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__Check_ga260d0600c6fac053ed5acecfd2c886c3}{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set}(state)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-S\-T\-A\-T\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool, state)
\begin{DoxyCompactList}\small\item\em Set the on/off state of the check object. \end{DoxyCompactList}\item 
\#define \hyperlink{group__Check_ga109661aa2bfb636e335594361af36076}{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get}(ret)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-S\-T\-A\-T\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)
\begin{DoxyCompactList}\small\item\em Get the state of the check object. \end{DoxyCompactList}\item 
\#define \hyperlink{group__Check_ga054ae74c64771246ec7a3f084e03b4c2}{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}(statep)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-S\-T\-A\-T\-E\-\_\-\-P\-O\-I\-N\-T\-E\-R\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, statep)
\begin{DoxyCompactList}\small\item\em Set a convenience pointer to a boolean to change. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
Evas\-\_\-\-Object $\ast$ \hyperlink{group__Check_ga252b43966ad9bbe0634c4619cac1e3e7}{elm\-\_\-check\-\_\-add} (Evas\-\_\-\-Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new Check object. \end{DoxyCompactList}\item 
void \hyperlink{group__Check_gaa011e6d86f82142698760cf0cc4fd0a4}{elm\-\_\-check\-\_\-state\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, Eina\-\_\-\-Bool state)
\begin{DoxyCompactList}\small\item\em Set the on/off state of the check object. \end{DoxyCompactList}\item 
Eina\-\_\-\-Bool \hyperlink{group__Check_ga011ed8bd33b24ab9be27d7f162b80846}{elm\-\_\-check\-\_\-state\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the state of the check object. \end{DoxyCompactList}\item 
void \hyperlink{group__Check_gaca05f511b004338c4d7fb35c8ec0d826}{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, Eina\-\_\-\-Bool $\ast$statep)
\begin{DoxyCompactList}\small\item\em Set a convenience pointer to a boolean to change. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
The check widget allows for toggling a value between true and false.  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{check_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{img/widget/check/preview-00}}
\end{DoxyImageNoCaption}
  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{img/widget/check/preview-01}}
\end{DoxyImageNoCaption}
  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{img/widget/check/preview-02}}
\end{DoxyImageNoCaption}


Check objects are a lot like radio objects in layout and functionality, except they do not work as a group, but independently, and only toggle the value of a boolean between false and true. \hyperlink{group__Check_gaa011e6d86f82142698760cf0cc4fd0a4}{elm\-\_\-check\-\_\-state\-\_\-set()} sets the boolean state and \hyperlink{group__Check_ga011ed8bd33b24ab9be27d7f162b80846}{elm\-\_\-check\-\_\-state\-\_\-get()} returns the current state. For convenience, like the radio objects, you can set a pointer to a boolean directly with \hyperlink{group__Check_gaca05f511b004338c4d7fb35c8ec0d826}{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set()} for it to modify.

This widget inherits from the \hyperlink{group__Layout}{Layout} one, so that all the functions acting on it also work for check objects.

This widget emits the following signals, besides the ones sent from Layout\-:
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}changed\char`\"{}} -\/ This is called whenever the user changes the state of the check objects ({\ttfamily event\-\_\-info} is always {\ttfamily N\-U\-L\-L}).
\item {\ttfamily \char`\"{}focused\char`\"{}} -\/ When the check has received focus. (since 1.\-8)
\item {\ttfamily \char`\"{}unfocused\char`\"{}} -\/ When the check has lost focus. (since 1.\-8)
\end{DoxyItemize}

Default content parts of the check widget that you can use for are\-: \begin{DoxyItemize}
\item \char`\"{}icon\char`\"{} -\/ An icon of the check\end{DoxyItemize}
Default text parts of the check widget that you can use for are\-: \begin{DoxyItemize}
\item \char`\"{}default\char`\"{} -\/ A label of the check \item \char`\"{}on\char`\"{} -\/ On state label of the check (only valid for \char`\"{}toggle\char`\"{} style.) \item \char`\"{}off\char`\"{} -\/ Off state label of the check (only valid for \char`\"{}toggle\char`\"{} style.)\end{DoxyItemize}
Supported elm\-\_\-object common A\-P\-Is. \begin{DoxyItemize}
\item \hyperlink{group__General_ga6849a57df3316eabad5bec443bf87597}{elm\-\_\-object\-\_\-disabled\-\_\-set} \item \hyperlink{group__General_ga3ecb0d6b4e76ff39006f218942c7950d}{elm\-\_\-object\-\_\-disabled\-\_\-get} \item \hyperlink{group__General_ga9c088563c442670796564d2e5158f154}{elm\-\_\-object\-\_\-part\-\_\-text\-\_\-set} \item \hyperlink{group__General_ga965e34858eb4b80b7a4b5feda732bf27}{elm\-\_\-object\-\_\-part\-\_\-text\-\_\-get} \item \hyperlink{group__General_ga0531ec8867c72def7c780601764ca642}{elm\-\_\-object\-\_\-part\-\_\-content\-\_\-set} \item \hyperlink{group__General_ga32413f4d59d8232cd362a922a281abf1}{elm\-\_\-object\-\_\-part\-\_\-content\-\_\-get} \item \hyperlink{group__General_gadc5a1df25fe17e31739841133b53b5fc}{elm\-\_\-object\-\_\-part\-\_\-content\-\_\-unset} \item \hyperlink{group__General_ga1beada7edf5d714c0dba5459bcc993fc}{elm\-\_\-object\-\_\-signal\-\_\-emit} \item \hyperlink{group__General_ga6f9574b798efcd454afdac6f2904f633}{elm\-\_\-object\-\_\-signal\-\_\-callback\-\_\-add} \item \hyperlink{group__General_ga3c76b5447be522d647e352cb7ff7c9e6}{elm\-\_\-object\-\_\-signal\-\_\-callback\-\_\-del}\end{DoxyItemize}
\hyperlink{tutorial_check}{Check example} should give you a firm grasp of how to use this widget. 

\subsection{Macro Definition Documentation}
\index{Check@{Check}!elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get@{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get}}
\index{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get@{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get}!Check@{Check}}
\subsubsection[{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get(
\begin{DoxyParamCaption}
\item[{}]{ret}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-S\-T\-A\-T\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)}\label{group__Check_ga109661aa2bfb636e335594361af36076}


Get the state of the check object. 

\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em ret} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Check_ga011ed8bd33b24ab9be27d7f162b80846}{elm\-\_\-check\-\_\-state\-\_\-get} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-check\-\_\-state\-\_\-get().

\index{Check@{Check}!elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set@{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}}
\index{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set@{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}!Check@{Check}}
\subsubsection[{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set(
\begin{DoxyParamCaption}
\item[{}]{statep}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-S\-T\-A\-T\-E\-\_\-\-P\-O\-I\-N\-T\-E\-R\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, statep)}\label{group__Check_ga054ae74c64771246ec7a3f084e03b4c2}


Set a convenience pointer to a boolean to change. 

\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em statep} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Check_gaca05f511b004338c4d7fb35c8ec0d826}{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set().

\index{Check@{Check}!elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set@{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set}}
\index{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set@{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set}!Check@{Check}}
\subsubsection[{elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set(
\begin{DoxyParamCaption}
\item[{}]{state}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-C\-H\-E\-C\-K\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-S\-T\-A\-T\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool, state)}\label{group__Check_ga260d0600c6fac053ed5acecfd2c886c3}


Set the on/off state of the check object. 

\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em state} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Check_gaa011e6d86f82142698760cf0cc4fd0a4}{elm\-\_\-check\-\_\-state\-\_\-set} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-check\-\_\-state\-\_\-set().



\subsection{Function Documentation}
\index{Check@{Check}!elm\-\_\-check\-\_\-add@{elm\-\_\-check\-\_\-add}}
\index{elm\-\_\-check\-\_\-add@{elm\-\_\-check\-\_\-add}!Check@{Check}}
\subsubsection[{elm\-\_\-check\-\_\-add}]{\setlength{\rightskip}{0pt plus 5cm}Evas\-\_\-\-Object$\ast$ elm\-\_\-check\-\_\-add (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{parent}
\end{DoxyParamCaption}
)}\label{group__Check_ga252b43966ad9bbe0634c4619cac1e3e7}


Add a new Check object. 


\begin{DoxyParams}{Parameters}
{\em parent} & The parent object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The new object or N\-U\-L\-L if it cannot be created 
\end{DoxyReturn}
\index{Check@{Check}!elm\-\_\-check\-\_\-state\-\_\-get@{elm\-\_\-check\-\_\-state\-\_\-get}}
\index{elm\-\_\-check\-\_\-state\-\_\-get@{elm\-\_\-check\-\_\-state\-\_\-get}!Check@{Check}}
\subsubsection[{elm\-\_\-check\-\_\-state\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\-\_\-\-Bool elm\-\_\-check\-\_\-state\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Check_ga011ed8bd33b24ab9be27d7f162b80846}


Get the state of the check object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The check object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The boolean state 
\end{DoxyReturn}


References elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-get.

\index{Check@{Check}!elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set@{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}}
\index{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set@{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}!Check@{Check}}
\subsubsection[{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{Eina\-\_\-\-Bool $\ast$}]{statep}
\end{DoxyParamCaption}
)}\label{group__Check_gaca05f511b004338c4d7fb35c8ec0d826}


Set a convenience pointer to a boolean to change. 


\begin{DoxyParams}{Parameters}
{\em obj} & The check object \\
\hline
{\em statep} & Pointer to the boolean to modify\\
\hline
\end{DoxyParams}
This sets a pointer to a boolean, that, in addition to the check objects state will also be modified directly. To stop setting the object pointed to simply use N\-U\-L\-L as the {\ttfamily statep} parameter. If {\ttfamily statep} is not N\-U\-L\-L, then when this is called, the check objects state will also be modified to reflect the value of the boolean {\ttfamily statep} points to, just like calling \hyperlink{group__Check_gaa011e6d86f82142698760cf0cc4fd0a4}{elm\-\_\-check\-\_\-state\-\_\-set()}. 

References elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set.

\index{Check@{Check}!elm\-\_\-check\-\_\-state\-\_\-set@{elm\-\_\-check\-\_\-state\-\_\-set}}
\index{elm\-\_\-check\-\_\-state\-\_\-set@{elm\-\_\-check\-\_\-state\-\_\-set}!Check@{Check}}
\subsubsection[{elm\-\_\-check\-\_\-state\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-check\-\_\-state\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{Eina\-\_\-\-Bool}]{state}
\end{DoxyParamCaption}
)}\label{group__Check_gaa011e6d86f82142698760cf0cc4fd0a4}


Set the on/off state of the check object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The check object \\
\hline
{\em state} & The state to use (1 == on, 0 == off)\\
\hline
\end{DoxyParams}
This sets the state of the check. If set with \hyperlink{group__Check_gaca05f511b004338c4d7fb35c8ec0d826}{elm\-\_\-check\-\_\-state\-\_\-pointer\-\_\-set()} the state of that variable is also changed. Calling this {\bfseries doesn't} cause the \char`\"{}changed\char`\"{} signal to be emitted. 

References elm\-\_\-obj\-\_\-check\-\_\-state\-\_\-set.

