\section{Box}
\label{group__Box}\index{Box@{Box}}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef struct \+\_\+\+Elm\+\_\+\+Box\+\_\+\+Transition \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition}
\begin{DoxyCompactList}\small\item\em Opaque handler containing the parameters to perform an animated transition of the layout the box uses. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga14095878ba67db427313cf669e10f942}{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set} (Eina\+\_\+\+Bool homogeneous)
\begin{DoxyCompactList}\small\item\em Set the box to arrange its children homogeneously. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Box_ga79a2f10858792b922c275a3d5468d394}{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get whether the box is using homogeneous mode or not. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga484d4e8bc3d4739b5e82794689a6d990}{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set} (double horizontal, double vertical)
\begin{DoxyCompactList}\small\item\em Set the alignment of the whole bounding box of contents. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga3bec6164b4c6c7a483a8e33dc5e27103}{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get} (double $\ast$horizontal, double $\ast$vertical)
\begin{DoxyCompactList}\small\item\em Get the alignment of the whole bounding box of contents. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_gade6ada6e03d44a2c7b23a82f4b1ce1bc}{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set} (Eina\+\_\+\+Bool horizontal)
\begin{DoxyCompactList}\small\item\em Set the horizontal orientation. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+Bool \hyperlink{group__Box_ga865a8ac3b41e422e9b859eba9ee3b66a}{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get the horizontal orientation. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga0a5ab0e4826a38ccd581341bbd736bd5}{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set} (Evas\+\_\+\+Coord horizontal, Evas\+\_\+\+Coord vertical)
\begin{DoxyCompactList}\small\item\em Set the space (padding) between the box\textquotesingle{}s elements. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_gaec34ab56d2b304bc017dbc7319a38614}{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get} (Evas\+\_\+\+Coord $\ast$horizontal, Evas\+\_\+\+Coord $\ast$vertical)
\begin{DoxyCompactList}\small\item\em Get the space (padding) between the box\textquotesingle{}s elements. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga249f004db8fcf47bc3fdc76bc8026ec5}{elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set} (Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout cb, const void $\ast$data, Ecore\+\_\+\+Cb free\+\_\+data)
\begin{DoxyCompactList}\small\item\em Set the layout defining function to be used by the box. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I Eina\+\_\+\+List $\ast$ \hyperlink{group__Box_ga13a2d41f59bc543c6a2a8df3d0d6f8b6}{elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get} (void)
\begin{DoxyCompactList}\small\item\em Get a list of the objects packed into the box. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_gaff20f849863272aa857708655d326838}{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end} (Evas\+\_\+\+Object $\ast$subobj)
\begin{DoxyCompactList}\small\item\em Add an object at the end of the pack list. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga8ca796fd2cee6871408c2b7a6ef7c422}{elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all} (void)
\begin{DoxyCompactList}\small\item\em Remove all items from the box, without deleting them. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_gab6f479bf81638fef69c7ddc62bcd6a02}{elm\+\_\+obj\+\_\+box\+\_\+unpack} (Evas\+\_\+\+Object $\ast$subobj)
\begin{DoxyCompactList}\small\item\em Unpack a box item. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga5783fb380fd4fb3996d8693797ae8af6}{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after} (Evas\+\_\+\+Object $\ast$subobj, Evas\+\_\+\+Object $\ast$after)
\begin{DoxyCompactList}\small\item\em Adds an object to the box after the indicated object. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_gae36cfcf68ed007195c548137954c858d}{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start} (Evas\+\_\+\+Object $\ast$subobj)
\begin{DoxyCompactList}\small\item\em Add an object to the beginning of the pack list. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga8cb5b13b78f2f2d9b0d8872e9c362c9e}{elm\+\_\+obj\+\_\+box\+\_\+recalculate} (void)
\begin{DoxyCompactList}\small\item\em Force the box to recalculate its children packing. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga1921c76bdbc88d7662d7e1eae833385d}{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before} (Evas\+\_\+\+Object $\ast$subobj, Evas\+\_\+\+Object $\ast$before)
\begin{DoxyCompactList}\small\item\em Adds an object to the box before the indicated object. \end{DoxyCompactList}\item 
E\+O\+A\+P\+I void \hyperlink{group__Box_ga31e0d2d68893860666e54d7173ea213f}{elm\+\_\+obj\+\_\+box\+\_\+clear} (void)
\begin{DoxyCompactList}\small\item\em Clear the box of all children. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_gad16ee458b6ab6aa4815b79819602ff6a}{elm\+\_\+box\+\_\+homogeneous\+\_\+set} (Elm\+\_\+\+Box $\ast$obj, Eina\+\_\+\+Bool homogeneous)
\begin{DoxyCompactList}\small\item\em Set the box to arrange its children homogeneously. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Box_gad2f03a768b0f30bdc4903a5036509e40}{elm\+\_\+box\+\_\+homogeneous\+\_\+get} (const Elm\+\_\+\+Box $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get whether the box is using homogeneous mode or not. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set} (Elm\+\_\+\+Box $\ast$obj, double horizontal, double vertical)
\begin{DoxyCompactList}\small\item\em Set the alignment of the whole bounding box of contents. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga1bbf3f33dad76e9eefbfaa738810be45}{elm\+\_\+box\+\_\+align\+\_\+get} (const Elm\+\_\+\+Box $\ast$obj, double $\ast$horizontal, double $\ast$vertical)
\begin{DoxyCompactList}\small\item\em Get the alignment of the whole bounding box of contents. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga447f790a64a49b477019938dc3d5c3ff}{elm\+\_\+box\+\_\+horizontal\+\_\+set} (Elm\+\_\+\+Box $\ast$obj, Eina\+\_\+\+Bool horizontal)
\begin{DoxyCompactList}\small\item\em Set the horizontal orientation. \end{DoxyCompactList}\item 
Eina\+\_\+\+Bool \hyperlink{group__Box_ga18628d249a263c4c09e8e87752fdc15d}{elm\+\_\+box\+\_\+horizontal\+\_\+get} (const Elm\+\_\+\+Box $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the horizontal orientation. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}{elm\+\_\+box\+\_\+padding\+\_\+set} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Coord horizontal, Evas\+\_\+\+Coord vertical)
\begin{DoxyCompactList}\small\item\em Set the space (padding) between the box\textquotesingle{}s elements. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga1b8dbe3d8203a0b9c17d072be799ab5c}{elm\+\_\+box\+\_\+padding\+\_\+get} (const Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Coord $\ast$horizontal, Evas\+\_\+\+Coord $\ast$vertical)
\begin{DoxyCompactList}\small\item\em Get the space (padding) between the box\textquotesingle{}s elements. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_gafb8732b243d82835f93a8ab0cef2eae5}{elm\+\_\+box\+\_\+layout\+\_\+set} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout cb, const void $\ast$data, Ecore\+\_\+\+Cb free\+\_\+data)
\begin{DoxyCompactList}\small\item\em Set the layout defining function to be used by the box. \end{DoxyCompactList}\item 
Eina\+\_\+\+List $\ast$ \hyperlink{group__Box_ga58d3e0a39f1b743418667968c0231ea8}{elm\+\_\+box\+\_\+children\+\_\+get} (const Elm\+\_\+\+Box $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get a list of the objects packed into the box. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Object $\ast$subobj)
\begin{DoxyCompactList}\small\item\em Add an object at the end of the pack list. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all} (Elm\+\_\+\+Box $\ast$obj)
\begin{DoxyCompactList}\small\item\em Remove all items from the box, without deleting them. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Object $\ast$subobj)
\begin{DoxyCompactList}\small\item\em Unpack a box item. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Object $\ast$subobj, Evas\+\_\+\+Object $\ast$after)
\begin{DoxyCompactList}\small\item\em Adds an object to the box after the indicated object. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Object $\ast$subobj)
\begin{DoxyCompactList}\small\item\em Add an object to the beginning of the pack list. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_gab90fadde9fa440fa6d4d38dd7b4a92c1}{elm\+\_\+box\+\_\+recalculate} (Elm\+\_\+\+Box $\ast$obj)
\begin{DoxyCompactList}\small\item\em Force the box to recalculate its children packing. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before} (Elm\+\_\+\+Box $\ast$obj, Evas\+\_\+\+Object $\ast$subobj, Evas\+\_\+\+Object $\ast$before)
\begin{DoxyCompactList}\small\item\em Adds an object to the box before the indicated object. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear} (Elm\+\_\+\+Box $\ast$obj)
\begin{DoxyCompactList}\small\item\em Clear the box of all children. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition} (Evas\+\_\+\+Object $\ast$obj, Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Data $\ast$priv, void $\ast$data)
\begin{DoxyCompactList}\small\item\em Special layout function that animates the transition from one layout to another. \end{DoxyCompactList}\item 
\hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition} $\ast$ \hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new} (const double duration, Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout start\+\_\+layout, void $\ast$start\+\_\+layout\+\_\+data, Ecore\+\_\+\+Cb start\+\_\+layout\+\_\+free\+\_\+data, Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout end\+\_\+layout, void $\ast$end\+\_\+layout\+\_\+data, Ecore\+\_\+\+Cb end\+\_\+layout\+\_\+free\+\_\+data, Ecore\+\_\+\+Cb transition\+\_\+end\+\_\+cb, void $\ast$transition\+\_\+end\+\_\+data)
\begin{DoxyCompactList}\small\item\em Create a new \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition} to animate the switch of layouts. \end{DoxyCompactList}\item 
void \hyperlink{group__Box_gab7b726e4dbfb80da529431d198add95e}{elm\+\_\+box\+\_\+transition\+\_\+free} (void $\ast$data)
\begin{DoxyCompactList}\small\item\em Free a Elm\+\_\+\+Box\+\_\+\+Transition instance created with \hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new()}. \end{DoxyCompactList}\item 
Evas\+\_\+\+Object $\ast$ \hyperlink{group__Box_ga3d0998b60ada633bacfa8869a921cfd7}{elm\+\_\+box\+\_\+add} (Evas\+\_\+\+Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new box to the parent. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{box_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth]{img/widget/box/preview-00}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth]{box}}
\end{DoxyImageNoCaption}


