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


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


\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+O\+A\+PI void \hyperlink{group__Elm__Check_gaf9b19a5ad28bd389f8c10788e6666023}{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+set} (Eina\+\_\+\+Bool state)
\begin{DoxyCompactList}\small\item\em Set the on/off state of the check object. \end{DoxyCompactList}\item 
E\+O\+A\+PI Eina\+\_\+\+Bool \hyperlink{group__Elm__Check_ga691f4f915c72ec62229aa1040e12a8e8}{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get the state of the check object. \end{DoxyCompactList}\item 
E\+O\+A\+PI void \hyperlink{group__Elm__Check_ga847af435617866758ae2eaab54ea48e3}{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set} (Eina\+\_\+\+Bool $\ast$statep)
\begin{DoxyCompactList}\small\item\em Set a convenience pointer to a boolean to change. \end{DoxyCompactList}\item 
void \hyperlink{group__Elm__Check_ga41cf3095ccfadf7d5731c7a253800d10}{elm\+\_\+check\+\_\+state\+\_\+set} (Elm\+\_\+\+Check $\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__Elm__Check_ga478eb8116c0f698b9465ba842206c0da}{elm\+\_\+check\+\_\+state\+\_\+get} (const Elm\+\_\+\+Check $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the state of the check object. \end{DoxyCompactList}\item 
void \hyperlink{group__Elm__Check_gadf5b1894251ca6f25538d586f153219a}{elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set} (Elm\+\_\+\+Check $\ast$obj, Eina\+\_\+\+Bool $\ast$statep)
\begin{DoxyCompactList}\small\item\em Set a convenience pointer to a boolean to change. \end{DoxyCompactList}\item 
Evas\+\_\+\+Object $\ast$ \hyperlink{group__Elm__Check_ga252b43966ad9bbe0634c4619cac1e3e7}{elm\+\_\+check\+\_\+add} (Evas\+\_\+\+Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new Check object. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
The check widget allows for toggling a value between true and false. 

 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{check_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{img/widget/check/preview-00}}
\end{DoxyImageNoCaption}
  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{img/widget/check/preview-01}}
\end{DoxyImageNoCaption}
  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{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__Elm__Check_ga41cf3095ccfadf7d5731c7a253800d10}{elm\+\_\+check\+\_\+state\+\_\+set()} sets the boolean state and \hyperlink{group__Elm__Check_ga478eb8116c0f698b9465ba842206c0da}{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__Elm__Check_gadf5b1894251ca6f25538d586f153219a}{elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set()} for it to modify.

This widget inherits from the 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\+LL}).
\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)
\item {\ttfamily \char`\"{}language,changed\char`\"{}} -\/ the program\textquotesingle{}s language changed (since 1.\+9)
\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__Elm__General_ga6849a57df3316eabad5bec443bf87597}{elm\+\_\+object\+\_\+disabled\+\_\+set} \item \hyperlink{group__Elm__General_ga3ecb0d6b4e76ff39006f218942c7950d}{elm\+\_\+object\+\_\+disabled\+\_\+get} \item \hyperlink{group__Elm__General_ga9c088563c442670796564d2e5158f154}{elm\+\_\+object\+\_\+part\+\_\+text\+\_\+set} \item \hyperlink{group__Elm__General_ga965e34858eb4b80b7a4b5feda732bf27}{elm\+\_\+object\+\_\+part\+\_\+text\+\_\+get} \item \hyperlink{group__Elm__General_ga0531ec8867c72def7c780601764ca642}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+set} \item \hyperlink{group__Elm__General_ga32413f4d59d8232cd362a922a281abf1}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+get} \item \hyperlink{group__Elm__General_gadc5a1df25fe17e31739841133b53b5fc}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+unset} \item \hyperlink{group__Elm__General_ga1beada7edf5d714c0dba5459bcc993fc}{elm\+\_\+object\+\_\+signal\+\_\+emit} \item \hyperlink{group__Elm__General_ga6f9574b798efcd454afdac6f2904f633}{elm\+\_\+object\+\_\+signal\+\_\+callback\+\_\+add} \item \hyperlink{group__Elm__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{Function Documentation}
\mbox{\label{group__Elm__Check_ga252b43966ad9bbe0634c4619cac1e3e7}} 
\index{Check@{Check}!elm\+\_\+check\+\_\+add@{elm\+\_\+check\+\_\+add}}
\index{elm\+\_\+check\+\_\+add@{elm\+\_\+check\+\_\+add}!Check@{Check}}
\subsubsection{\texorpdfstring{elm\+\_\+check\+\_\+add()}{elm\_check\_add()}}
{\footnotesize\ttfamily Evas\+\_\+\+Object$\ast$ elm\+\_\+check\+\_\+add (\begin{DoxyParamCaption}\item[{Evas\+\_\+\+Object $\ast$}]{parent }\end{DoxyParamCaption})}



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\+LL if it cannot be created 
\end{DoxyReturn}


References elm\+\_\+layout\+\_\+signal\+\_\+emit().

\mbox{\label{group__Elm__Check_ga478eb8116c0f698b9465ba842206c0da}} 
\index{Check@{Check}!elm\+\_\+check\+\_\+state\+\_\+get@{elm\+\_\+check\+\_\+state\+\_\+get}}
\index{elm\+\_\+check\+\_\+state\+\_\+get@{elm\+\_\+check\+\_\+state\+\_\+get}!Check@{Check}}
\subsubsection{\texorpdfstring{elm\+\_\+check\+\_\+state\+\_\+get()}{elm\_check\_state\_get()}}
{\footnotesize\ttfamily Eina\+\_\+\+Bool elm\+\_\+check\+\_\+state\+\_\+get (\begin{DoxyParamCaption}\item[{const Elm\+\_\+\+Check $\ast$}]{obj }\end{DoxyParamCaption})}



Get the state of the check object. 

\begin{DoxyReturn}{Returns}
The state to use (1 == on, 0 == off) 
\end{DoxyReturn}


References elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+get().



Referenced by elm\+\_\+dayselector\+\_\+add().

\mbox{\label{group__Elm__Check_gadf5b1894251ca6f25538d586f153219a}} 
\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{\texorpdfstring{elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set()}{elm\_check\_state\_pointer\_set()}}
{\footnotesize\ttfamily void elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set (\begin{DoxyParamCaption}\item[{Elm\+\_\+\+Check $\ast$}]{obj,  }\item[{Eina\+\_\+\+Bool $\ast$}]{statep }\end{DoxyParamCaption})}



Set a convenience pointer to a boolean to change. 

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 null as the \char`\"{}statep\char`\"{} parameter. If \char`\"{}statep\char`\"{} is not null, then when this is called, the check objects state will also be modified to reflect the value of the boolean \char`\"{}statep\char`\"{} points to, just like calling \hyperlink{group__Elm__Check_ga41cf3095ccfadf7d5731c7a253800d10}{elm\+\_\+check\+\_\+state\+\_\+set}.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em statep} & Pointer to the boolean to modify \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set().

\mbox{\label{group__Elm__Check_ga41cf3095ccfadf7d5731c7a253800d10}} 
\index{Check@{Check}!elm\+\_\+check\+\_\+state\+\_\+set@{elm\+\_\+check\+\_\+state\+\_\+set}}
\index{elm\+\_\+check\+\_\+state\+\_\+set@{elm\+\_\+check\+\_\+state\+\_\+set}!Check@{Check}}
\subsubsection{\texorpdfstring{elm\+\_\+check\+\_\+state\+\_\+set()}{elm\_check\_state\_set()}}
{\footnotesize\ttfamily void elm\+\_\+check\+\_\+state\+\_\+set (\begin{DoxyParamCaption}\item[{Elm\+\_\+\+Check $\ast$}]{obj,  }\item[{Eina\+\_\+\+Bool}]{state }\end{DoxyParamCaption})}



Set the on/off state of the check object. 

This sets the state of the check. If set with \hyperlink{group__Elm__Check_gadf5b1894251ca6f25538d586f153219a}{elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set}, the state of that variable is also changed. Calling this doesn\textquotesingle{}t cause the \char`\"{}changed\char`\"{} signal to be emitted.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em state} & The state to use (1 == on, 0 == off) \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+set().



Referenced by elm\+\_\+dayselector\+\_\+add().

\mbox{\label{group__Elm__Check_ga691f4f915c72ec62229aa1040e12a8e8}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+get()}{elm\_obj\_check\_state\_get()}}
{\footnotesize\ttfamily E\+O\+A\+PI Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+get (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Get the state of the check object. 

\begin{DoxyReturn}{Returns}
The state to use (1 == on, 0 == off) 
\end{DoxyReturn}


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

\mbox{\label{group__Elm__Check_ga847af435617866758ae2eaab54ea48e3}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set()}{elm\_obj\_check\_state\_pointer\_set()}}
{\footnotesize\ttfamily E\+O\+A\+PI void elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set (\begin{DoxyParamCaption}\item[{Eina\+\_\+\+Bool $\ast$}]{statep }\end{DoxyParamCaption})}



Set a convenience pointer to a boolean to change. 

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 null as the \char`\"{}statep\char`\"{} parameter. If \char`\"{}statep\char`\"{} is not null, then when this is called, the check objects state will also be modified to reflect the value of the boolean \char`\"{}statep\char`\"{} points to, just like calling \hyperlink{group__Elm__Check_gaf9b19a5ad28bd389f8c10788e6666023}{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+set}.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em statep} & Pointer to the boolean to modify \\
\hline
\end{DoxyParams}


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

\mbox{\label{group__Elm__Check_gaf9b19a5ad28bd389f8c10788e6666023}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+set()}{elm\_obj\_check\_state\_set()}}
{\footnotesize\ttfamily E\+O\+A\+PI void elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+set (\begin{DoxyParamCaption}\item[{Eina\+\_\+\+Bool}]{state }\end{DoxyParamCaption})}



Set the on/off state of the check object. 

This sets the state of the check. If set with \hyperlink{group__Elm__Check_ga847af435617866758ae2eaab54ea48e3}{elm\+\_\+obj\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set}, the state of that variable is also changed. Calling this doesn\textquotesingle{}t cause the \char`\"{}changed\char`\"{} signal to be emitted.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em state} & The state to use (1 == on, 0 == off) \\
\hline
\end{DoxyParams}


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

