\section{Frame}
\label{group__Frame}\index{Frame@{Frame}}


Frame is a widget that holds some content and has a title.  


\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__Frame_gada08ab4473bfbec8cb0263f8665dd491}{elm\-\_\-obj\-\_\-frame\-\_\-autocollapse\-\_\-set}(autocollapse)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-A\-U\-T\-O\-C\-O\-L\-L\-A\-P\-S\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool, autocollapse)
\begin{DoxyCompactList}\small\item\em Toggle autocollapsing of a frame. \end{DoxyCompactList}\item 
\#define \hyperlink{group__Frame_ga66ac717942b0ae3200f3324b5d55dc67}{elm\-\_\-obj\-\_\-frame\-\_\-autocollapse\-\_\-get}(ret)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-A\-U\-T\-O\-C\-O\-L\-L\-A\-P\-S\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
\#define \hyperlink{group__Frame_ga6fc316abd1baed9221a4f6fbe0f031ea}{elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-set}(collapse)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-L\-A\-P\-S\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool, collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame without animations. \end{DoxyCompactList}\item 
\#define \hyperlink{group__Frame_ga0a9bb7a9e905dabb05ccf4d7fb6339f6}{elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get}(ret)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-L\-A\-P\-S\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)
\begin{DoxyCompactList}\small\item\em Determine the collapse state of a frame. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
Evas\-\_\-\-Object $\ast$ \hyperlink{group__Frame_ga02fadf955eebe3737e076b08ef81b159}{elm\-\_\-frame\-\_\-add} (Evas\-\_\-\-Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new frame to the parent. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga8318c00a0bfb671cdb1e66b6accd189f}{elm\-\_\-frame\-\_\-autocollapse\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, Eina\-\_\-\-Bool autocollapse)
\begin{DoxyCompactList}\small\item\em Toggle autocollapsing of a frame. \end{DoxyCompactList}\item 
Eina\-\_\-\-Bool \hyperlink{group__Frame_gae32291b59305fe4914030783c3afda96}{elm\-\_\-frame\-\_\-autocollapse\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga42d7d36cbc69ae0a644d57b30e086adc}{elm\-\_\-frame\-\_\-collapse\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, Eina\-\_\-\-Bool collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame without animations. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga7651fbf7387ee08d7173f094decb2f72}{elm\-\_\-frame\-\_\-collapse\-\_\-go} (Evas\-\_\-\-Object $\ast$obj, Eina\-\_\-\-Bool collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame with animations. \end{DoxyCompactList}\item 
Eina\-\_\-\-Bool \hyperlink{group__Frame_gacb054de57efb25ee32bf8e1feba3e901}{elm\-\_\-frame\-\_\-collapse\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine the collapse state of a frame. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Frame is a widget that holds some content and has a title.  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{frame_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{img/widget/frame/preview-00}}
\end{DoxyImageNoCaption}


The default look is a frame with a title, but Frame supports multiple styles\-: \begin{DoxyItemize}
\item default \item pad\-\_\-small \item pad\-\_\-medium \item pad\-\_\-large \item pad\-\_\-huge \item outdent\-\_\-top \item outdent\-\_\-bottom\end{DoxyItemize}
Of all this styles only default shows the title.

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

This widget emits the following signals, besides the ones sent from Layout\-:
\begin{DoxyItemize}
\item {\ttfamily \char`\"{}clicked\char`\"{}} -\/ The user has clicked the frame's label
\end{DoxyItemize}

Default content parts of the frame widget that you can use for are\-: \begin{DoxyItemize}
\item \char`\"{}default\char`\"{} -\/ A content of the frame\end{DoxyItemize}
Default text parts of the frame widget that you can use for are\-: \begin{DoxyItemize}
\item \char`\"{}default\char`\"{} -\/ Label of the frame\end{DoxyItemize}
Supported elm\-\_\-object common A\-P\-Is. \begin{DoxyItemize}
\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}\end{DoxyItemize}
For a detailed example see the \hyperlink{tutorial_frame}{Frame example}. 

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


Determine autocollapsing of a frame. 

\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__Frame_gae32291b59305fe4914030783c3afda96}{elm\-\_\-frame\-\_\-autocollapse\-\_\-get} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-frame\-\_\-autocollapse\-\_\-get().

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


Toggle autocollapsing of a frame. 

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

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


Referenced by elm\-\_\-frame\-\_\-autocollapse\-\_\-set().

\index{Frame@{Frame}!elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get@{elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get}}
\index{elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get@{elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get}!Frame@{Frame}}
\subsubsection[{elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get(
\begin{DoxyParamCaption}
\item[{}]{ret}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-F\-R\-A\-M\-E\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-L\-A\-P\-S\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)}\label{group__Frame_ga0a9bb7a9e905dabb05ccf4d7fb6339f6}


Determine the collapse state of a frame. 

\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__Frame_gacb054de57efb25ee32bf8e1feba3e901}{elm\-\_\-frame\-\_\-collapse\-\_\-get} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-frame\-\_\-collapse\-\_\-get().

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


Manually collapse a frame without animations. 

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

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


Referenced by elm\-\_\-frame\-\_\-collapse\-\_\-set().



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


Add a new frame to the parent. 


\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{Frame@{Frame}!elm\-\_\-frame\-\_\-autocollapse\-\_\-get@{elm\-\_\-frame\-\_\-autocollapse\-\_\-get}}
\index{elm\-\_\-frame\-\_\-autocollapse\-\_\-get@{elm\-\_\-frame\-\_\-autocollapse\-\_\-get}!Frame@{Frame}}
\subsubsection[{elm\-\_\-frame\-\_\-autocollapse\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\-\_\-\-Bool elm\-\_\-frame\-\_\-autocollapse\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Frame_gae32291b59305fe4914030783c3afda96}


Determine autocollapsing of a frame. 


\begin{DoxyParams}{Parameters}
{\em obj} & The frame \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Whether autocollapse is enabled
\end{DoxyReturn}
When this returns E\-I\-N\-A\-\_\-\-T\-R\-U\-E, clicking a frame's label will collapse the frame vertically, shrinking it to the height of the label. By default, this is D\-I\-S\-A\-B\-L\-E\-D. 

References elm\-\_\-obj\-\_\-frame\-\_\-autocollapse\-\_\-get.

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


Toggle autocollapsing of a frame. 


\begin{DoxyParams}{Parameters}
{\em obj} & The frame \\
\hline
{\em autocollapse} & Whether to enable autocollapse\\
\hline
\end{DoxyParams}
When {\ttfamily enable} is E\-I\-N\-A\-\_\-\-T\-R\-U\-E, clicking a frame's label will collapse the frame vertically, shrinking it to the height of the label. By default, this is D\-I\-S\-A\-B\-L\-E\-D. 

References elm\-\_\-obj\-\_\-frame\-\_\-autocollapse\-\_\-set.

\index{Frame@{Frame}!elm\-\_\-frame\-\_\-collapse\-\_\-get@{elm\-\_\-frame\-\_\-collapse\-\_\-get}}
\index{elm\-\_\-frame\-\_\-collapse\-\_\-get@{elm\-\_\-frame\-\_\-collapse\-\_\-get}!Frame@{Frame}}
\subsubsection[{elm\-\_\-frame\-\_\-collapse\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\-\_\-\-Bool elm\-\_\-frame\-\_\-collapse\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Frame_gacb054de57efb25ee32bf8e1feba3e901}


Determine the collapse state of a frame. 


\begin{DoxyParams}{Parameters}
{\em obj} & The frame \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if collapsed, false otherwise
\end{DoxyReturn}
Use this to determine the collapse state of a frame. 

References elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-get.

\index{Frame@{Frame}!elm\-\_\-frame\-\_\-collapse\-\_\-go@{elm\-\_\-frame\-\_\-collapse\-\_\-go}}
\index{elm\-\_\-frame\-\_\-collapse\-\_\-go@{elm\-\_\-frame\-\_\-collapse\-\_\-go}!Frame@{Frame}}
\subsubsection[{elm\-\_\-frame\-\_\-collapse\-\_\-go}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-frame\-\_\-collapse\-\_\-go (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{Eina\-\_\-\-Bool}]{collapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga7651fbf7387ee08d7173f094decb2f72}


Manually collapse a frame with animations. 


\begin{DoxyParams}{Parameters}
{\em obj} & The frame \\
\hline
{\em collapse} & true to collapse, false to expand\\
\hline
\end{DoxyParams}
Use this to toggle the collapsed state of a frame, triggering animations. \index{Frame@{Frame}!elm\-\_\-frame\-\_\-collapse\-\_\-set@{elm\-\_\-frame\-\_\-collapse\-\_\-set}}
\index{elm\-\_\-frame\-\_\-collapse\-\_\-set@{elm\-\_\-frame\-\_\-collapse\-\_\-set}!Frame@{Frame}}
\subsubsection[{elm\-\_\-frame\-\_\-collapse\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-frame\-\_\-collapse\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{Eina\-\_\-\-Bool}]{collapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga42d7d36cbc69ae0a644d57b30e086adc}


Manually collapse a frame without animations. 


\begin{DoxyParams}{Parameters}
{\em obj} & The frame \\
\hline
{\em collapse} & true to collapse, false to expand\\
\hline
\end{DoxyParams}
Use this to toggle the collapsed state of a frame, bypassing animations. 

References elm\-\_\-obj\-\_\-frame\-\_\-collapse\-\_\-set.