A box arranges objects in a linear fashion, governed by a layout function that defines the details of this arrangement.

By default, the box will use an internal function to set the layout to a single row, either vertical or horizontal. This layout is affected by a number of parameters, such as the homogeneous flag set by \hyperlink{group__Box_gad16ee458b6ab6aa4815b79819602ff6a}{elm\+\_\+box\+\_\+homogeneous\+\_\+set()}, the values given by \hyperlink{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}{elm\+\_\+box\+\_\+padding\+\_\+set()} and \hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set()} and the hints set to each object in the box.

For this default layout, it\textquotesingle{}s possible to change the orientation with \hyperlink{group__Box_ga447f790a64a49b477019938dc3d5c3ff}{elm\+\_\+box\+\_\+horizontal\+\_\+set()}. The box will start in the vertical orientation, placing its elements ordered from top to bottom. When horizontal is set, the order will go from left to right. If the box is set to be homogeneous, every object in it will be assigned the same space, that of the largest object. Padding can be used to set some spacing between the cell given to each object. The alignment of the box, set with \hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set()}, determines how the bounding box of all the elements will be placed within the space given to the box widget itself.

The size hints of each object also affect how they are placed and sized within the box. evas\+\_\+object\+\_\+size\+\_\+hint\+\_\+min\+\_\+set() will give the minimum size the object can have, and the box will use it as the basis for all latter calculations. Elementary widgets set their own minimum size as needed, so there\textquotesingle{}s rarely any need to use it manually.

evas\+\_\+object\+\_\+size\+\_\+hint\+\_\+weight\+\_\+set(), when not in homogeneous mode, is used to tell whether the object will be allocated the minimum size it needs or if the space given to it should be expanded. It\textquotesingle{}s important to realize that expanding the size given to the object is not the same thing as resizing the object. It could very well end being a small widget floating in a much larger empty space. If not set, the weight for objects will normally be 0.\+0 for both axis, meaning the widget will not be expanded. To take as much space possible, set the weight to E\+V\+A\+S\+\_\+\+H\+I\+N\+T\+\_\+\+E\+X\+P\+A\+N\+D (defined to 1.\+0) for the desired axis to expand.

