\section{Background}
\label{group__Bg}\index{Background@{Background}}


Background object, used for setting a solid color, image or Edje group as a background to a window or any container object.  


\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__Bg_ga3920de9df08cd4d8b2e19b1d914cebc4}{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set}(file, group, ret)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-F\-I\-L\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$, file), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$, group), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)
\item 
\#define \hyperlink{group__Bg_gad0908ac27d70cd3e4a2318f681f9d445}{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get}(file, group)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-F\-I\-L\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$$\ast$, file), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$$\ast$, group)
\item 
\#define \hyperlink{group__Bg_gaa7d75a1ca9eb3f57331ada4f04e4903f}{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set}(option)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(\hyperlink{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\-\_\-\-Bg\-\_\-\-Option}, option)
\item 
\#define \hyperlink{group__Bg_gab62fe44b567139ca92a19ace865931e5}{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get}(ret)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(\hyperlink{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\-\_\-\-Bg\-\_\-\-Option} $\ast$, ret)
\item 
\#define \hyperlink{group__Bg_ga85e32b439432481621efb0b67a6c4af1}{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set}(r, g, b, a)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-O\-R\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, r), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, g), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, b), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, a)
\item 
\#define \hyperlink{group__Bg_gaba418fc3831fe81a84f4cabf77c5913f}{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get}(r, g, b, a)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-O\-R\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, r), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, g), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, b), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, a)
\item 
\#define \hyperlink{group__Bg_gac5887a54e4d1a9fd9ae914cbb3d16bdd}{elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}(w, h)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-L\-O\-A\-D\-\_\-\-S\-I\-Z\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Evas\-\_\-\-Coord, w), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Evas\-\_\-\-Coord, h)
\end{DoxyCompactItemize}
\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\-\_\-\-Bg\-\_\-\-Option} \{ \\*
\hyperlink{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-C\-E\-N\-T\-E\-R}, 
\\*
\hyperlink{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-C\-A\-L\-E}, 
\\*
\hyperlink{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-T\-R\-E\-T\-C\-H}, 
\\*
\hyperlink{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-T\-I\-L\-E}, 
\\*
\hyperlink{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T}
 \}
\begin{DoxyCompactList}\small\item\em Identifiers on how a background widget is to display its image -- if it was set to use an image file. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
Evas\-\_\-\-Object $\ast$ \hyperlink{group__Bg_gaeec8f79ac62ce0cf607cfe330008a63f}{elm\-\_\-bg\-\_\-add} (Evas\-\_\-\-Object $\ast$parent)
\begin{DoxyCompactList}\small\item\em Add a new background to the parent. \end{DoxyCompactList}\item 
Eina\-\_\-\-Bool \hyperlink{group__Bg_ga621b8c0af0faa3abe3832304e880874e}{elm\-\_\-bg\-\_\-file\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, const char $\ast$file, const char $\ast$group)
\begin{DoxyCompactList}\small\item\em Set the file (image or edje collection) to give life for the background. \end{DoxyCompactList}\item 
void \hyperlink{group__Bg_ga784f8ec44813fb13460e8e2b7f5a4c65}{elm\-\_\-bg\-\_\-file\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj, const char $\ast$$\ast$file, const char $\ast$$\ast$group)
\begin{DoxyCompactList}\small\item\em Get the file (image or edje collection) set on a given background widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Bg_ga2ed059b3cf946d10a12182fedc3125f9}{elm\-\_\-bg\-\_\-option\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, \hyperlink{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\-\_\-\-Bg\-\_\-\-Option} option)
\begin{DoxyCompactList}\small\item\em Set the mode of display for a given background widget's image. \end{DoxyCompactList}\item 
\hyperlink{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\-\_\-\-Bg\-\_\-\-Option} \hyperlink{group__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}{elm\-\_\-bg\-\_\-option\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the mode of display for a given background widget's image. \end{DoxyCompactList}\item 
void \hyperlink{group__Bg_ga9431af239574a212be6988d618be5ae8}{elm\-\_\-bg\-\_\-color\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, int r, int g, int b)
\begin{DoxyCompactList}\small\item\em Set the color on a given background widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\-\_\-bg\-\_\-color\-\_\-get} (const Evas\-\_\-\-Object $\ast$obj, int $\ast$r, int $\ast$g, int $\ast$b)
\begin{DoxyCompactList}\small\item\em Get the color set on a given background widget. \end{DoxyCompactList}\item 
void \hyperlink{group__Bg_ga018a212362dea29a77aa1e7c3ee7ef5c}{elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set} (Evas\-\_\-\-Object $\ast$obj, Evas\-\_\-\-Coord w, Evas\-\_\-\-Coord h)
\begin{DoxyCompactList}\small\item\em Set the size of the pixmap representation of the image set on a given background widget. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Background object, used for setting a solid color, image or Edje group as a background to a window or any container object.  
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics{bg_inheritance_tree}}
\end{DoxyImageNoCaption}


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


