\hypertarget{group__Elm__Bg}{}\doxysection{Background}
\label{group__Elm__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.  


\doxysubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum \mbox{\hyperlink{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\+\_\+\+Bg\+\_\+\+Option}} \{ \newline
\mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+CENTER}} = 0
, \newline
\mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+SCALE}}
, \newline
\mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+STRETCH}}
, \newline
\mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+TILE}}
, \newline
\mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+LAST}}
 \}
\begin{DoxyCompactList}\small\item\em Identifiers on how a background widget is to display its image. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ \mbox{\hyperlink{group__Elm__Bg_gac8eba3fcce966addec75ab6335e60f6e}{elm\+\_\+bg\+\_\+add}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$parent)
\begin{DoxyCompactList}\small\item\em Adds a new background to the parent. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Bg_ga9431af239574a212be6988d618be5ae8}{elm\+\_\+bg\+\_\+color\+\_\+set}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, int r, int g, int b)
\begin{DoxyCompactList}\small\item\em Sets the color on a given background widget. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\+\_\+bg\+\_\+color\+\_\+get}} (const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, int $\ast$r, int $\ast$g, int $\ast$b)
\begin{DoxyCompactList}\small\item\em Gets the color set on a given background widget. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} \mbox{\hyperlink{group__Elm__Bg_ga0b11c11879de61126414adfbfe3e431c}{elm\+\_\+bg\+\_\+file\+\_\+set}} (Eo $\ast$obj, const char $\ast$file, const char $\ast$group)
\begin{DoxyCompactList}\small\item\em Sets the file (image or edje collection) to give life for the background. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Bg_gafd923c1eb9d78db9f4b50fcfec7c74ae}{elm\+\_\+bg\+\_\+file\+\_\+get}} (const Eo $\ast$obj, const char $\ast$$\ast$file, const char $\ast$$\ast$group)
\begin{DoxyCompactList}\small\item\em Gets the file (image or edje collection) set on a given background widget. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Bg_ga2ed059b3cf946d10a12182fedc3125f9}{elm\+\_\+bg\+\_\+option\+\_\+set}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, \mbox{\hyperlink{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\+\_\+\+Bg\+\_\+\+Option}} option)
\begin{DoxyCompactList}\small\item\em Sets the mode of display for a given background widget\textquotesingle{}s image. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\+\_\+\+Bg\+\_\+\+Option}} \mbox{\hyperlink{group__Elm__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}{elm\+\_\+bg\+\_\+option\+\_\+get}} (const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Gets the mode of display of a given background widget\textquotesingle{}s image. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{group__Elm__Bg_ga6aef5e17ed70d3391401f0395fda06e9}{elm\+\_\+bg\+\_\+load\+\_\+size\+\_\+set}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, int w, int h)
\begin{DoxyCompactList}\small\item\em Sets the size of the pixmap representation of the image set on a given background widget. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__Eina__Types__Group_gad5b2116495471db12a34bab9a34edfaa}{EINA\+\_\+\+DEPRECATED}} void \mbox{\hyperlink{group__Elm__Bg_ga626651023c23741909f641834db7e4b1}{elm\+\_\+bg\+\_\+overlay\+\_\+set}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj, \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$overlay)
\begin{DoxyCompactList}\small\item\em Set the overlay object used for the background object. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__Eina__Types__Group_gad5b2116495471db12a34bab9a34edfaa}{EINA\+\_\+\+DEPRECATED}} \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ \mbox{\hyperlink{group__Elm__Bg_gaae8cf8c797ab0a2099373a4c14645d50}{elm\+\_\+bg\+\_\+overlay\+\_\+get}} (const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the overlay object used for the background object. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group__Eina__Types__Group_gad5b2116495471db12a34bab9a34edfaa}{EINA\+\_\+\+DEPRECATED}} \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ \mbox{\hyperlink{group__Elm__Bg_ga4e732286eff313adcc180b00b404a072}{elm\+\_\+bg\+\_\+overlay\+\_\+unset}} (\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$obj)
\begin{DoxyCompactList}\small\item\em Get the overlay object used for the background object. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{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[width=\textwidth,height=\textheight/2,keepaspectratio=true]{bg_inheritance_tree}}
\end{DoxyImageNoCaption}


 
\begin{DoxyImageNoCaption}
  \mbox{\includegraphics[width=\textwidth,height=\textheight/2,keepaspectratio=true]{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 \mbox{\hyperlink{group__Elm__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 \mbox{\hyperlink{bg_01_example_page}{elm\+\_\+bg -\/ Plain color background.}} \item \mbox{\hyperlink{bg_02_example_page}{elm\+\_\+bg -\/ Image background.}} \item \mbox{\hyperlink{bg_03_example_page}{elm\+\_\+bg -\/ Background properties.}} \end{DoxyItemize}


\doxysubsection{Enumeration Type Documentation}
\mbox{\Hypertarget{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}\label{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}} 
\index{Background@{Background}!Elm\_Bg\_Option@{Elm\_Bg\_Option}}
\index{Elm\_Bg\_Option@{Elm\_Bg\_Option}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{Elm\_Bg\_Option}{Elm\_Bg\_Option}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\+\_\+\+Bg\+\_\+\+Option}}}



Identifiers on how a background widget is to display its image. 

-- if it was set to use an image file. \begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{ELM\_BG\_OPTION\_CENTER@{ELM\_BG\_OPTION\_CENTER}!Background@{Background}}\index{Background@{Background}!ELM\_BG\_OPTION\_CENTER@{ELM\_BG\_OPTION\_CENTER}}}\mbox{\Hypertarget{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}\label{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}} 
ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+CENTER&Center the background image. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{ELM\_BG\_OPTION\_SCALE@{ELM\_BG\_OPTION\_SCALE}!Background@{Background}}\index{Background@{Background}!ELM\_BG\_OPTION\_SCALE@{ELM\_BG\_OPTION\_SCALE}}}\mbox{\Hypertarget{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}\label{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}} 
ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+SCALE&Scale the background image, retaining aspect ratio (default). \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{ELM\_BG\_OPTION\_STRETCH@{ELM\_BG\_OPTION\_STRETCH}!Background@{Background}}\index{Background@{Background}!ELM\_BG\_OPTION\_STRETCH@{ELM\_BG\_OPTION\_STRETCH}}}\mbox{\Hypertarget{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}\label{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}} 
ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+STRETCH&Stretch the background image to fill the widget\textquotesingle{}s area. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{ELM\_BG\_OPTION\_TILE@{ELM\_BG\_OPTION\_TILE}!Background@{Background}}\index{Background@{Background}!ELM\_BG\_OPTION\_TILE@{ELM\_BG\_OPTION\_TILE}}}\mbox{\Hypertarget{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}\label{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}} 
ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+TILE&Tile background image at its original size. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{ELM\_BG\_OPTION\_LAST@{ELM\_BG\_OPTION\_LAST}!Background@{Background}}\index{Background@{Background}!ELM\_BG\_OPTION\_LAST@{ELM\_BG\_OPTION\_LAST}}}\mbox{\Hypertarget{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}\label{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}} 
ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+LAST&Sentinel value to indicate last enum field during iteration. Also used to indicate errors \\
\hline