Besides how much space each object is allocated, it\textquotesingle{}s possible to control how the widget will be placed within that space using evas\+\_\+object\+\_\+size\+\_\+hint\+\_\+align\+\_\+set(). By default, this value will be 0.\+5 for both axis, meaning the object will be centered, but any value from 0.\+0 (left or top, for the {\ttfamily x} and {\ttfamily y} axis, respectively) to 1.\+0 (right or bottom) can be used. The special value E\+V\+A\+S\+\_\+\+H\+I\+N\+T\+\_\+\+F\+I\+L\+L, which is -\/1.\+0, means the object will be resized to fill the entire space it was allocated.

In addition, customized functions to define the layout can be set, which allow the application developer to organize the objects within the box in any number of ways.

The special \hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()} function can be used to switch from one layout to another, animating the motion of the children of the box.

\begin{DoxyNote}{Note}
Objects should not be added to box objects using \+\_\+add() calls.
\end{DoxyNote}
Some examples on how to use boxes follow\+: \begin{DoxyItemize}
\item \hyperlink{box_example_01}{Box -\/ Basic A\+P\+I} \item \hyperlink{box_example_02}{Box -\/ Layout transitions} \end{DoxyItemize}


\subsection{Typedef Documentation}
\index{Box@{Box}!Elm\+\_\+\+Box\+\_\+\+Transition@{Elm\+\_\+\+Box\+\_\+\+Transition}}
\index{Elm\+\_\+\+Box\+\_\+\+Transition@{Elm\+\_\+\+Box\+\_\+\+Transition}!Box@{Box}}
\subsubsection[{Elm\+\_\+\+Box\+\_\+\+Transition}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Box\+\_\+\+Transition}}\label{group__Box_ga9cd35aa22988c800aa981f25ada92ced}


Opaque handler containing the parameters to perform an animated transition of the layout the box uses. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new()} 

\hyperlink{group__Box_gafb8732b243d82835f93a8ab0cef2eae5}{elm\+\_\+box\+\_\+layout\+\_\+set()} 

\hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()} 
\end{DoxySeeAlso}


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


Add a new box to the parent. 

By default, the box will be in vertical mode and non-\/homogeneous.


\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{Box@{Box}!elm\+\_\+box\+\_\+align\+\_\+get@{elm\+\_\+box\+\_\+align\+\_\+get}}
\index{elm\+\_\+box\+\_\+align\+\_\+get@{elm\+\_\+box\+\_\+align\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+align\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+align\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{double $\ast$}]{horizontal, }
\item[{double $\ast$}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_ga1bbf3f33dad76e9eefbfaa738810be45}


Get the alignment of the whole bounding box of contents. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em horizontal} & The horizontal alignment of elements \\
\hline
\mbox{\tt out}  & {\em vertical} & The vertical alignment of elements \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get().

\index{Box@{Box}!elm\+\_\+box\+\_\+align\+\_\+set@{elm\+\_\+box\+\_\+align\+\_\+set}}
\index{elm\+\_\+box\+\_\+align\+\_\+set@{elm\+\_\+box\+\_\+align\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+align\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+align\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{double}]{horizontal, }
\item[{double}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_gafc3cbc4e34321e6228579b062fb2802d}


Set the alignment of the whole bounding box of contents. 

Sets how the bounding box containing all the elements of the box, after their sizes and position has been calculated, will be aligned within the space given for the whole box widget.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & The horizontal alignment of elements \\
\hline
\mbox{\tt in}  & {\em vertical} & The vertical alignment of elements \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set().

\index{Box@{Box}!elm\+\_\+box\+\_\+children\+\_\+get@{elm\+\_\+box\+\_\+children\+\_\+get}}
\index{elm\+\_\+box\+\_\+children\+\_\+get@{elm\+\_\+box\+\_\+children\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+children\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+List$\ast$ elm\+\_\+box\+\_\+children\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Box $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Box_ga58d3e0a39f1b743418667968c0231ea8}


Get a list of the objects packed into the box. 

Returns a new {\ttfamily list} with a pointer to {\ttfamily Evas\+\_\+\+Object} in its nodes. The order of the list corresponds to the packing order the box uses.

You must free this list with eina\+\_\+list\+\_\+free() once you are done with it. 

References elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get().

\index{Box@{Box}!elm\+\_\+box\+\_\+clear@{elm\+\_\+box\+\_\+clear}}
\index{elm\+\_\+box\+\_\+clear@{elm\+\_\+box\+\_\+clear}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+clear}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+clear (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Box_ga4616b670f386ab6ddfddce9433c62c08}


Clear the box of all children. 

Remove all the elements contained by the box, deleting the respective objects.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+box\+\_\+clear().



Referenced by elm\+\_\+map\+\_\+overlay\+\_\+bubble\+\_\+content\+\_\+clear().

\index{Box@{Box}!elm\+\_\+box\+\_\+homogeneous\+\_\+get@{elm\+\_\+box\+\_\+homogeneous\+\_\+get}}
\index{elm\+\_\+box\+\_\+homogeneous\+\_\+get@{elm\+\_\+box\+\_\+homogeneous\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+homogeneous\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+box\+\_\+homogeneous\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Box $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Box_gad2f03a768b0f30bdc4903a5036509e40}


Get whether the box is using homogeneous mode or not. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if it\textquotesingle{}s homogeneous, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise 
\end{DoxyReturn}


References elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get().

\index{Box@{Box}!elm\+\_\+box\+\_\+homogeneous\+\_\+set@{elm\+\_\+box\+\_\+homogeneous\+\_\+set}}
\index{elm\+\_\+box\+\_\+homogeneous\+\_\+set@{elm\+\_\+box\+\_\+homogeneous\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+homogeneous\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+homogeneous\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{homogeneous}
\end{DoxyParamCaption}
)}\label{group__Box_gad16ee458b6ab6aa4815b79819602ff6a}


Set the box to arrange its children homogeneously. 

If enabled, homogeneous layout makes all items the same size, according to the size of the largest of its children.

\begin{DoxyNote}{Note}
This flag is ignored if a custom layout function is set.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em homogeneous} & The homogeneous flag \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set().

\index{Box@{Box}!elm\+\_\+box\+\_\+horizontal\+\_\+get@{elm\+\_\+box\+\_\+horizontal\+\_\+get}}
\index{elm\+\_\+box\+\_\+horizontal\+\_\+get@{elm\+\_\+box\+\_\+horizontal\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+horizontal\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}Eina\+\_\+\+Bool elm\+\_\+box\+\_\+horizontal\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Box $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Box_ga18628d249a263c4c09e8e87752fdc15d}


Get the horizontal orientation. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the box is set to horizontal mode, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise 
\end{DoxyReturn}


References elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get().

\index{Box@{Box}!elm\+\_\+box\+\_\+horizontal\+\_\+set@{elm\+\_\+box\+\_\+horizontal\+\_\+set}}
\index{elm\+\_\+box\+\_\+horizontal\+\_\+set@{elm\+\_\+box\+\_\+horizontal\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+horizontal\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+horizontal\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Eina\+\_\+\+Bool}]{horizontal}
\end{DoxyParamCaption}
)}\label{group__Box_ga447f790a64a49b477019938dc3d5c3ff}


