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


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


\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__Elm__Check_ga8f2cfeff3dab63eb62d25113beb5448f}{E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS}~elm\+\_\+check\+\_\+class\+\_\+get()
\begin{DoxyCompactList}\small\item\em Check widget. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{group__Elm__Check_gac4c72129a13ed663846dac349adb5b87}\label{group__Elm__Check_gac4c72129a13ed663846dac349adb5b87}} 
\#define \hyperlink{group__Elm__Check_gac4c72129a13ed663846dac349adb5b87}{E\+F\+L\+\_\+\+U\+I\+\_\+\+C\+H\+E\+C\+K\+\_\+\+E\+V\+E\+N\+T\+\_\+\+C\+H\+A\+N\+G\+ED}~(\&(\+\_\+\+E\+F\+L\+\_\+\+U\+I\+\_\+\+C\+H\+E\+C\+K\+\_\+\+E\+V\+E\+N\+T\+\_\+\+C\+H\+A\+N\+G\+ED))
\begin{DoxyCompactList}\small\item\em This is called whenever the user changes the state of the check objects (event\+\_\+info is always N\+U\+LL). \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+O\+A\+PI void \hyperlink{group__Elm__Check_ga443cc211c6eb9edff7d6440dd4f0b5db}{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set} (\hyperlink{group__Eo_ga9f3010a50b61a892d41f4ec2bda73f4c}{Eo} $\ast$obj, \hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool} value)
\begin{DoxyCompactList}\small\item\em The on/off state of the check object. \end{DoxyCompactList}\item 
E\+O\+A\+PI \hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool} \hyperlink{group__Elm__Check_ga2755182274e4bcd39732b152ed24df74}{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get} (const \hyperlink{group__Eo_ga9f3010a50b61a892d41f4ec2bda73f4c}{Eo} $\ast$obj)
\begin{DoxyCompactList}\small\item\em The on/off state of the check object. \end{DoxyCompactList}\item 
void \hyperlink{group__Elm__Check_gae660b991a3a4374a51759461fec8096c}{elm\+\_\+check\+\_\+selected\+\_\+set} (Elm\+\_\+\+Check $\ast$obj, \hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool} value)
\begin{DoxyCompactList}\small\item\em Check widget. \end{DoxyCompactList}\item 
\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool} \hyperlink{group__Elm__Check_ga550c547767c538c34ac8dbd13bd45306}{elm\+\_\+check\+\_\+selected\+\_\+get} (const Elm\+\_\+\+Check $\ast$obj)
\begin{DoxyCompactList}\small\item\em The on/off state of the check object. \end{DoxyCompactList}\item 
\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object} $\ast$ \hyperlink{group__Elm__Check_ga252b43966ad9bbe0634c4619cac1e3e7}{elm\+\_\+check\+\_\+add} (\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{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. elm\+\_\+check\+\_\+state\+\_\+set() sets the boolean state and elm\+\_\+check\+\_\+state\+\_\+get() returns the current state. For convenience, like the radio objects, you can set a pointer to a boolean directly with 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}
tutorial\+\_\+check should give you a firm grasp of how to use this widget. 

\subsection{Macro Definition Documentation}
\mbox{\Hypertarget{group__Elm__Check_ga8f2cfeff3dab63eb62d25113beb5448f}\label{group__Elm__Check_ga8f2cfeff3dab63eb62d25113beb5448f}} 
\index{Check@{Check}!E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS@{E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS}}
\index{E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS@{E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS}!Check@{Check}}
\subsubsection{\texorpdfstring{E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS}{ELM\_CHECK\_CLASS}}
{\footnotesize\ttfamily \#define E\+L\+M\+\_\+\+C\+H\+E\+C\+K\+\_\+\+C\+L\+A\+SS~elm\+\_\+check\+\_\+class\+\_\+get()}



Check widget. 

The check widget allows for toggling a value between true and false. 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. 

\subsection{Function Documentation}
\mbox{\Hypertarget{group__Elm__Check_ga443cc211c6eb9edff7d6440dd4f0b5db}\label{group__Elm__Check_ga443cc211c6eb9edff7d6440dd4f0b5db}} 
\index{Check@{Check}!efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set@{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set}}
\index{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set@{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set}!Check@{Check}}
\subsubsection{\texorpdfstring{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set()}{efl\_ui\_check\_selected\_set()}}
{\footnotesize\ttfamily E\+O\+A\+PI void efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set (\begin{DoxyParamCaption}\item[{\hyperlink{group__Eo_ga9f3010a50b61a892d41f4ec2bda73f4c}{Eo} $\ast$}]{obj,  }\item[{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}}]{value }\end{DoxyParamCaption})}



The on/off state of the check object. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em value} & {\ttfamily true} if the check object is selected, {\ttfamily false} otherwise \\
\hline
\end{DoxyParams}


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