\end{DoxyEnumFields}


\doxysubsection{Function Documentation}
\mbox{\Hypertarget{group__Elm__Bg_gac8eba3fcce966addec75ab6335e60f6e}\label{group__Elm__Bg_gac8eba3fcce966addec75ab6335e60f6e}} 
\index{Background@{Background}!elm\_bg\_add@{elm\_bg\_add}}
\index{elm\_bg\_add@{elm\_bg\_add}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_add()}{elm\_bg\_add()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ elm\+\_\+bg\+\_\+add (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{parent }\end{DoxyParamCaption})}



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


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



Referenced by \mbox{\hyperlink{group__Elm__General_ga6d97396fff435e4870918d1058acd613}{elm\+\_\+quicklaunch\+\_\+seed()}}.

\mbox{\Hypertarget{group__Elm__Bg_ga9431af239574a212be6988d618be5ae8}\label{group__Elm__Bg_ga9431af239574a212be6988d618be5ae8}} 
\index{Background@{Background}!elm\_bg\_color\_set@{elm\_bg\_color\_set}}
\index{elm\_bg\_color\_set@{elm\_bg\_color\_set}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_color\_set()}{elm\_bg\_color\_set()}}
{\footnotesize\ttfamily void elm\+\_\+bg\+\_\+color\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{int}]{r,  }\item[{int}]{g,  }\item[{int}]{b }\end{DoxyParamCaption})}