Set the horizontal orientation. 

By default, box object arranges their contents vertically from top to bottom. By calling this function with {\ttfamily horizontal} as {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, the box will become horizontal, arranging contents from left to right.

\begin{DoxyNote}{Note}
This flag is ignored if a custom layout function is set.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & The horizontal flag ({\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} = horizontal, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} = vertical) \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set().

\index{Box@{Box}!elm\+\_\+box\+\_\+layout\+\_\+set@{elm\+\_\+box\+\_\+layout\+\_\+set}}
\index{elm\+\_\+box\+\_\+layout\+\_\+set@{elm\+\_\+box\+\_\+layout\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+layout\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+layout\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout}]{cb, }
\item[{const void $\ast$}]{data, }
\item[{Ecore\+\_\+\+Cb}]{free\+\_\+data}
\end{DoxyParamCaption}
)}\label{group__Box_gafb8732b243d82835f93a8ab0cef2eae5}


Set the layout defining function to be used by the box. 

Whenever anything changes that requires the box in {\ttfamily obj} to recalculate the size and position of its elements, the function {\ttfamily cb} will be called to determine what the layout of the children will be.

Once a custom function is set, everything about the children layout is defined by it. The flags set by \hyperlink{group__Box_ga447f790a64a49b477019938dc3d5c3ff}{elm\+\_\+box\+\_\+horizontal\+\_\+set()} and \hyperlink{group__Box_gad16ee458b6ab6aa4815b79819602ff6a}{elm\+\_\+box\+\_\+homogeneous\+\_\+set()} no longer have any meaning, and the values given by \hyperlink{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}{elm\+\_\+box\+\_\+padding\+\_\+set()} and \hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set()} are up to this layout function to decide if they are used and how. These last two will be found in the {\ttfamily priv} parameter, of type {\ttfamily Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Data}, passed to {\ttfamily cb}. The {\ttfamily Evas\+\_\+\+Object} the function receives is not the Elementary widget, but the internal Evas Box it uses, so none of the functions described here can be used on it.

Any of the layout functions in {\ttfamily Evas} can be used here, as well as the special \hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()}.

The final {\ttfamily data} argument received by {\ttfamily cb} is the same {\ttfamily data} passed here, and the {\ttfamily free\+\_\+data} function will be called to free it whenever the box is destroyed or another layout function is set.

Setting {\ttfamily cb} to N\+U\+L\+L will revert back to the default layout function.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em cb} & The callback function used for layout \\
\hline
\mbox{\tt in}  & {\em data} & Data that will be passed to layout function \\
\hline
\mbox{\tt in}  & {\em free\+\_\+data} & Function called to free {\ttfamily data} \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set().

\index{Box@{Box}!elm\+\_\+box\+\_\+layout\+\_\+transition@{elm\+\_\+box\+\_\+layout\+\_\+transition}}
\index{elm\+\_\+box\+\_\+layout\+\_\+transition@{elm\+\_\+box\+\_\+layout\+\_\+transition}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+layout\+\_\+transition}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+layout\+\_\+transition (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Data $\ast$}]{priv, }
\item[{void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Box_ga15194ef319ae722b03f608373f90fe1f}


Special layout function that animates the transition from one layout to another. 

Normally, when switching the layout function for a box, this will be reflected immediately on screen on the next render, but it\textquotesingle{}s also possible to do this through an animated transition.

This is done by creating an \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition} and setting the box layout to this function.

For example\+: 
\begin{DoxyCode}
1 Elm\_Box\_Transition *t = elm\_box\_transition\_new(1.0,
2                            evas\_object\_box\_layout\_vertical, // start
3                            NULL, // data for initial layout
4                            NULL, // free function for initial data
5                            evas\_object\_box\_layout\_horizontal, // end
6                            NULL, // data for final layout
7                            NULL, // free function for final data
8                            anim\_end, // will be called when animation ends
9                            NULL); // data for anim\_end function\(\backslash\)
10 elm\_box\_layout\_set(box, elm\_box\_layout\_transition, t,
11                    elm\_box\_transition\_free);
\end{DoxyCode}


\begin{DoxyNote}{Note}
This function can only be used with \hyperlink{group__Box_gafb8732b243d82835f93a8ab0cef2eae5}{elm\+\_\+box\+\_\+layout\+\_\+set()}. Calling it directly will not have the expected results.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new} 

\hyperlink{group__Box_gab7b726e4dbfb80da529431d198add95e}{elm\+\_\+box\+\_\+transition\+\_\+free} 

\hyperlink{group__Box_gafb8732b243d82835f93a8ab0cef2eae5}{elm\+\_\+box\+\_\+layout\+\_\+set} 
\end{DoxySeeAlso}
\index{Box@{Box}!elm\+\_\+box\+\_\+pack\+\_\+after@{elm\+\_\+box\+\_\+pack\+\_\+after}}
\index{elm\+\_\+box\+\_\+pack\+\_\+after@{elm\+\_\+box\+\_\+pack\+\_\+after}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+pack\+\_\+after}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+pack\+\_\+after (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object $\ast$}]{subobj, }
\item[{Evas\+\_\+\+Object $\ast$}]{after}
\end{DoxyParamCaption}
)}\label{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}


