\hypertarget{group__Elm__Check}{}\doxysection{Check}
\label{group__Elm__Check}\index{Check@{Check}}


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


\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ \mbox{\hyperlink{group__Elm__Check_ga252b43966ad9bbe0634c4619cac1e3e7}{elm\+\_\+check\+\_\+add}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new Check object. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Elm__Check_ga011ed8bd33b24ab9be27d7f162b80846}{elm\+\_\+check\+\_\+state\+\_\+get}} (const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the state of the check object. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Check_gaa011e6d86f82142698760cf0cc4fd0a4}{elm\+\_\+check\+\_\+state\+\_\+set}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} state)
\begin{DoxyCompactList}\small\item\em Set the on/off state of the check object. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Check_gaca05f511b004338c4d7fb35c8ec0d826}{elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} $\ast$statep)
\begin{DoxyCompactList}\small\item\em Set a convenience pointer to a boolean to change. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{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. \mbox{\hyperlink{group__Elm__Check_gaa011e6d86f82142698760cf0cc4fd0a4}{elm\+\_\+check\+\_\+state\+\_\+set()}} sets the boolean state and \mbox{\hyperlink{group__Elm__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 \mbox{\hyperlink{group__Elm__Check_gaca05f511b004338c4d7fb35c8ec0d826}{elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set()}} for it to modify.

This widget inherits from the \mbox{\hyperlink{group__Elm__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 \mbox{\hyperlink{group__Elm__Layout}{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 NULL}).
\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 APIs. \begin{DoxyItemize}
\item \mbox{\hyperlink{group__Elm__General_ga6849a57df3316eabad5bec443bf87597}{elm\+\_\+object\+\_\+disabled\+\_\+set}} \item \mbox{\hyperlink{group__Elm__General_ga3ecb0d6b4e76ff39006f218942c7950d}{elm\+\_\+object\+\_\+disabled\+\_\+get}} \item \mbox{\hyperlink{group__Elm__General_ga9c088563c442670796564d2e5158f154}{elm\+\_\+object\+\_\+part\+\_\+text\+\_\+set}} \item \mbox{\hyperlink{group__Elm__General_ga965e34858eb4b80b7a4b5feda732bf27}{elm\+\_\+object\+\_\+part\+\_\+text\+\_\+get}} \item \mbox{\hyperlink{group__Elm__General_ga0531ec8867c72def7c780601764ca642}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+set}} \item \mbox{\hyperlink{group__Elm__General_ga32413f4d59d8232cd362a922a281abf1}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+get}} \item \mbox{\hyperlink{group__Elm__General_gadc5a1df25fe17e31739841133b53b5fc}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+unset}} \item \mbox{\hyperlink{group__Elm__General_ga1beada7edf5d714c0dba5459bcc993fc}{elm\+\_\+object\+\_\+signal\+\_\+emit}} \item \mbox{\hyperlink{group__Elm__General_ga6f9574b798efcd454afdac6f2904f633}{elm\+\_\+object\+\_\+signal\+\_\+callback\+\_\+add}} \item \mbox{\hyperlink{group__Elm__General_ga3c76b5447be522d647e352cb7ff7c9e6}{elm\+\_\+object\+\_\+signal\+\_\+callback\+\_\+del}}\end{DoxyItemize}
\mbox{\hyperlink{tutorial_check}{Check example}} should give you a firm grasp of how to use this widget. 

\doxysubsection{Function Documentation}
\mbox{\Hypertarget{group__Elm__Check_ga252b43966ad9bbe0634c4619cac1e3e7}\label{group__Elm__Check_ga252b43966ad9bbe0634c4619cac1e3e7}} 
\index{Check@{Check}!elm\_check\_add@{elm\_check\_add}}
\index{elm\_check\_add@{elm\_check\_add}!Check@{Check}}
\doxysubsubsection{\texorpdfstring{elm\_check\_add()}{elm\_check\_add()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}}$\ast$ elm\+\_\+check\+\_\+add (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{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 NULL if it cannot be created 
\end{DoxyReturn}


References EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL.

\mbox{\Hypertarget{group__Elm__Check_ga011ed8bd33b24ab9be27d7f162b80846}\label{group__Elm__Check_ga011ed8bd33b24ab9be27d7f162b80846}} 
\index{Check@{Check}!elm\_check\_state\_get@{elm\_check\_state\_get}}
\index{elm\_check\_state\_get@{elm\_check\_state\_get}!Check@{Check}}
\doxysubsubsection{\texorpdfstring{elm\_check\_state\_get()}{elm\_check\_state\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} elm\+\_\+check\+\_\+state\+\_\+get (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj }\end{DoxyParamCaption})}



Get the state of the check object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The check object \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{group__Elm__Check_gaa011e6d86f82142698760cf0cc4fd0a4}\label{group__Elm__Check_gaa011e6d86f82142698760cf0cc4fd0a4}} 
\index{Check@{Check}!elm\_check\_state\_set@{elm\_check\_state\_set}}
\index{elm\_check\_state\_set@{elm\_check\_state\_set}!Check@{Check}}
\doxysubsubsection{\texorpdfstring{elm\_check\_state\_set()}{elm\_check\_state\_set()}}
{\footnotesize\ttfamily void elm\+\_\+check\+\_\+state\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}}}]{state }\end{DoxyParamCaption})}



Set the on/off state of the check object. 

This sets the state of the check. If set with .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}{Parameters}
{\em obj} & The check object \\
\hline
{\em state} & The state to use (1 == on, 0 == off) \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{group__Elm__Check_gaca05f511b004338c4d7fb35c8ec0d826}\label{group__Elm__Check_gaca05f511b004338c4d7fb35c8ec0d826}} 
\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}}
\doxysubsubsection{\texorpdfstring{elm\_check\_state\_pointer\_set()}{elm\_check\_state\_pointer\_set()}}
{\footnotesize\ttfamily void elm\+\_\+check\+\_\+state\+\_\+pointer\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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 .state.\+set.


\begin{DoxyParams}{Parameters}
{\em obj} & The check object \\
\hline
{\em statep} & pointer to the boolean to modify \\
\hline
\end{DoxyParams}