Sets the color on a given background widget. 


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

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

You can reset the color by setting {\ttfamily r}, {\ttfamily g}, {\ttfamily b} as -\/1, -\/1, -\/1.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__Elm__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\+\_\+bg\+\_\+color\+\_\+get()}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{group__Elm__Bg_ga7ebcf30b15b9610380101a26b240b711}\label{group__Elm__Bg_ga7ebcf30b15b9610380101a26b240b711}} 
\index{Background@{Background}!elm\_bg\_color\_get@{elm\_bg\_color\_get}}
\index{elm\_bg\_color\_get@{elm\_bg\_color\_get}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_color\_get()}{elm\_bg\_color\_get()}}
{\footnotesize\ttfamily void elm\+\_\+bg\+\_\+color\+\_\+get (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{int $\ast$}]{r,  }\item[{int $\ast$}]{g,  }\item[{int $\ast$}]{b }\end{DoxyParamCaption})}



Gets 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\textquotesingle{}s value \\
\hline
{\em g} & Where to store the green color component\textquotesingle{}s value \\
\hline
{\em b} & Where to store the blue color component\textquotesingle{}s value\\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
Use {\ttfamily NULL} pointers on the file components you\textquotesingle{}re not interested in\+: they\textquotesingle{}ll be ignored by the function.
\end{DoxyNote}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__Elm__Bg_ga7ebcf30b15b9610380101a26b240b711}{elm\+\_\+bg\+\_\+color\+\_\+get()}} for more details 
\end{DoxySeeAlso}
\mbox{\Hypertarget{group__Elm__Bg_ga0b11c11879de61126414adfbfe3e431c}\label{group__Elm__Bg_ga0b11c11879de61126414adfbfe3e431c}} 
\index{Background@{Background}!elm\_bg\_file\_set@{elm\_bg\_file\_set}}
\index{elm\_bg\_file\_set@{elm\_bg\_file\_set}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_file\_set()}{elm\_bg\_file\_set()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_ga3fe0caf72e93b1bab1ca8ee3ccf3f226}{Eina\+\_\+\+Bool}} elm\+\_\+bg\+\_\+file\+\_\+set (\begin{DoxyParamCaption}\item[{Eo $\ast$}]{obj,  }\item[{const char $\ast$}]{file,  }\item[{const char $\ast$}]{group }\end{DoxyParamCaption})}



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

\begin{DoxyReturn}{Returns}
{\ttfamily EINA\+\_\+\+TRUE} on success, {\ttfamily EINA\+\_\+\+FALSE} 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\textquotesingle{}s area (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 \mbox{\hyperlink{group__Elm__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 NULL}.

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

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em obj} & The background object handle \\
\hline
\mbox{\texttt{ in}}  & {\em file} & The file path \\
\hline
\mbox{\texttt{ in}}  & {\em group} & Optional key (group in Edje) within the file \\
\hline
\end{DoxyParams}


References \mbox{\hyperlink{group__Eina__Types__Group_ga1feb115f8e9913e806e090d9bd5a7301}{EINA\+\_\+\+FALSE}}, \mbox{\hyperlink{group__Eina__Types__Group_ga05c12dacc8b4058994df842b41be85fc}{EINA\+\_\+\+TRUE}}, and \mbox{\hyperlink{group__Elm__Image_ga34277f0638fdb99ac8d866149c6ec095}{elm\+\_\+image\+\_\+preload\+\_\+disabled\+\_\+set()}}.

\mbox{\Hypertarget{group__Elm__Bg_gafd923c1eb9d78db9f4b50fcfec7c74ae}\label{group__Elm__Bg_gafd923c1eb9d78db9f4b50fcfec7c74ae}} 
\index{Background@{Background}!elm\_bg\_file\_get@{elm\_bg\_file\_get}}
\index{elm\_bg\_file\_get@{elm\_bg\_file\_get}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_file\_get()}{elm\_bg\_file\_get()}}
{\footnotesize\ttfamily void elm\+\_\+bg\+\_\+file\+\_\+get (\begin{DoxyParamCaption}\item[{const Eo $\ast$}]{obj,  }\item[{const char $\ast$$\ast$}]{file,  }\item[{const char $\ast$$\ast$}]{group }\end{DoxyParamCaption})}



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