Adds an object to the box after the indicated object. 

This will add the {\ttfamily subobj} to the box indicated after the object indicated with {\ttfamily after}. If {\ttfamily after} is not already in the box, results are undefined. After means either to the right of the indicated object or below it depending on orientation.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start()} 

\hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end()} 

\hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\mbox{\tt in}  & {\em after} & The object after which to add it \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after().

\index{Box@{Box}!elm\+\_\+box\+\_\+pack\+\_\+before@{elm\+\_\+box\+\_\+pack\+\_\+before}}
\index{elm\+\_\+box\+\_\+pack\+\_\+before@{elm\+\_\+box\+\_\+pack\+\_\+before}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+pack\+\_\+before}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+pack\+\_\+before (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object $\ast$}]{subobj, }
\item[{Evas\+\_\+\+Object $\ast$}]{before}
\end{DoxyParamCaption}
)}\label{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}


Adds an object to the box before the indicated object. 

This will add the {\ttfamily subobj} to the box indicated before the object indicated with {\ttfamily before}. If {\ttfamily before} is not already in the box, results are undefined. Before means either to the left of the indicated object or above it depending on orientation.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start()} 

\hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end()} 

\hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\mbox{\tt in}  & {\em before} & The object before which to add it \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before().

\index{Box@{Box}!elm\+\_\+box\+\_\+pack\+\_\+end@{elm\+\_\+box\+\_\+pack\+\_\+end}}
\index{elm\+\_\+box\+\_\+pack\+\_\+end@{elm\+\_\+box\+\_\+pack\+\_\+end}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+pack\+\_\+end}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+pack\+\_\+end (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object $\ast$}]{subobj}
\end{DoxyParamCaption}
)}\label{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}


Add an object at the end of the pack list. 

Pack {\ttfamily subobj} into the box {\ttfamily obj}, placing it last in the list of children objects. The actual position the object will get on screen depends on the layout used. If no custom layout is set, it will be at the bottom or right, depending if the box is vertical or horizontal, respectively.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start()} 

\hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before()} 

\hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end().



Referenced by elm\+\_\+map\+\_\+overlay\+\_\+bubble\+\_\+content\+\_\+append().

\index{Box@{Box}!elm\+\_\+box\+\_\+pack\+\_\+start@{elm\+\_\+box\+\_\+pack\+\_\+start}}
\index{elm\+\_\+box\+\_\+pack\+\_\+start@{elm\+\_\+box\+\_\+pack\+\_\+start}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+pack\+\_\+start}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+pack\+\_\+start (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object $\ast$}]{subobj}
\end{DoxyParamCaption}
)}\label{group__Box_ga65b436728d0d895ef605618c4fb16e24}


Add an object to the beginning of the pack list. 

Pack {\ttfamily subobj} into the box {\ttfamily obj}, placing it first in the list of children objects. The actual position the object will get on screen depends on the layout used. If no custom layout is set, it will be at the top or left, depending if the box is vertical or horizontal, respectively.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end()} 

\hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before()} 

\hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start().

\index{Box@{Box}!elm\+\_\+box\+\_\+padding\+\_\+get@{elm\+\_\+box\+\_\+padding\+\_\+get}}
\index{elm\+\_\+box\+\_\+padding\+\_\+get@{elm\+\_\+box\+\_\+padding\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+padding\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+padding\+\_\+get (
\begin{DoxyParamCaption}
\item[{const Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Coord $\ast$}]{horizontal, }
\item[{Evas\+\_\+\+Coord $\ast$}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_ga1b8dbe3d8203a0b9c17d072be799ab5c}


Get the space (padding) between the box\textquotesingle{}s elements. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}{elm\+\_\+box\+\_\+padding\+\_\+set()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em horizontal} & The horizontal space between elements \\
\hline
\mbox{\tt out}  & {\em vertical} & The vertical space between elements \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get().

\index{Box@{Box}!elm\+\_\+box\+\_\+padding\+\_\+set@{elm\+\_\+box\+\_\+padding\+\_\+set}}
\index{elm\+\_\+box\+\_\+padding\+\_\+set@{elm\+\_\+box\+\_\+padding\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+padding\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+padding\+\_\+set (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Coord}]{horizontal, }
\item[{Evas\+\_\+\+Coord}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}


Set the space (padding) between the box\textquotesingle{}s elements. 

Extra space in pixels that will be added between a box child and its neighbors after its containing cell has been calculated. This padding is set for all elements in the box, besides any possible padding that individual elements may have through their size hints.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & The horizontal space between elements \\
\hline
\mbox{\tt in}  & {\em vertical} & The vertical space between elements \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set().

\index{Box@{Box}!elm\+\_\+box\+\_\+recalculate@{elm\+\_\+box\+\_\+recalculate}}
\index{elm\+\_\+box\+\_\+recalculate@{elm\+\_\+box\+\_\+recalculate}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+recalculate}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+recalculate (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Box_gab90fadde9fa440fa6d4d38dd7b4a92c1}


Force the box to recalculate its children packing. 

If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration. While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so. 

References elm\+\_\+obj\+\_\+box\+\_\+recalculate().

\index{Box@{Box}!elm\+\_\+box\+\_\+transition\+\_\+free@{elm\+\_\+box\+\_\+transition\+\_\+free}}
\index{elm\+\_\+box\+\_\+transition\+\_\+free@{elm\+\_\+box\+\_\+transition\+\_\+free}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+transition\+\_\+free}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+transition\+\_\+free (
\begin{DoxyParamCaption}
\item[{void $\ast$}]{data}
\end{DoxyParamCaption}
)}\label{group__Box_gab7b726e4dbfb80da529431d198add95e}


Free a Elm\+\_\+\+Box\+\_\+\+Transition instance created with \hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new()}. 

This function is mostly useful as the {\ttfamily free\+\_\+data} parameter in \hyperlink{group__Box_gafb8732b243d82835f93a8ab0cef2eae5}{elm\+\_\+box\+\_\+layout\+\_\+set()} when \hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()}.


