Background object, used for setting a solid color, image or Edje group as a background to a window or any container object. More...
Enumerations | |
enum | Elm_Bg_Option { ELM_BG_OPTION_CENTER, ELM_BG_OPTION_SCALE, ELM_BG_OPTION_STRETCH, ELM_BG_OPTION_TILE, ELM_BG_OPTION_LAST } |
Identifiers on how a background widget is to display its image -- if it was set to use an image file. More... | |
Functions | |
Evas_Object * | elm_bg_add (Evas_Object *parent) |
Add a new background to the parent. | |
Eina_Bool | elm_bg_file_set (Evas_Object *obj, const char *file, const char *group) |
Set the file (image or edje collection) to give life for the background. | |
void | elm_bg_file_get (const Evas_Object *obj, const char **file, const char **group) |
Get the file (image or edje collection) set on a given background widget. | |
void | elm_bg_option_set (Evas_Object *obj, Elm_Bg_Option option) |
Set the mode of display for a given background widget's image. | |
Elm_Bg_Option | elm_bg_option_get (const Evas_Object *obj) |
Get the mode of display for a given background widget's image. | |
void | elm_bg_color_set (Evas_Object *obj, int r, int g, int b) |
Set the color on a given background widget. | |
void | elm_bg_color_get (const Evas_Object *obj, int *r, int *g, int *b) |
Get the color set on a given background widget. | |
void | elm_bg_load_size_set (Evas_Object *obj, Evas_Coord w, Evas_Coord h) |
Set the size of the pixmap representation of the image set on a given background widget. |
Detailed Description
Background object, used for setting a solid color, image or Edje group as a background to a window or any container object.


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 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:
"overlay"
- overlay of the bg
Here is some sample code using it:
Enumeration Type Documentation
enum Elm_Bg_Option |
Identifiers on how a background widget is to display its image -- if it was set to use an image file.
- See also:
- elm_bg_option_set()
- elm_bg_option_get()
- Enumerator:
Function Documentation
Evas_Object* elm_bg_add | ( | Evas_Object * | parent | ) |
Add a new background to the parent.
- Parameters:
-
parent The parent object
- Returns:
- The new object or
NULL
if it cannot be created
Referenced by elm_quicklaunch_seed(), and elm_win_util_standard_add().
void elm_bg_color_get | ( | const Evas_Object * | obj, |
int * | r, | ||
int * | g, | ||
int * | b | ||
) |
Get the color set on a given background widget.
- Parameters:
-
obj The background object handle r Where to store the red color component's value g Where to store the green color component's value b Where to store the blue color component's value
- Note:
- Use
NULL
pointers on the file components you're not interested in: they'll be ignored by the function.
- See also:
- elm_bg_color_get() for more details
void elm_bg_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b | ||
) |
Set the color on a given background widget.
- Parameters:
-
obj The background object handle r The red color component's value g The green color component's value b The blue color component's value
This sets the color used for the background rectangle, in RGB format. Each color component's range is from 0 to 255.
- Note:
- You probably only want to use this function if you haven't previously called elm_bg_file_set(), so that you just want a solid color background.
- See also:
- elm_bg_color_get()
References elm_layout_sizing_eval(), and ELM_WIDGET_DATA.
void elm_bg_file_get | ( | const Evas_Object * | obj, |
const char ** | file, | ||
const char ** | group | ||
) |
Get the file (image or edje collection) set on a given background widget.
- Parameters:
-
obj The background object handle file Where to store the requested file's path group Where to store the optional key within file, if it's an Edje file
- Note:
- Use
NULL
pointers on the file components you're not interested in: they'll be ignored by the function.
Eina_Bool elm_bg_file_set | ( | Evas_Object * | obj, |
const char * | file, | ||
const char * | group | ||
) |
Set the file (image or edje collection) to give life for the background.
- Parameters:
-
obj The background object handle file The file path group Optional key (group in Edje) within the file
- Returns:
EINA_TRUE
on success,EINA_FALSE
otherwise
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 elm_bg_option_set().
- Note:
- Once the image of
obj
is set, a previously set one will be deleted, even iffile
isNULL
. -
This will only affect the contents of one of the background's swallow spots, namely
"elm.swallow.background"
. If you want to achieve theLayout's
file setting behavior, you'll have to call that method on this object.
References elm_layout_sizing_eval(), and ELM_WIDGET_DATA.
void elm_bg_load_size_set | ( | Evas_Object * | obj, |
Evas_Coord | w, | ||
Evas_Coord | h | ||
) |
Set the size of the pixmap representation of the image set on a given background widget.
- Parameters:
-
obj The background object handle w The new width of the image pixmap representation. h The new height of the image pixmap representation.
- Warning:
- This function just makes sense if an image file was set on
obj
, with elm_bg_file_set().
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)
- 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.
Elm_Bg_Option elm_bg_option_get | ( | const Evas_Object * | obj | ) |
Get the mode of display for a given background widget's image.
- Parameters:
-
obj The background object handle
- Returns:
- The image displaying mode in use for obj or ELM_BG_OPTION_LAST, on errors.
- See also:
- elm_bg_option_set() for more details
References ELM_BG_OPTION_LAST.
void elm_bg_option_set | ( | Evas_Object * | obj, |
Elm_Bg_Option | option | ||
) |
Set the mode of display for a given background widget's image.
- Parameters:
-
obj The background object handle option The desired background option (see Elm_Bg_Option)
This sets how the background widget will display its image. This will only work if the elm_bg_file_set() was previously called with an image file on obj. The image can be display tiled, scaled, centered or stretched.
- See also:
- elm_bg_option_get()
References elm_layout_sizing_eval().