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


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


\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+O\+A\+P\+I void \hyperlink{group__Frame_ga5c930d28c99550a51e7573512fd7fbf4}{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+set} (Eina\+\_\+\+Bool collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame without animations Use this to toggle the collapsed state of a frame, bypassing animations. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Frame_ga2818afb625bc0281c298d69f8603d2a7}{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Determine the collapse state of a frame. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Frame_ga72a732d5cc8a9d14f3808346d3ba2302}{elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+set} (Eina\+\_\+\+Bool autocollapse)
\begin{DoxyCompactList}\small\item\em Toggle autocollapsing of a frame 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. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Frame_ga8dbfc472e951b1ae38a6b1aa92ae33dc}{elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Frame_ga7e92f1d66e20ff858760635c28aa2266}{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go} (Eina\+\_\+\+Bool collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga677e94ecb891a6c070bd1e1e03e2f749}{elm\+\_\+frame\+::collapse\+\_\+go} (bool collapse\+\_\+) const 
\begin{DoxyCompactList}\small\item\em Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga2f1e6716ad9c7c525d17c44525ea448c}{elm\+\_\+frame\+\_\+collapse\+\_\+set} (Eo $\ast$obj, Eina\+\_\+\+Bool collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame without animations Use this to toggle the collapsed state of a frame, bypassing animations. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Frame_gaeb18b9fa30f0c04bca4d0052c1564fa5}{elm\+\_\+frame\+\_\+collapse\+\_\+get} (const Eo $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine the collapse state of a frame. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga339d439f602f556c61f37a426f55c825}{elm\+\_\+frame\+\_\+autocollapse\+\_\+set} (Eo $\ast$obj, Eina\+\_\+\+Bool autocollapse)
\begin{DoxyCompactList}\small\item\em Toggle autocollapsing of a frame 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. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Frame_gae5d50e1015638b33e1142f016f22c216}{elm\+\_\+frame\+\_\+autocollapse\+\_\+get} (const Eo $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
void \hyperlink{group__Frame_ga3fcf2262d33002f131f198de01feaaa7}{elm\+\_\+frame\+\_\+collapse\+\_\+go} (Eo $\ast$obj, Eina\+\_\+\+Bool collapse)
\begin{DoxyCompactList}\small\item\em Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. \end{DoxyCompactList}\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}\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
\item {\ttfamily \char`\"{}language,changed\char`\"{}} -\/ the program's language changed (since 1.\+9)
\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{Function Documentation}
\index{Frame@{Frame}!collapse\+\_\+go@{collapse\+\_\+go}}
\index{collapse\+\_\+go@{collapse\+\_\+go}!Frame@{Frame}}
\subsubsection[{collapse\+\_\+go}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+frame\+::collapse\+\_\+go (
\begin{DoxyParamCaption}
\item[{bool}]{collapse\+\_\+}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}\label{group__Frame_ga677e94ecb891a6c070bd1e1e03e2f749}


Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. 


\begin{DoxyParams}{Parameters}
{\em collapse} & true to collapse, false to expand \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go().

\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 Eo $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Frame_gae5d50e1015638b33e1142f016f22c216}


Determine autocollapsing of a frame. 

\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[{Eo $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{autocollapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga339d439f602f556c61f37a426f55c825}


Toggle autocollapsing of a frame 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.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em autocollapse} & Whether to enable autocollapse \\
\hline
\end{DoxyParams}


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 Eo $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Frame_gaeb18b9fa30f0c04bca4d0052c1564fa5}


Determine the collapse state of a frame. 

\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[{Eo $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{collapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga3fcf2262d33002f131f198de01feaaa7}


Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em collapse} & true to collapse, false to expand \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go().

\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[{Eo $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{collapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga2f1e6716ad9c7c525d17c44525ea448c}


Manually collapse a frame without animations Use this to toggle the collapsed state of a frame, bypassing animations. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em collapse} & true to collapse, false to expand \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+set().

\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}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Frame_ga8dbfc472e951b1ae38a6b1aa92ae33dc}


Determine autocollapsing of a frame. 

\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. 

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}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{autocollapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga72a732d5cc8a9d14f3808346d3ba2302}


Toggle autocollapsing of a frame 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.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em autocollapse} & Whether to enable autocollapse \\
\hline
\end{DoxyParams}


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}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Frame_ga2818afb625bc0281c298d69f8603d2a7}


Determine the collapse state of a frame. 

\begin{DoxyReturn}{Returns}
true if collapsed, false otherwise
\end{DoxyReturn}
Use this to determine the collapse state of a frame. 

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

\index{Frame@{Frame}!elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go@{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go}}
\index{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go@{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go}!Frame@{Frame}}
\subsubsection[{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{collapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga7e92f1d66e20ff858760635c28aa2266}


Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em collapse} & true to collapse, false to expand \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+frame\+::collapse\+\_\+go(), and elm\+\_\+frame\+\_\+collapse\+\_\+go().

\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}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{collapse}
\end{DoxyParamCaption}
)}\label{group__Frame_ga5c930d28c99550a51e7573512fd7fbf4}


Manually collapse a frame without animations Use this to toggle the collapsed state of a frame, bypassing animations. 


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em collapse} & true to collapse, false to expand \\
\hline
\end{DoxyParams}


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