\begin{DoxyParams}{Parameters}
{\em data} & The Elm\+\_\+\+Box\+\_\+\+Transition instance to be freed.\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new} 

\hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition} 
\end{DoxySeeAlso}
\index{Box@{Box}!elm\+\_\+box\+\_\+transition\+\_\+new@{elm\+\_\+box\+\_\+transition\+\_\+new}}
\index{elm\+\_\+box\+\_\+transition\+\_\+new@{elm\+\_\+box\+\_\+transition\+\_\+new}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+transition\+\_\+new}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\+\_\+\+Box\+\_\+\+Transition}$\ast$ elm\+\_\+box\+\_\+transition\+\_\+new (
\begin{DoxyParamCaption}
\item[{const double}]{duration, }
\item[{Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout}]{start\+\_\+layout, }
\item[{void $\ast$}]{start\+\_\+layout\+\_\+data, }
\item[{Ecore\+\_\+\+Cb}]{start\+\_\+layout\+\_\+free\+\_\+data, }
\item[{Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout}]{end\+\_\+layout, }
\item[{void $\ast$}]{end\+\_\+layout\+\_\+data, }
\item[{Ecore\+\_\+\+Cb}]{end\+\_\+layout\+\_\+free\+\_\+data, }
\item[{Ecore\+\_\+\+Cb}]{transition\+\_\+end\+\_\+cb, }
\item[{void $\ast$}]{transition\+\_\+end\+\_\+data}
\end{DoxyParamCaption}
)}\label{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}


Create a new \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition} to animate the switch of layouts. 

If you want to animate the change from one layout to another, you need to set the layout function of the box to \hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()}, passing as user data to it an instance of \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition} with the necessary information to perform this animation. The free function to set for the layout is \hyperlink{group__Box_gab7b726e4dbfb80da529431d198add95e}{elm\+\_\+box\+\_\+transition\+\_\+free()}.

The parameters to create an \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition} sum up to how long will it be, in seconds, a layout function to describe the initial point, another for the final position of the children and one function to be called when the whole animation ends. This last function is useful to set the definitive layout for the box, usually the same as the end layout for the animation, but could be used to start another transition.


\begin{DoxyParams}{Parameters}
{\em duration} & The duration of the transition in seconds \\
\hline
{\em start\+\_\+layout} & The layout function that will be used to start the animation \\
\hline
{\em start\+\_\+layout\+\_\+data} & The data to be passed the {\ttfamily start\+\_\+layout} function \\
\hline
{\em start\+\_\+layout\+\_\+free\+\_\+data} & Function to free {\ttfamily start\+\_\+layout\+\_\+data} \\
\hline
{\em end\+\_\+layout} & The layout function that will be used to end the animation \\
\hline
{\em end\+\_\+layout\+\_\+data} & Data param passed to {\ttfamily end\+\_\+layout} \\
\hline
{\em end\+\_\+layout\+\_\+free\+\_\+data} & The data to be passed the {\ttfamily end\+\_\+layout} function \\
\hline
{\em end\+\_\+layout\+\_\+free\+\_\+data} & Function to free {\ttfamily end\+\_\+layout\+\_\+data} \\
\hline
{\em transition\+\_\+end\+\_\+cb} & Callback function called when animation ends \\
\hline
{\em transition\+\_\+end\+\_\+data} & Data to be passed to {\ttfamily transition\+\_\+end\+\_\+cb} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
An instance of \hyperlink{group__Box_ga9cd35aa22988c800aa981f25ada92ced}{Elm\+\_\+\+Box\+\_\+\+Transition}
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga4a70cd7719f20a6d60e4abdf57eeca4e}{elm\+\_\+box\+\_\+transition\+\_\+new} 

\hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition} 
\end{DoxySeeAlso}
\index{Box@{Box}!elm\+\_\+box\+\_\+unpack@{elm\+\_\+box\+\_\+unpack}}
\index{elm\+\_\+box\+\_\+unpack@{elm\+\_\+box\+\_\+unpack}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+unpack}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+unpack (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj, }
\item[{Evas\+\_\+\+Object $\ast$}]{subobj}
\end{DoxyParamCaption}
)}\label{group__Box_ga1628b19006a68e13994a0b82c41f50ae}


Unpack a box item. 

Remove the object given by {\ttfamily subobj} from the box {\ttfamily obj} without deleting it.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to unpack \\
\hline
\end{DoxyParams}


References elm\+\_\+obj\+\_\+box\+\_\+unpack().

\index{Box@{Box}!elm\+\_\+box\+\_\+unpack\+\_\+all@{elm\+\_\+box\+\_\+unpack\+\_\+all}}
\index{elm\+\_\+box\+\_\+unpack\+\_\+all@{elm\+\_\+box\+\_\+unpack\+\_\+all}!Box@{Box}}
\subsubsection[{elm\+\_\+box\+\_\+unpack\+\_\+all}]{\setlength{\rightskip}{0pt plus 5cm}void elm\+\_\+box\+\_\+unpack\+\_\+all (
\begin{DoxyParamCaption}
\item[{Elm\+\_\+\+Box $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Box_ga30a6f9335153c8665e40e0012bf74628}


Remove all items from the box, without deleting them. 

Clear the box from all children, but don\textquotesingle{}t delete the respective objects. If no other references of the box children exist, the objects will never be deleted, and thus the application will leak the memory. Make sure when using this function that you hold a reference to all the objects in the box {\ttfamily obj}.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 
\end{DoxySeeAlso}


References elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get}}
\index{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+get (
\begin{DoxyParamCaption}
\item[{double $\ast$}]{horizontal, }
\item[{double $\ast$}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_ga3bec6164b4c6c7a483a8e33dc5e27103}


Get the alignment of the whole bounding box of contents. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em horizontal} & The horizontal alignment of elements \\
\hline
\mbox{\tt out}  & {\em vertical} & The vertical alignment of elements \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+align\+\_\+get().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set}}
\index{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+align\+\_\+set (
\begin{DoxyParamCaption}
\item[{double}]{horizontal, }
\item[{double}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_ga484d4e8bc3d4739b5e82794689a6d990}


Set the alignment of the whole bounding box of contents. 

Sets how the bounding box containing all the elements of the box, after their sizes and position has been calculated, will be aligned within the space given for the whole box widget.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & The horizontal alignment of elements \\
\hline
\mbox{\tt in}  & {\em vertical} & The vertical alignment of elements \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+align\+\_\+set().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get}}
\index{elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+List$\ast$ elm\+\_\+obj\+\_\+box\+\_\+children\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Box_ga13a2d41f59bc543c6a2a8df3d0d6f8b6}


