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


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


\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+O\+A\+PI void \hyperlink{group__Elm__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\+PI Eina\+\_\+\+Bool \hyperlink{group__Elm__Frame_ga2818afb625bc0281c298d69f8603d2a7}{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Determine the collapse state of a frame Use this to determine the collapse state of a frame. \end{DoxyCompactList}\item 
E\+O\+A\+PI void \hyperlink{group__Elm__Frame_ga72a732d5cc8a9d14f3808346d3ba2302}{elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+set} (Eina\+\_\+\+Bool autocollapse)
\begin{DoxyCompactList}\small\item\em Toggle autocollapsing of a frame When {\ttfamily enable} is {\ttfamily true}, clicking a frame\textquotesingle{}s label will collapse the frame vertically, shrinking it to the height of the label. \end{DoxyCompactList}\item 
E\+O\+A\+PI Eina\+\_\+\+Bool \hyperlink{group__Elm__Frame_ga8dbfc472e951b1ae38a6b1aa92ae33dc}{elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
E\+O\+A\+PI void \hyperlink{group__Elm__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__Elm__Frame_ga7f8a3e27fd54d76e770ba92cf00da6f2}{elm\+\_\+frame\+\_\+collapse\+\_\+set} (Elm\+\_\+\+Frame $\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__Elm__Frame_ga1d9823056f5ed2f623ad247e27206f57}{elm\+\_\+frame\+\_\+collapse\+\_\+get} (const Elm\+\_\+\+Frame $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine the collapse state of a frame Use this to determine the collapse state of a frame. \end{DoxyCompactList}\item 
void \hyperlink{group__Elm__Frame_ga5480a0bc143b234e842f2d8b189c2085}{elm\+\_\+frame\+\_\+autocollapse\+\_\+set} (Elm\+\_\+\+Frame $\ast$obj, Eina\+\_\+\+Bool autocollapse)
\begin{DoxyCompactList}\small\item\em Toggle autocollapsing of a frame When {\ttfamily enable} is {\ttfamily true}, clicking a frame\textquotesingle{}s label will collapse the frame vertically, shrinking it to the height of the label. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Elm__Frame_ga04e279efdac9b693e1f56e166dd691c9}{elm\+\_\+frame\+\_\+autocollapse\+\_\+get} (const Elm\+\_\+\+Frame $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
void \hyperlink{group__Elm__Frame_gacfeeddd2ab330dbde6fdd6ffdc0ba1b4}{elm\+\_\+frame\+\_\+collapse\+\_\+go} (Elm\+\_\+\+Frame $\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__Elm__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[width=\textwidth,height=\textheight/2,keepaspectratio=true]{frame_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{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 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\textquotesingle{}s label
\item {\ttfamily \char`\"{}language,changed\char`\"{}} -\/ the program\textquotesingle{}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`\"{} -\/ A label of the frame\end{DoxyItemize}
Supported elm\+\_\+object common A\+P\+Is. \begin{DoxyItemize}
\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}\end{DoxyItemize}
For a detailed example see the \hyperlink{tutorial_frame}{Frame example}. 

\subsection{Function Documentation}
\mbox{\label{group__Elm__Frame_ga02fadf955eebe3737e076b08ef81b159}} 
\index{Frame@{Frame}!elm\+\_\+frame\+\_\+add@{elm\+\_\+frame\+\_\+add}}
\index{elm\+\_\+frame\+\_\+add@{elm\+\_\+frame\+\_\+add}!Frame@{Frame}}
\subsubsection{\texorpdfstring{elm\+\_\+frame\+\_\+add()}{elm\_frame\_add()}}
{\footnotesize\ttfamily Evas\+\_\+\+Object$\ast$ elm\+\_\+frame\+\_\+add (\begin{DoxyParamCaption}\item[{Evas\+\_\+\+Object $\ast$}]{parent }\end{DoxyParamCaption})}



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


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

\mbox{\label{group__Elm__Frame_ga04e279efdac9b693e1f56e166dd691c9}} 
\index{Frame@{Frame}!elm\+\_\+frame\+\_\+autocollapse\+\_\+get@{elm\+\_\+frame\+\_\+autocollapse\+\_\+get}}
\index{elm\+\_\+frame\+\_\+autocollapse\+\_\+get@{elm\+\_\+frame\+\_\+autocollapse\+\_\+get}!Frame@{Frame}}
\subsubsection{\texorpdfstring{elm\+\_\+frame\+\_\+autocollapse\+\_\+get()}{elm\_frame\_autocollapse\_get()}}
{\footnotesize\ttfamily Eina\+\_\+\+Bool elm\+\_\+frame\+\_\+autocollapse\+\_\+get (\begin{DoxyParamCaption}\item[{const Elm\+\_\+\+Frame $\ast$}]{obj }\end{DoxyParamCaption})}



Determine autocollapsing of a frame. 

When this returns {\ttfamily true}, clicking a frame\textquotesingle{}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\+ED.

\begin{DoxyReturn}{Returns}
Whether to enable autocollapse. 
\end{DoxyReturn}


References elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+get().

\mbox{\label{group__Elm__Frame_ga5480a0bc143b234e842f2d8b189c2085}} 
\index{Frame@{Frame}!elm\+\_\+frame\+\_\+autocollapse\+\_\+set@{elm\+\_\+frame\+\_\+autocollapse\+\_\+set}}
\index{elm\+\_\+frame\+\_\+autocollapse\+\_\+set@{elm\+\_\+frame\+\_\+autocollapse\+\_\+set}!Frame@{Frame}}
\subsubsection{\texorpdfstring{elm\+\_\+frame\+\_\+autocollapse\+\_\+set()}{elm\_frame\_autocollapse\_set()}}
{\footnotesize\ttfamily void elm\+\_\+frame\+\_\+autocollapse\+\_\+set (\begin{DoxyParamCaption}\item[{Elm\+\_\+\+Frame $\ast$}]{obj,  }\item[{Eina\+\_\+\+Bool}]{autocollapse }\end{DoxyParamCaption})}



Toggle autocollapsing of a frame When {\ttfamily enable} is {\ttfamily true}, clicking a frame\textquotesingle{}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\+ED.


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


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

\mbox{\label{group__Elm__Frame_ga1d9823056f5ed2f623ad247e27206f57}} 
\index{Frame@{Frame}!elm\+\_\+frame\+\_\+collapse\+\_\+get@{elm\+\_\+frame\+\_\+collapse\+\_\+get}}
\index{elm\+\_\+frame\+\_\+collapse\+\_\+get@{elm\+\_\+frame\+\_\+collapse\+\_\+get}!Frame@{Frame}}
\subsubsection{\texorpdfstring{elm\+\_\+frame\+\_\+collapse\+\_\+get()}{elm\_frame\_collapse\_get()}}
{\footnotesize\ttfamily Eina\+\_\+\+Bool elm\+\_\+frame\+\_\+collapse\+\_\+get (\begin{DoxyParamCaption}\item[{const Elm\+\_\+\+Frame $\ast$}]{obj }\end{DoxyParamCaption})}



Determine the collapse state of a frame Use this to determine the collapse state of a frame. 

\begin{DoxyReturn}{Returns}
{\ttfamily true} to collapse, {\ttfamily false} to expand. 
\end{DoxyReturn}


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

\mbox{\label{group__Elm__Frame_gacfeeddd2ab330dbde6fdd6ffdc0ba1b4}} 
\index{Frame@{Frame}!elm\+\_\+frame\+\_\+collapse\+\_\+go@{elm\+\_\+frame\+\_\+collapse\+\_\+go}}
\index{elm\+\_\+frame\+\_\+collapse\+\_\+go@{elm\+\_\+frame\+\_\+collapse\+\_\+go}!Frame@{Frame}}
\subsubsection{\texorpdfstring{elm\+\_\+frame\+\_\+collapse\+\_\+go()}{elm\_frame\_collapse\_go()}}
{\footnotesize\ttfamily void elm\+\_\+frame\+\_\+collapse\+\_\+go (\begin{DoxyParamCaption}\item[{Elm\+\_\+\+Frame $\ast$}]{obj,  }\item[{Eina\+\_\+\+Bool}]{collapse }\end{DoxyParamCaption})}



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} & {\ttfamily true} to collapse, {\ttfamily false} to expand. \\
\hline
\end{DoxyParams}


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

\mbox{\label{group__Elm__Frame_ga7f8a3e27fd54d76e770ba92cf00da6f2}} 
\index{Frame@{Frame}!elm\+\_\+frame\+\_\+collapse\+\_\+set@{elm\+\_\+frame\+\_\+collapse\+\_\+set}}
\index{elm\+\_\+frame\+\_\+collapse\+\_\+set@{elm\+\_\+frame\+\_\+collapse\+\_\+set}!Frame@{Frame}}
\subsubsection{\texorpdfstring{elm\+\_\+frame\+\_\+collapse\+\_\+set()}{elm\_frame\_collapse\_set()}}
{\footnotesize\ttfamily void elm\+\_\+frame\+\_\+collapse\+\_\+set (\begin{DoxyParamCaption}\item[{Elm\+\_\+\+Frame $\ast$}]{obj,  }\item[{Eina\+\_\+\+Bool}]{collapse }\end{DoxyParamCaption})}



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} & {\ttfamily true} to collapse, {\ttfamily false} to expand. \\
\hline
\end{DoxyParams}


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

\mbox{\label{group__Elm__Frame_ga8dbfc472e951b1ae38a6b1aa92ae33dc}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+get()}{elm\_obj\_frame\_autocollapse\_get()}}
{\footnotesize\ttfamily E\+O\+A\+PI Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+get (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Determine autocollapsing of a frame. 

When this returns {\ttfamily true}, clicking a frame\textquotesingle{}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\+ED.

\begin{DoxyReturn}{Returns}
Whether to enable autocollapse. 
\end{DoxyReturn}


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

\mbox{\label{group__Elm__Frame_ga72a732d5cc8a9d14f3808346d3ba2302}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+set()}{elm\_obj\_frame\_autocollapse\_set()}}
{\footnotesize\ttfamily E\+O\+A\+PI void elm\+\_\+obj\+\_\+frame\+\_\+autocollapse\+\_\+set (\begin{DoxyParamCaption}\item[{Eina\+\_\+\+Bool}]{autocollapse }\end{DoxyParamCaption})}



Toggle autocollapsing of a frame When {\ttfamily enable} is {\ttfamily true}, clicking a frame\textquotesingle{}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\+ED.


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


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

\mbox{\label{group__Elm__Frame_ga2818afb625bc0281c298d69f8603d2a7}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+get()}{elm\_obj\_frame\_collapse\_get()}}
{\footnotesize\ttfamily E\+O\+A\+PI Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+get (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}



Determine the collapse state of a frame Use this to determine the collapse state of a frame. 

\begin{DoxyReturn}{Returns}
{\ttfamily true} to collapse, {\ttfamily false} to expand. 
\end{DoxyReturn}


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

\mbox{\label{group__Elm__Frame_ga7e92f1d66e20ff858760635c28aa2266}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go()}{elm\_obj\_frame\_collapse\_go()}}
{\footnotesize\ttfamily E\+O\+A\+PI void elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+go (\begin{DoxyParamCaption}\item[{Eina\+\_\+\+Bool}]{collapse }\end{DoxyParamCaption})}



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} & {\ttfamily true} to collapse, {\ttfamily false} to expand. \\
\hline
\end{DoxyParams}


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

\mbox{\label{group__Elm__Frame_ga5c930d28c99550a51e7573512fd7fbf4}} 
\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{\texorpdfstring{elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+set()}{elm\_obj\_frame\_collapse\_set()}}
{\footnotesize\ttfamily E\+O\+A\+PI void elm\+\_\+obj\+\_\+frame\+\_\+collapse\+\_\+set (\begin{DoxyParamCaption}\item[{Eina\+\_\+\+Bool}]{collapse }\end{DoxyParamCaption})}



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} & {\ttfamily true} to collapse, {\ttfamily false} to expand. \\
\hline
\end{DoxyParams}


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