\begin{DoxyNote}{Note}
Use {\ttfamily NULL} pointers on the file components you\textquotesingle{}re not interested in\+: they\textquotesingle{}ll be ignored by the function.
\end{DoxyNote}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em obj} & The background object handle \\
\hline
\mbox{\texttt{ out}}  & {\em file} & The file path \\
\hline
\mbox{\texttt{ out}}  & {\em group} & Optional key (group in Edje) within the file \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{group__Elm__Bg_ga2ed059b3cf946d10a12182fedc3125f9}\label{group__Elm__Bg_ga2ed059b3cf946d10a12182fedc3125f9}} 
\index{Background@{Background}!elm\_bg\_option\_set@{elm\_bg\_option\_set}}
\index{elm\_bg\_option\_set@{elm\_bg\_option\_set}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_option\_set()}{elm\_bg\_option\_set()}}
{\footnotesize\ttfamily void elm\+\_\+bg\+\_\+option\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\+\_\+\+Bg\+\_\+\+Option}}}]{option }\end{DoxyParamCaption})}



Sets the mode of display for a given background widget\textquotesingle{}s image. 

This sets how the background widget will display its image. This will only work if the \mbox{\hyperlink{group__Elm__Bg_ga0b11c11879de61126414adfbfe3e431c}{elm\+\_\+bg\+\_\+file\+\_\+set()}} was previously called with an image file on \$obj. The image can be display tiled, scaled, centered or stretched. \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+SCALE}} by default.


\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em option} & The desired background option(See Elm.\+Bg.\+Option).\\
\hline
\end{DoxyParams}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__Elm__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}{elm\+\_\+bg\+\_\+option\+\_\+get()}} 
\end{DoxySeeAlso}


References \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+CENTER}}, \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+LAST}}, \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+SCALE}}, \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+STRETCH}}, and \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+TILE}}.

\mbox{\Hypertarget{group__Elm__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}\label{group__Elm__Bg_ga4706c9d20c16fc5e2fcbbe6a83fb0a87}} 
\index{Background@{Background}!elm\_bg\_option\_get@{elm\_bg\_option\_get}}
\index{elm\_bg\_option\_get@{elm\_bg\_option\_get}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_option\_get()}{elm\_bg\_option\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Elm__Bg_gac13a24993e39fac3484bd29a9bfeea26}{Elm\+\_\+\+Bg\+\_\+\+Option}} elm\+\_\+bg\+\_\+option\+\_\+get (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj }\end{DoxyParamCaption})}



Gets the mode of display of a given background widget\textquotesingle{}s image. 

\begin{DoxyReturn}{Returns}
The background option Elm.\+Bg.\+Option Default is \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+SCALE}}.
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{group__Elm__Bg_ga2ed059b3cf946d10a12182fedc3125f9}{elm\+\_\+bg\+\_\+option\+\_\+set()}} 
\end{DoxySeeAlso}


References \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a59df3d0f575cd2bc133c367beca423dc}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+CENTER}}, \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a714632e623be7b2e82c96aea6aba5ce3}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+LAST}}, \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a02ef6a9e93a4d4fe3a5a69bdc94b9261}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+SCALE}}, \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26ab6da4402f66e31e15d30b7b79bf7478b}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+STRETCH}}, and \mbox{\hyperlink{group__Elm__Bg_ggac13a24993e39fac3484bd29a9bfeea26a95d3970cc20d64547bf76b9aba606002}{ELM\+\_\+\+BG\+\_\+\+OPTION\+\_\+\+TILE}}.

\mbox{\Hypertarget{group__Elm__Bg_ga6aef5e17ed70d3391401f0395fda06e9}\label{group__Elm__Bg_ga6aef5e17ed70d3391401f0395fda06e9}} 
\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}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_load\_size\_set()}{elm\_bg\_load\_size\_set()}}
{\footnotesize\ttfamily void elm\+\_\+bg\+\_\+load\+\_\+size\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{int}]{w,  }\item[{int}]{h }\end{DoxyParamCaption})}



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

\begin{DoxyWarning}{Warning}
\+: This function just makes sense if an image file was set on {\ttfamily obj}, with \mbox{\hyperlink{group__Elm__Bg_ga0b11c11879de61126414adfbfe3e431c}{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}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em w} & The new width of the image pixmap representation \\
\hline
\mbox{\texttt{ in}}  & {\em h} & The new height of the image pixmap representation \\
\hline
\end{DoxyParams}