The bg (background) widget is used for setting (solid) background decorations to a window (unless it has transparency enabled) or to any container object. It works just like an image, but has some properties useful to a background, like setting it to tiled, centered, scaled or stretched.

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

Default content parts of the bg widget that you can use for are\-: \begin{DoxyItemize}
\item {\ttfamily \char`\"{}overlay\char`\"{}} -\/ overlay of the bg\end{DoxyItemize}
Here is some sample code using it\-: \begin{DoxyItemize}
\item \hyperlink{bg_01_example_page}{elm\-\_\-bg -\/ Plain color background.} \item \hyperlink{bg_02_example_page}{elm\-\_\-bg -\/ Image background.} \item \hyperlink{bg_03_example_page}{elm\-\_\-bg -\/ Background properties.} \end{DoxyItemize}


\subsection{Macro Definition Documentation}
\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get@{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get@{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get(
\begin{DoxyParamCaption}
\item[{}]{r, }
\item[{}]{g, }
\item[{}]{b, }
\item[{}]{a}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-O\-R\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, r), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, g), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, b), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int $\ast$, a)}\label{group__Bg_gaba418fc3831fe81a84f4cabf77c5913f}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Get the color set on a given background widget


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em r} & \\
\hline
\mbox{\tt out}  & {\em g} & \\
\hline
\mbox{\tt out}  & {\em b} & \\
\hline
\mbox{\tt out}  & {\em a} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\-\_\-bg\-\_\-color\-\_\-get} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-bg\-\_\-color\-\_\-get().

\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set(
\begin{DoxyParamCaption}
\item[{}]{r, }
\item[{}]{g, }
\item[{}]{b, }
\item[{}]{a}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-C\-O\-L\-O\-R\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, r), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, g), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, b), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(int, a)}\label{group__Bg_ga85e32b439432481621efb0b67a6c4af1}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Set the color on a given background widget


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em r} & \\
\hline
\mbox{\tt in}  & {\em g} & \\
\hline
\mbox{\tt in}  & {\em b} & \\
\hline
\mbox{\tt in}  & {\em a} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga9431af239574a212be6988d618be5ae8}{elm\-\_\-bg\-\_\-color\-\_\-set} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-bg\-\_\-color\-\_\-set().

\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get@{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get@{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get(
\begin{DoxyParamCaption}
\item[{}]{file, }
\item[{}]{group}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-F\-I\-L\-E\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$$\ast$, file), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$$\ast$, group)}\label{group__Bg_gad0908ac27d70cd3e4a2318f681f9d445}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Get the file (image or edje collection) set on a given background


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em file} & \\
\hline
\mbox{\tt out}  & {\em group} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga784f8ec44813fb13460e8e2b7f5a4c65}{elm\-\_\-bg\-\_\-file\-\_\-get} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-bg\-\_\-file\-\_\-get().

\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set(
\begin{DoxyParamCaption}
\item[{}]{file, }
\item[{}]{group, }
\item[{}]{ret}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-F\-I\-L\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$, file), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(const char $\ast$, group), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Eina\-\_\-\-Bool $\ast$, ret)}\label{group__Bg_ga3920de9df08cd4d8b2e19b1d914cebc4}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Set the file (image or edje collection) to give life for the background


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em file} & \\
\hline
\mbox{\tt in}  & {\em group} & \\
\hline
\mbox{\tt out}  & {\em ret} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga621b8c0af0faa3abe3832304e880874e}{elm\-\_\-bg\-\_\-file\-\_\-set} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-bg\-\_\-file\-\_\-set().