\mbox{\Hypertarget{group__Elm__Check_ga2755182274e4bcd39732b152ed24df74}\label{group__Elm__Check_ga2755182274e4bcd39732b152ed24df74}} 
\index{Check@{Check}!efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get@{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get}}
\index{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get@{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get}!Check@{Check}}
\subsubsection{\texorpdfstring{efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get()}{efl\_ui\_check\_selected\_get()}}
{\footnotesize\ttfamily E\+O\+A\+PI \hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool} efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get (\begin{DoxyParamCaption}\item[{const \hyperlink{group__Eo_ga9f3010a50b61a892d41f4ec2bda73f4c}{Eo} $\ast$}]{obj }\end{DoxyParamCaption})}



The on/off state of the check object. 

\begin{DoxyReturn}{Returns}
{\ttfamily true} if the check object is selected, {\ttfamily false} otherwise 
\end{DoxyReturn}


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

\mbox{\Hypertarget{group__Elm__Check_gae660b991a3a4374a51759461fec8096c}\label{group__Elm__Check_gae660b991a3a4374a51759461fec8096c}} 
\index{Check@{Check}!elm\+\_\+check\+\_\+selected\+\_\+set@{elm\+\_\+check\+\_\+selected\+\_\+set}}
\index{elm\+\_\+check\+\_\+selected\+\_\+set@{elm\+\_\+check\+\_\+selected\+\_\+set}!Check@{Check}}
\subsubsection{\texorpdfstring{elm\+\_\+check\+\_\+selected\+\_\+set()}{elm\_check\_selected\_set()}}
{\footnotesize\ttfamily void elm\+\_\+check\+\_\+selected\+\_\+set (\begin{DoxyParamCaption}\item[{Elm\+\_\+\+Check $\ast$}]{obj,  }\item[{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}}]{value }\end{DoxyParamCaption})}



Check widget. 

The check widget allows for toggling a value between true and false. 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. The on/off state of the check object.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em value} & {\ttfamily true} if the check object is selected, {\ttfamily false} otherwise \\
\hline
\end{DoxyParams}


References efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+set().

\mbox{\Hypertarget{group__Elm__Check_ga550c547767c538c34ac8dbd13bd45306}\label{group__Elm__Check_ga550c547767c538c34ac8dbd13bd45306}} 
\index{Check@{Check}!elm\+\_\+check\+\_\+selected\+\_\+get@{elm\+\_\+check\+\_\+selected\+\_\+get}}
\index{elm\+\_\+check\+\_\+selected\+\_\+get@{elm\+\_\+check\+\_\+selected\+\_\+get}!Check@{Check}}
\subsubsection{\texorpdfstring{elm\+\_\+check\+\_\+selected\+\_\+get()}{elm\_check\_selected\_get()}}
{\footnotesize\ttfamily \hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool} elm\+\_\+check\+\_\+selected\+\_\+get (\begin{DoxyParamCaption}\item[{const Elm\+\_\+\+Check $\ast$}]{obj }\end{DoxyParamCaption})}



The on/off state of the check object. 

\begin{DoxyReturn}{Returns}
{\ttfamily true} if the check object is selected, {\ttfamily false} otherwise 
\end{DoxyReturn}


References efl\+\_\+ui\+\_\+check\+\_\+selected\+\_\+get().

\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}}
\subsubsection{\texorpdfstring{elm\+\_\+check\+\_\+add()}{elm\_check\_add()}}
{\footnotesize\ttfamily \hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}$\ast$ elm\+\_\+check\+\_\+add (\begin{DoxyParamCaption}\item[{\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 N\+U\+LL if it cannot be created 
\end{DoxyReturn}
