Functions
Background

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

Functions

Evas_Object * elm_bg_add (Evas_Object *parent)
 Add a new background to the parent. More...
 
void elm_bg_color_set (Evas_Object *obj, int r, int g, int b)
 Set the color on a given background widget. More...
 
void elm_bg_color_get (const Evas_Object *obj, int *r, int *g, int *b)
 Get the color set on a given background widget. More...
 
Eina_Bool elm_bg_file_set (Eo *obj, const char *file, const char *group)
 Set the file (image or edje collection) to give life for the background. More...
 
void elm_bg_file_get (const Eo *obj, const char **file, const char **group)
 Get the file (image or edje collection) set on a given background widget. More...
 

Detailed Description

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

bg_inheritance_tree.png
preview-00.png

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:

Here is some sample code using it:

Function Documentation

Evas_Object* elm_bg_add ( Evas_Object *  parent)

Add a new background to the parent.

Parameters
parentThe parent object
Returns
The new object or NULL if it cannot be created

References elm_layout_content_set().

Referenced by elm_quicklaunch_seed(), elm_win_util_dialog_add(), 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
objThe background object handle
rWhere to store the red color component's value
gWhere to store the green color component's value
bWhere 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
objThe background object handle
rThe red color component's value
gThe green color component's value
bThe 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.
You can reset the color by setting r, g, b as -1, -1, -1.
See also
elm_bg_color_get()

References elm_layout_content_set().

void elm_bg_file_get ( const Eo *  obj,
const char **  file,
const char **  group 
)

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

Note
Use NULL pointers on the file components you're not interested in: they'll be ignored by the function.
Parameters
[out]fileThe file path
[out]groupOptional key (group in Edje) within the file
Eina_Bool elm_bg_file_set ( Eo *  obj,
const char *  file,
const char *  group 
)

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

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 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 elm_bg_option_set().

Note
Once the image of obj is set, a previously set one will be deleted, even if file is NULL.
This will only affect the contents of one of the background's swallow spots, namely "elm.swallow.background". If you want to achieve the Layout's file setting behavior, you'll have to call that method on this object.
Parameters
[in]fileThe file path
[in]groupOptional key (group in Edje) within the file