\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set(
\begin{DoxyParamCaption}
\item[{}]{w, }
\item[{}]{h}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-L\-O\-A\-D\-\_\-\-S\-I\-Z\-E\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Evas\-\_\-\-Coord, w), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K(Evas\-\_\-\-Coord, h)}\label{group__Bg_gac5887a54e4d1a9fd9ae914cbb3d16bdd}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Set the size of the pixmap representation of the image set on a given background widget.


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt in}  & {\em w} & \\
\hline
\mbox{\tt in}  & {\em h} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga018a212362dea29a77aa1e7c3ee7ef5c}{elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set().

\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get@{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get@{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get(
\begin{DoxyParamCaption}
\item[{}]{ret}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-G\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K({\bf Elm\-\_\-\-Bg\-\_\-\-Option} $\ast$, ret)}\label{group__Bg_gab62fe44b567139ca92a19ace865931e5}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Get the mode of display for a given background widget's image


\begin{DoxyParams}[1]{Parameters}
\mbox{\tt out}  & {\em ret} & \\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}{elm\-\_\-bg\-\_\-option\-\_\-get} 
\end{DoxySeeAlso}


Referenced by elm\-\_\-bg\-\_\-option\-\_\-get().

\index{Background@{Background}!elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set}}
\index{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set@{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}\#define elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set(
\begin{DoxyParamCaption}
\item[{}]{option}
\end{DoxyParamCaption}
)~E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-I\-D(E\-L\-M\-\_\-\-O\-B\-J\-\_\-\-B\-G\-\_\-\-S\-U\-B\-\_\-\-I\-D\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-E\-T), E\-O\-\_\-\-T\-Y\-P\-E\-C\-H\-E\-C\-K({\bf Elm\-\_\-\-Bg\-\_\-\-Option}, option)}\label{group__Bg_gaa7d75a1ca9eb3f57331ada4f04e4903f}
\begin{DoxySince}{Since}
1.\-8
\end{DoxySince}
Set the mode of display for a given background widget's image


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


Referenced by elm\-\_\-bg\-\_\-option\-\_\-set().



\subsection{Enumeration Type Documentation}
\index{Background@{Background}!Elm\-\_\-\-Bg\-\_\-\-Option@{Elm\-\_\-\-Bg\-\_\-\-Option}}
\index{Elm\-\_\-\-Bg\-\_\-\-Option@{Elm\-\_\-\-Bg\-\_\-\-Option}!Background@{Background}}
\subsubsection[{Elm\-\_\-\-Bg\-\_\-\-Option}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Elm\-\_\-\-Bg\-\_\-\-Option}}\label{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}


Identifiers on how a background widget is to display its image -- if it was set to use an image file. 

\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga2ed059b3cf946d10a12182fedc3125f9}{elm\-\_\-bg\-\_\-option\-\_\-set()} 

\hyperlink{group__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}{elm\-\_\-bg\-\_\-option\-\_\-get()} 
\end{DoxySeeAlso}
\begin{Desc}
\item[Enumerator]\par
\begin{description}
\index{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-C\-E\-N\-T\-E\-R@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-C\-E\-N\-T\-E\-R}!Background@{Background}}\index{Background@{Background}!E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-C\-E\-N\-T\-E\-R@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-C\-E\-N\-T\-E\-R}}\item[{\em 
E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-C\-E\-N\-T\-E\-R\label{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}
}]center the background image \index{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-C\-A\-L\-E@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-C\-A\-L\-E}!Background@{Background}}\index{Background@{Background}!E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-C\-A\-L\-E@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-C\-A\-L\-E}}\item[{\em 
E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-C\-A\-L\-E\label{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}
}]scale the background image, retaining aspect ratio \index{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-T\-R\-E\-T\-C\-H@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-T\-R\-E\-T\-C\-H}!Background@{Background}}\index{Background@{Background}!E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-T\-R\-E\-T\-C\-H@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-T\-R\-E\-T\-C\-H}}\item[{\em 
E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-S\-T\-R\-E\-T\-C\-H\label{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}
}]stretch the background image to fill the widget's area \index{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-T\-I\-L\-E@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-T\-I\-L\-E}!Background@{Background}}\index{Background@{Background}!E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-T\-I\-L\-E@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-T\-I\-L\-E}}\item[{\em 
E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-T\-I\-L\-E\label{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}
}]tile background image at its original size \index{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T}!Background@{Background}}\index{Background@{Background}!E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T@{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T}}\item[{\em 
E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T\label{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}
}]sentinel value, also used to indicate errors \end{description}
\end{Desc}


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


Add a new background to the parent. 


\begin{DoxyParams}{Parameters}
{\em parent} & The parent object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The new object or {\ttfamily N\-U\-L\-L} if it cannot be created 
\end{DoxyReturn}


Referenced by elm\-\_\-quicklaunch\-\_\-seed(), and elm\-\_\-win\-\_\-util\-\_\-standard\-\_\-add().

\index{Background@{Background}!elm\-\_\-bg\-\_\-color\-\_\-get@{elm\-\_\-bg\-\_\-color\-\_\-get}}
\index{elm\-\_\-bg\-\_\-color\-\_\-get@{elm\-\_\-bg\-\_\-color\-\_\-get}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-color\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-bg\-\_\-color\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{int $\ast$}]{r, }
\item[{int $\ast$}]{g, }
\item[{int $\ast$}]{b}
\end{DoxyParamCaption}
)}\label{group__Bg_ga7ebcf30b15b9610380101a26b240b711}