Get a list of the objects packed into the box. 

Returns a new {\ttfamily list} with a pointer to {\ttfamily Evas\+\_\+\+Object} in its nodes. The order of the list corresponds to the packing order the box uses.

You must free this list with eina\+\_\+list\+\_\+free() once you are done with it. 

Referenced by elm\+\_\+box\+\_\+children\+\_\+get().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+clear@{elm\+\_\+obj\+\_\+box\+\_\+clear}}
\index{elm\+\_\+obj\+\_\+box\+\_\+clear@{elm\+\_\+obj\+\_\+box\+\_\+clear}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+clear}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+clear (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Box_ga31e0d2d68893860666e54d7173ea213f}


Clear the box of all children. 

Remove all the elements contained by the box, deleting the respective objects.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 
\end{DoxySeeAlso}


Referenced by elm\+\_\+box\+\_\+clear().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get}}
\index{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Box_ga79a2f10858792b922c275a3d5468d394}


Get whether the box is using homogeneous mode or not. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if it\textquotesingle{}s homogeneous, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise 
\end{DoxyReturn}


Referenced by elm\+\_\+box\+\_\+homogeneous\+\_\+get().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set}}
\index{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+homogeneous\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{homogeneous}
\end{DoxyParamCaption}
)}\label{group__Box_ga14095878ba67db427313cf669e10f942}


Set the box to arrange its children homogeneously. 

If enabled, homogeneous layout makes all items the same size, according to the size of the largest of its children.

\begin{DoxyNote}{Note}
This flag is ignored if a custom layout function is set.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em homogeneous} & The homogeneous flag \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+homogeneous\+\_\+set().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get}}
\index{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I Eina\+\_\+\+Bool elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+get (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Box_ga865a8ac3b41e422e9b859eba9ee3b66a}


Get the horizontal orientation. 

\begin{DoxyReturn}{Returns}
{\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} if the box is set to horizontal mode, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} otherwise 
\end{DoxyReturn}


Referenced by elm\+\_\+box\+\_\+horizontal\+\_\+get().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set}}
\index{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+horizontal\+\_\+set (
\begin{DoxyParamCaption}
\item[{Eina\+\_\+\+Bool}]{horizontal}
\end{DoxyParamCaption}
)}\label{group__Box_gade6ada6e03d44a2c7b23a82f4b1ce1bc}


Set the horizontal orientation. 

By default, box object arranges their contents vertically from top to bottom. By calling this function with {\ttfamily horizontal} as {\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E}, the box will become horizontal, arranging contents from left to right.

\begin{DoxyNote}{Note}
This flag is ignored if a custom layout function is set.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & The horizontal flag ({\ttfamily E\+I\+N\+A\+\_\+\+T\+R\+U\+E} = horizontal, {\ttfamily E\+I\+N\+A\+\_\+\+F\+A\+L\+S\+E} = vertical) \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+horizontal\+\_\+set().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set}}
\index{elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+layout\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Layout}]{cb, }
\item[{const void $\ast$}]{data, }
\item[{Ecore\+\_\+\+Cb}]{free\+\_\+data}
\end{DoxyParamCaption}
)}\label{group__Box_ga249f004db8fcf47bc3fdc76bc8026ec5}


Set the layout defining function to be used by the box. 

Whenever anything changes that requires the box in {\ttfamily obj} to recalculate the size and position of its elements, the function {\ttfamily cb} will be called to determine what the layout of the children will be.

Once a custom function is set, everything about the children layout is defined by it. The flags set by \hyperlink{group__Box_ga447f790a64a49b477019938dc3d5c3ff}{elm\+\_\+box\+\_\+horizontal\+\_\+set()} and \hyperlink{group__Box_gad16ee458b6ab6aa4815b79819602ff6a}{elm\+\_\+box\+\_\+homogeneous\+\_\+set()} no longer have any meaning, and the values given by \hyperlink{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}{elm\+\_\+box\+\_\+padding\+\_\+set()} and \hyperlink{group__Box_gafc3cbc4e34321e6228579b062fb2802d}{elm\+\_\+box\+\_\+align\+\_\+set()} are up to this layout function to decide if they are used and how. These last two will be found in the {\ttfamily priv} parameter, of type {\ttfamily Evas\+\_\+\+Object\+\_\+\+Box\+\_\+\+Data}, passed to {\ttfamily cb}. The {\ttfamily Evas\+\_\+\+Object} the function receives is not the Elementary widget, but the internal Evas Box it uses, so none of the functions described here can be used on it.

Any of the layout functions in {\ttfamily Evas} can be used here, as well as the special \hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()}.

The final {\ttfamily data} argument received by {\ttfamily cb} is the same {\ttfamily data} passed here, and the {\ttfamily free\+\_\+data} function will be called to free it whenever the box is destroyed or another layout function is set.

Setting {\ttfamily cb} to N\+U\+L\+L will revert back to the default layout function.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga15194ef319ae722b03f608373f90fe1f}{elm\+\_\+box\+\_\+layout\+\_\+transition()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em cb} & The callback function used for layout \\
\hline
\mbox{\tt in}  & {\em data} & Data that will be passed to layout function \\
\hline
\mbox{\tt in}  & {\em free\+\_\+data} & Function called to free {\ttfamily data} \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+layout\+\_\+set().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after}}
\index{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+after (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{subobj, }
\item[{Evas\+\_\+\+Object $\ast$}]{after}
\end{DoxyParamCaption}
)}\label{group__Box_ga5783fb380fd4fb3996d8693797ae8af6}


Adds an object to the box after the indicated object. 

This will add the {\ttfamily subobj} to the box indicated after the object indicated with {\ttfamily after}. If {\ttfamily after} is not already in the box, results are undefined. After means either to the right of the indicated object or below it depending on orientation.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start()} 

\hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end()} 

\hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\mbox{\tt in}  & {\em after} & The object after which to add it \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+pack\+\_\+after().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before}}
\index{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+before (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{subobj, }
\item[{Evas\+\_\+\+Object $\ast$}]{before}
\end{DoxyParamCaption}
)}\label{group__Box_ga1921c76bdbc88d7662d7e1eae833385d}


Adds an object to the box before the indicated object. 

This will add the {\ttfamily subobj} to the box indicated before the object indicated with {\ttfamily before}. If {\ttfamily before} is not already in the box, results are undefined. Before means either to the left of the indicated object or above it depending on orientation.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start()} 

\hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end()} 

\hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\mbox{\tt in}  & {\em before} & The object before which to add it \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+pack\+\_\+before().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end}}
\index{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+end (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{subobj}
\end{DoxyParamCaption}
)}\label{group__Box_gaff20f849863272aa857708655d326838}


Add an object at the end of the pack list. 

Pack {\ttfamily subobj} into the box {\ttfamily obj}, placing it last in the list of children objects. The actual position the object will get on screen depends on the layout used. If no custom layout is set, it will be at the bottom or right, depending if the box is vertical or horizontal, respectively.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga65b436728d0d895ef605618c4fb16e24}{elm\+\_\+box\+\_\+pack\+\_\+start()} 

\hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before()} 

\hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+pack\+\_\+end().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start}}
\index{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start@{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+pack\+\_\+start (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{subobj}
\end{DoxyParamCaption}
)}\label{group__Box_gae36cfcf68ed007195c548137954c858d}


Add an object to the beginning of the pack list. 

Pack {\ttfamily subobj} into the box {\ttfamily obj}, placing it first in the list of children objects. The actual position the object will get on screen depends on the layout used. If no custom layout is set, it will be at the top or left, depending if the box is vertical or horizontal, respectively.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga53156bf1cf1cb90fb07a97172f72d0b6}{elm\+\_\+box\+\_\+pack\+\_\+end()} 

\hyperlink{group__Box_ga4ff13cddf970d1cb3dd599b3e561ec7f}{elm\+\_\+box\+\_\+pack\+\_\+before()} 

\hyperlink{group__Box_ga27f8d88d95878f2321a2b2c8676a791e}{elm\+\_\+box\+\_\+pack\+\_\+after()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 

\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to add to the box \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+pack\+\_\+start().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get}}
\index{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get@{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+get (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Coord $\ast$}]{horizontal, }
\item[{Evas\+\_\+\+Coord $\ast$}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_gaec34ab56d2b304bc017dbc7319a38614}


Get the space (padding) between the box\textquotesingle{}s elements. 

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga37d2adc1fd2a0fc4142f5532b5a57ad8}{elm\+\_\+box\+\_\+padding\+\_\+set()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em horizontal} & The horizontal space between elements \\
\hline
\mbox{\tt out}  & {\em vertical} & The vertical space between elements \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+padding\+\_\+get().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set}}
\index{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set@{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+padding\+\_\+set (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Coord}]{horizontal, }
\item[{Evas\+\_\+\+Coord}]{vertical}
\end{DoxyParamCaption}
)}\label{group__Box_ga0a5ab0e4826a38ccd581341bbd736bd5}


Set the space (padding) between the box\textquotesingle{}s elements. 

Extra space in pixels that will be added between a box child and its neighbors after its containing cell has been calculated. This padding is set for all elements in the box, besides any possible padding that individual elements may have through their size hints.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em horizontal} & The horizontal space between elements \\
\hline
\mbox{\tt in}  & {\em vertical} & The vertical space between elements \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+padding\+\_\+set().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+recalculate@{elm\+\_\+obj\+\_\+box\+\_\+recalculate}}
\index{elm\+\_\+obj\+\_\+box\+\_\+recalculate@{elm\+\_\+obj\+\_\+box\+\_\+recalculate}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+recalculate}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+recalculate (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Box_ga8cb5b13b78f2f2d9b0d8872e9c362c9e}


Force the box to recalculate its children packing. 

If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration. While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so. 

Referenced by elm\+\_\+box\+\_\+recalculate().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+unpack@{elm\+\_\+obj\+\_\+box\+\_\+unpack}}
\index{elm\+\_\+obj\+\_\+box\+\_\+unpack@{elm\+\_\+obj\+\_\+box\+\_\+unpack}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+unpack}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+unpack (
\begin{DoxyParamCaption}
\item[{Evas\+\_\+\+Object $\ast$}]{subobj}
\end{DoxyParamCaption}
)}\label{group__Box_gab6f479bf81638fef69c7ddc62bcd6a02}


Unpack a box item. 

Remove the object given by {\ttfamily subobj} from the box {\ttfamily obj} without deleting it.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga30a6f9335153c8665e40e0012bf74628}{elm\+\_\+box\+\_\+unpack\+\_\+all()} 

\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()}
\end{DoxySeeAlso}

\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em subobj} & The object to unpack \\
\hline
\end{DoxyParams}


Referenced by elm\+\_\+box\+\_\+unpack().

\index{Box@{Box}!elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all@{elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all}}
\index{elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all@{elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all}!Box@{Box}}
\subsubsection[{elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all}]{\setlength{\rightskip}{0pt plus 5cm}E\+O\+A\+P\+I void elm\+\_\+obj\+\_\+box\+\_\+unpack\+\_\+all (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}\label{group__Box_ga8ca796fd2cee6871408c2b7a6ef7c422}


Remove all items from the box, without deleting them. 

Clear the box from all children, but don\textquotesingle{}t delete the respective objects. If no other references of the box children exist, the objects will never be deleted, and thus the application will leak the memory. Make sure when using this function that you hold a reference to all the objects in the box {\ttfamily obj}.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__Box_ga4616b670f386ab6ddfddce9433c62c08}{elm\+\_\+box\+\_\+clear()} 

\hyperlink{group__Box_ga1628b19006a68e13994a0b82c41f50ae}{elm\+\_\+box\+\_\+unpack()} 
\end{DoxySeeAlso}


Referenced by elm\+\_\+box\+\_\+unpack\+\_\+all().

