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... | |
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 bgHere is some sample code using it:
Evas_Object* elm_bg_add | ( | Evas_Object * | parent | ) |
Add a new background to the parent.
parent | The parent object |
NULL
if it cannot be created 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.
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 |
NULL
pointers on the file components you're not interested in: they'll be ignored by the function.void elm_bg_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b | ||
) |
Set the color on a given background widget.
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.
r
, g
, b
as -1, -1, -1.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.
NULL
pointers on the file components you're not interested in: they'll be ignored by the function.[out] | file | The file path |
[out] | group | Optional 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.
EINA_TRUE
on success, EINA_FALSE
otherwiseThis 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().
obj
is set, a previously set one will be deleted, even if file
is NULL
."elm.swallow.background"
. If you want to achieve the Layout's
file setting behavior, you'll have to call that method on this object.[in] | file | The file path |
[in] | group | Optional key (group in Edje) within the file |