Get the color set on a given background widget. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
{\em r} & Where to store the red color component's value \\
\hline
{\em g} & Where to store the green color component's value \\
\hline
{\em b} & Where to store the blue color component's value\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Use {\ttfamily N\-U\-L\-L} pointers on the file components you're not interested in\-: they'll be ignored by the function.
\end{DoxyNote}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\-\_\-bg\-\_\-color\-\_\-get()} for more details 
\end{DoxySeeAlso}


References elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-get.

\index{Background@{Background}!elm\-\_\-bg\-\_\-color\-\_\-set@{elm\-\_\-bg\-\_\-color\-\_\-set}}
\index{elm\-\_\-bg\-\_\-color\-\_\-set@{elm\-\_\-bg\-\_\-color\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-color\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-bg\-\_\-color\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{int}]{r, }
\item[{int}]{g, }
\item[{int}]{b}
\end{DoxyParamCaption}
)}\label{group__Bg_ga9431af239574a212be6988d618be5ae8}


Set the color on a given background widget. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
{\em r} & The red color component's value \\
\hline
{\em g} & The green color component's value \\
\hline
{\em b} & The blue color component's value\\
\hline
\end{DoxyParams}
This sets the color used for the background rectangle, in R\-G\-B format. Each color component's range is from 0 to 255.

\begin{DoxyNote}{Note}
You probably only want to use this function if you haven't previously called \hyperlink{group__Bg_ga621b8c0af0faa3abe3832304e880874e}{elm\-\_\-bg\-\_\-file\-\_\-set()}, so that you just want a solid color background.

You can reset the color by setting , , {\bfseries as} -\/1, -\/1, -\/1.
\end{DoxyNote}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\-\_\-bg\-\_\-color\-\_\-get()} 
\end{DoxySeeAlso}


References elm\-\_\-obj\-\_\-bg\-\_\-color\-\_\-set.

\index{Background@{Background}!elm\-\_\-bg\-\_\-file\-\_\-get@{elm\-\_\-bg\-\_\-file\-\_\-get}}
\index{elm\-\_\-bg\-\_\-file\-\_\-get@{elm\-\_\-bg\-\_\-file\-\_\-get}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-file\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-bg\-\_\-file\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{const char $\ast$$\ast$}]{file, }
\item[{const char $\ast$$\ast$}]{group}
\end{DoxyParamCaption}
)}\label{group__Bg_ga784f8ec44813fb13460e8e2b7f5a4c65}


Get the file (image or edje collection) set on a given background widget. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
{\em file} & Where to store the requested file's path \\
\hline
{\em group} & Where to store the optional key within {\itshape file}, {\bfseries if} it's an Edje file\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Use {\ttfamily N\-U\-L\-L} pointers on the file components you're not interested in\-: they'll be ignored by the function. 
\end{DoxyNote}


References elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-get.

\index{Background@{Background}!elm\-\_\-bg\-\_\-file\-\_\-set@{elm\-\_\-bg\-\_\-file\-\_\-set}}
\index{elm\-\_\-bg\-\_\-file\-\_\-set@{elm\-\_\-bg\-\_\-file\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-file\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}Eina\-\_\-\-Bool elm\-\_\-bg\-\_\-file\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{const char $\ast$}]{file, }
\item[{const char $\ast$}]{group}
\end{DoxyParamCaption}
)}\label{group__Bg_ga621b8c0af0faa3abe3832304e880874e}


Set the file (image or edje collection) to give life for the background. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
{\em file} & The file path \\
\hline
{\em group} & Optional key (group in Edje) within the file \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
{\ttfamily E\-I\-N\-A\-\_\-\-T\-R\-U\-E} on success, {\ttfamily E\-I\-N\-A\-\_\-\-F\-A\-L\-S\-E} otherwise
\end{DoxyReturn}
This sets the image file used in the background object. If the image comes from an Edje group, it will be stretched to completely fill the background object. If it comes from a traditional image file, it will by default be centered in this widget's are (thus retaining its aspect), what could lead to some parts being not visible. You may change the mode of exhibition for a real image file with \hyperlink{group__Bg_ga2ed059b3cf946d10a12182fedc3125f9}{elm\-\_\-bg\-\_\-option\-\_\-set()}.

