\hypertarget{group__Elm__Frame__Group}{}\doxysection{Frame}
\label{group__Elm__Frame__Group}\index{Frame@{Frame}}


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


\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \mbox{\hyperlink{group__Elm__Frame__Group_gad0153a9368aaf34ba309d2e97798aa81}{elm\+\_\+frame\+\_\+collapse\+\_\+set}} (Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$obj, \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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 
\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Elm__Frame__Group_ga1b723ef0c8fb52bac623d085da0c4a0a}{elm\+\_\+frame\+\_\+collapse\+\_\+get}} (const Efl\+\_\+\+Ui\+\_\+\+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 \mbox{\hyperlink{group__Elm__Frame__Group_ga7c36b44540b82c6e31ccd2033caabf8c}{elm\+\_\+frame\+\_\+autocollapse\+\_\+set}} (Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$obj, \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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 
\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Elm__Frame__Group_ga95db4550cac87eea95a08cdb9b4223ee}{elm\+\_\+frame\+\_\+autocollapse\+\_\+get}} (const Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$obj)
\begin{DoxyCompactList}\small\item\em Determine autocollapsing of a frame. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Frame__Group_gac86a77bf9e7f11dd9c82414500221417}{elm\+\_\+frame\+\_\+collapse\+\_\+go}} (Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$obj, \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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 
\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ \mbox{\hyperlink{group__Elm__Frame__Group_ga7a1801e032f479332d8c68b17bc2e0bf}{elm\+\_\+frame\+\_\+add}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new frame to the parent. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{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 \item overlay \item icon \item icon\+\_\+overlay \item border \item border\+\_\+overlay\end{DoxyItemize}
Of all this styles only default shows the title.

This widget inherits from the \mbox{\hyperlink{group__Elm__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 \mbox{\hyperlink{group__Elm__Layout}{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)
\item {\ttfamily \char`\"{}close\char`\"{}} -\/ The user has clicked the close button if there is one
\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 APIs. \begin{DoxyItemize}
\item \mbox{\hyperlink{group__Elm__General_ga9c088563c442670796564d2e5158f154}{elm\+\_\+object\+\_\+part\+\_\+text\+\_\+set}} \item \mbox{\hyperlink{group__Elm__General_ga6f5eac98644d176723b809c2c9d8db80}{elm\+\_\+object\+\_\+part\+\_\+text\+\_\+get}} \item \mbox{\hyperlink{group__Elm__General_ga0531ec8867c72def7c780601764ca642}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+set}} \item \mbox{\hyperlink{group__Elm__General_ga86b0088bbf018964a980f56e02ee2248}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+get}} \item \mbox{\hyperlink{group__Elm__General_ga73862b640f3f362a130c2824ef570046}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+unset}}\end{DoxyItemize}
For a detailed example see the \mbox{\hyperlink{tutorial_frame}{Frame example}}. 

\doxysubsection{Function Documentation}
\mbox{\Hypertarget{group__Elm__Frame__Group_gad0153a9368aaf34ba309d2e97798aa81}\label{group__Elm__Frame__Group_gad0153a9368aaf34ba309d2e97798aa81}} 
\index{Frame@{Frame}!elm\_frame\_collapse\_set@{elm\_frame\_collapse\_set}}
\index{elm\_frame\_collapse\_set@{elm\_frame\_collapse\_set}!Frame@{Frame}}
\doxysubsubsection{\texorpdfstring{elm\_frame\_collapse\_set()}{elm\_frame\_collapse\_set()}}
{\footnotesize\ttfamily void elm\+\_\+frame\+\_\+collapse\+\_\+set (\begin{DoxyParamCaption}\item[{Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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{\texttt{ in}}  & {\em obj} & The object. \\
\hline
\mbox{\texttt{ in}}  & {\em collapse} & {\ttfamily true} to collapse, {\ttfamily false} to expand. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{group__Elm__Frame__Group_ga1b723ef0c8fb52bac623d085da0c4a0a}\label{group__Elm__Frame__Group_ga1b723ef0c8fb52bac623d085da0c4a0a}} 
\index{Frame@{Frame}!elm\_frame\_collapse\_get@{elm\_frame\_collapse\_get}}
\index{elm\_frame\_collapse\_get@{elm\_frame\_collapse\_get}!Frame@{Frame}}
\doxysubsubsection{\texorpdfstring{elm\_frame\_collapse\_get()}{elm\_frame\_collapse\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} elm\+\_\+frame\+\_\+collapse\+\_\+get (\begin{DoxyParamCaption}\item[{const Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$}]{obj }\end{DoxyParamCaption})}



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


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em obj} & The object.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily true} to collapse, {\ttfamily false} to expand. 
\end{DoxyReturn}
\mbox{\Hypertarget{group__Elm__Frame__Group_ga7c36b44540b82c6e31ccd2033caabf8c}\label{group__Elm__Frame__Group_ga7c36b44540b82c6e31ccd2033caabf8c}} 
\index{Frame@{Frame}!elm\_frame\_autocollapse\_set@{elm\_frame\_autocollapse\_set}}
\index{elm\_frame\_autocollapse\_set@{elm\_frame\_autocollapse\_set}!Frame@{Frame}}
\doxysubsubsection{\texorpdfstring{elm\_frame\_autocollapse\_set()}{elm\_frame\_autocollapse\_set()}}
{\footnotesize\ttfamily void elm\+\_\+frame\+\_\+autocollapse\+\_\+set (\begin{DoxyParamCaption}\item[{Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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 DISABLED.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em obj} & The object. \\
\hline
\mbox{\texttt{ in}}  & {\em autocollapse} & Whether to enable autocollapse. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{group__Elm__Frame__Group_ga95db4550cac87eea95a08cdb9b4223ee}\label{group__Elm__Frame__Group_ga95db4550cac87eea95a08cdb9b4223ee}} 
\index{Frame@{Frame}!elm\_frame\_autocollapse\_get@{elm\_frame\_autocollapse\_get}}
\index{elm\_frame\_autocollapse\_get@{elm\_frame\_autocollapse\_get}!Frame@{Frame}}
\doxysubsubsection{\texorpdfstring{elm\_frame\_autocollapse\_get()}{elm\_frame\_autocollapse\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} elm\+\_\+frame\+\_\+autocollapse\+\_\+get (\begin{DoxyParamCaption}\item[{const Efl\+\_\+\+Ui\+\_\+\+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 DISABLED.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em obj} & The object.\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Whether to enable autocollapse. 
\end{DoxyReturn}
\mbox{\Hypertarget{group__Elm__Frame__Group_gac86a77bf9e7f11dd9c82414500221417}\label{group__Elm__Frame__Group_gac86a77bf9e7f11dd9c82414500221417}} 
\index{Frame@{Frame}!elm\_frame\_collapse\_go@{elm\_frame\_collapse\_go}}
\index{elm\_frame\_collapse\_go@{elm\_frame\_collapse\_go}!Frame@{Frame}}
\doxysubsubsection{\texorpdfstring{elm\_frame\_collapse\_go()}{elm\_frame\_collapse\_go()}}
{\footnotesize\ttfamily void elm\+\_\+frame\+\_\+collapse\+\_\+go (\begin{DoxyParamCaption}\item[{Efl\+\_\+\+Ui\+\_\+\+Frame $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{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{\texttt{ in}}  & {\em obj} & The object. \\
\hline
\mbox{\texttt{ in}}  & {\em collapse} & {\ttfamily true} to collapse, {\ttfamily false} to expand. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{group__Elm__Frame__Group_ga7a1801e032f479332d8c68b17bc2e0bf}\label{group__Elm__Frame__Group_ga7a1801e032f479332d8c68b17bc2e0bf}} 
\index{Frame@{Frame}!elm\_frame\_add@{elm\_frame\_add}}
\index{elm\_frame\_add@{elm\_frame\_add}!Frame@{Frame}}
\doxysubsubsection{\texorpdfstring{elm\_frame\_add()}{elm\_frame\_add()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ elm\+\_\+frame\+\_\+add (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{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 NULL if it cannot be created 
\end{DoxyReturn}


References \mbox{\hyperlink{group__Eina__Safety__Checks__Group_gab2b07061fc6500dedd9cd41c8d16f95d}{EINA\+\_\+\+SAFETY\+\_\+\+ON\+\_\+\+NULL\+\_\+\+RETURN\+\_\+\+VAL}}.