References \mbox{\hyperlink{group__Eina__Rectangle__Group_ga0cab4e55c4133b7d476af1de66545617}{EINA\+\_\+\+SIZE2D}}.

\mbox{\Hypertarget{group__Elm__Bg_ga626651023c23741909f641834db7e4b1}\label{group__Elm__Bg_ga626651023c23741909f641834db7e4b1}} 
\index{Background@{Background}!elm\_bg\_overlay\_set@{elm\_bg\_overlay\_set}}
\index{elm\_bg\_overlay\_set@{elm\_bg\_overlay\_set}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_overlay\_set()}{elm\_bg\_overlay\_set()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_gad5b2116495471db12a34bab9a34edfaa}{EINA\+\_\+\+DEPRECATED}} void elm\+\_\+bg\+\_\+overlay\+\_\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj,  }\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{overlay }\end{DoxyParamCaption})}



Set the overlay object used for the background object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The bg object \\
\hline
{\em overlay} & The overlay object\\
\hline
\end{DoxyParams}
This provides a way for elm\+\_\+bg to have an \textquotesingle{}overlay\textquotesingle{} that will be on top of the bg. Once the over object is set, a previously set one will be deleted, even if you set the new one to NULL. If you want to keep that old content object, use the \mbox{\hyperlink{group__Elm__Bg_ga4e732286eff313adcc180b00b404a072}{elm\+\_\+bg\+\_\+overlay\+\_\+unset()}} function.

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000259}{Deprecated}}]use \mbox{\hyperlink{group__Elm__General_ga0531ec8867c72def7c780601764ca642}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+set()}} instead\end{DoxyRefDesc}
\mbox{\Hypertarget{group__Elm__Bg_gaae8cf8c797ab0a2099373a4c14645d50}\label{group__Elm__Bg_gaae8cf8c797ab0a2099373a4c14645d50}} 
\index{Background@{Background}!elm\_bg\_overlay\_get@{elm\_bg\_overlay\_get}}
\index{elm\_bg\_overlay\_get@{elm\_bg\_overlay\_get}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_overlay\_get()}{elm\_bg\_overlay\_get()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_gad5b2116495471db12a34bab9a34edfaa}{EINA\+\_\+\+DEPRECATED}} \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ elm\+\_\+bg\+\_\+overlay\+\_\+get (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj }\end{DoxyParamCaption})}



Get the overlay object used for the background object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The bg object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The content that is being used
\end{DoxyReturn}
Return the content object which is set for this widget

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000260}{Deprecated}}]use \mbox{\hyperlink{group__Elm__General_ga86b0088bbf018964a980f56e02ee2248}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+get()}} instead\end{DoxyRefDesc}
\mbox{\Hypertarget{group__Elm__Bg_ga4e732286eff313adcc180b00b404a072}\label{group__Elm__Bg_ga4e732286eff313adcc180b00b404a072}} 
\index{Background@{Background}!elm\_bg\_overlay\_unset@{elm\_bg\_overlay\_unset}}
\index{elm\_bg\_overlay\_unset@{elm\_bg\_overlay\_unset}!Background@{Background}}
\doxysubsubsection{\texorpdfstring{elm\_bg\_overlay\_unset()}{elm\_bg\_overlay\_unset()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group__Eina__Types__Group_gad5b2116495471db12a34bab9a34edfaa}{EINA\+\_\+\+DEPRECATED}} \mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$ elm\+\_\+bg\+\_\+overlay\+\_\+unset (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group__Evas__Object__Group_ga9e19e6dd1f517a0ba437c0114d3e7c97}{Evas\+\_\+\+Object}} $\ast$}]{obj }\end{DoxyParamCaption})}



Get the overlay object used for the background object. 


\begin{DoxyParams}{Parameters}
{\em obj} & The bg object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The content that was being used
\end{DoxyReturn}
Unparent and return the overlay object which was set for this widget

\begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000261}{Deprecated}}]use \mbox{\hyperlink{group__Elm__General_ga73862b640f3f362a130c2824ef570046}{elm\+\_\+object\+\_\+part\+\_\+content\+\_\+unset()}} instead\end{DoxyRefDesc}