\begin{DoxyNote}{Note}
Once the image of {\ttfamily obj} is set, a previously set one will be deleted, even if {\ttfamily file} is {\ttfamily N\-U\-L\-L}.

This will only affect the contents of one of the background's swallow spots, namely {\ttfamily \char`\"{}elm.\-swallow.\-background\char`\"{}}. If you want to achieve the {\ttfamily Layout's} file setting behavior, you'll have to call that method on this object. 
\end{DoxyNote}


References elm\-\_\-obj\-\_\-bg\-\_\-file\-\_\-set.

\index{Background@{Background}!elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set@{elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}}
\index{elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set@{elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-bg\-\_\-load\-\_\-size\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{Evas\-\_\-\-Coord}]{w, }
\item[{Evas\-\_\-\-Coord}]{h}
\end{DoxyParamCaption}
)}\label{group__Bg_ga018a212362dea29a77aa1e7c3ee7ef5c}


Set the size of the pixmap representation of the image set on a given background widget. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
{\em w} & The new width of the image pixmap representation. \\
\hline
{\em h} & The new height of the image pixmap representation.\\
\hline
\end{DoxyParams}
\begin{DoxyWarning}{Warning}
This function just makes sense if an image file was set on {\ttfamily obj}, with \hyperlink{group__Bg_ga621b8c0af0faa3abe3832304e880874e}{elm\-\_\-bg\-\_\-file\-\_\-set()}.
\end{DoxyWarning}
This function sets a new size for pixmap representation of the given bg image. It allows for the image to be loaded already in the specified size, reducing the memory usage and load time (for example, when loading a big image file with its load size set to a smaller size)

\begin{DoxyNote}{Note}
This is just a hint for the underlying system. The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested. 
\end{DoxyNote}


References elm\-\_\-obj\-\_\-bg\-\_\-load\-\_\-size\-\_\-set.

\index{Background@{Background}!elm\-\_\-bg\-\_\-option\-\_\-get@{elm\-\_\-bg\-\_\-option\-\_\-get}}
\index{elm\-\_\-bg\-\_\-option\-\_\-get@{elm\-\_\-bg\-\_\-option\-\_\-get}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-option\-\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Elm\-\_\-\-Bg\-\_\-\-Option} elm\-\_\-bg\-\_\-option\-\_\-get (
\begin{DoxyParamCaption}
\item[{const Evas\-\_\-\-Object $\ast$}]{obj}
\end{DoxyParamCaption}
)}\label{group__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}


Get the mode of display for a given background widget's image. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The image displaying mode in use for {\itshape obj} or \hyperlink{group__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}{E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T}, on errors.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga2ed059b3cf946d10a12182fedc3125f9}{elm\-\_\-bg\-\_\-option\-\_\-set()} for more details 
\end{DoxySeeAlso}


References E\-L\-M\-\_\-\-B\-G\-\_\-\-O\-P\-T\-I\-O\-N\-\_\-\-L\-A\-S\-T, and elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-get.

\index{Background@{Background}!elm\-\_\-bg\-\_\-option\-\_\-set@{elm\-\_\-bg\-\_\-option\-\_\-set}}
\index{elm\-\_\-bg\-\_\-option\-\_\-set@{elm\-\_\-bg\-\_\-option\-\_\-set}!Background@{Background}}
\subsubsection[{elm\-\_\-bg\-\_\-option\-\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void elm\-\_\-bg\-\_\-option\-\_\-set (
\begin{DoxyParamCaption}
\item[{Evas\-\_\-\-Object $\ast$}]{obj, }
\item[{{\bf Elm\-\_\-\-Bg\-\_\-\-Option}}]{option}
\end{DoxyParamCaption}
)}\label{group__Bg_ga2ed059b3cf946d10a12182fedc3125f9}


Set the mode of display for a given background widget's image. 


\begin{DoxyParams}{Parameters}
{\em obj} & The background object handle \\
\hline
{\em option} & The desired background option (see \hyperlink{group__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\-\_\-\-Bg\-\_\-\-Option})\\
\hline
\end{DoxyParams}
This sets how the background widget will display its image. This will only work if the \hyperlink{group__Bg_ga621b8c0af0faa3abe3832304e880874e}{elm\-\_\-bg\-\_\-file\-\_\-set()} was previously called with an image file on {\itshape obj}. The image can be display tiled, scaled, centered or stretched.

\begin{DoxySeeAlso}{See Also}
\hyperlink{group__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}{elm\-\_\-bg\-\_\-option\-\_\-get()} 
\end{DoxySeeAlso}


References elm\-\_\-obj\-\_\-bg\-\_\-option\-\_\-set.

