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_SCALE, ELM_BG_OPTION_STRETCH, ELM_BG_OPTION_TILE, ELM_BG_OPTION_LAST , 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... | |
enum | Elm_Bg_Option { , ELM_BG_OPTION_SCALE, ELM_BG_OPTION_STRETCH, ELM_BG_OPTION_TILE, ELM_BG_OPTION_LAST , 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 | |
EOAPI void | elm_obj_bg_option_set (Elm_Bg_Option option) |
Set the mode of display for a given background widget's image. More... | |
EOAPI Elm_Bg_Option | elm_obj_bg_option_get (void) |
Get the mode of display for a given background widget's image. More... | |
EOAPI void | elm_obj_bg_color_set (int r, int g, int b, int a) |
Set the color on a given background widget. More... | |
EOAPI void | elm_obj_bg_color_get (int *r, int *g, int *b, int *a) |
Get the color set on a given background widget. More... | |
EOAPI void | elm_obj_bg_load_size_set (Evas_Coord w, Evas_Coord h) |
Set the size of the pixmap representation of the image set on a given background widget. More... | |
void | elm_bg_option_set (Elm_Bg *obj, Elm_Bg_Option option) |
Set the mode of display for a given background widget's image. More... | |
Elm_Bg_Option | elm_bg_option_get (const Elm_Bg *obj) |
Get the mode of display for a given background widget's image. More... | |
void | elm_bg_load_size_set (Elm_Bg *obj, Evas_Coord w, Evas_Coord h) |
Set the size of the pixmap representation of the image set on a given background widget. More... | |
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... | |
EINA_DEPRECATED void | elm_bg_overlay_set (Evas_Object *obj, Evas_Object *overlay) |
Set the overlay object used for the background object. More... | |
EINA_DEPRECATED Evas_Object * | elm_bg_overlay_get (const Evas_Object *obj) |
Get the overlay object used for the background object. More... | |
EINA_DEPRECATED Evas_Object * | elm_bg_overlay_unset (Evas_Object *obj) |
Get the overlay object used for the background object. 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:
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_obj_bg_option_set, elm_obj_bg_option_get.
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.
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.References elm_obj_bg_color_get().
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.References elm_obj_bg_color_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.
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 |
void elm_bg_load_size_set | ( | Elm_Bg * | obj, |
Evas_Coord | w, | ||
Evas_Coord | h | ||
) |
Set the size of the pixmap representation of the image set on a given background widget.
obj
, with Efl.File.file.setThis 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)
[in] | w | The new width of the image pixmap representation. |
[in] | h | The new height of the image pixmap representation. |
References elm_obj_bg_load_size_set().
Elm_Bg_Option elm_bg_option_get | ( | const Elm_Bg * | obj | ) |
Get the mode of display for a given background widget's image.
See also elm_bg_option_set for more details
References elm_obj_bg_option_get().
void elm_bg_option_set | ( | Elm_Bg * | obj, |
Elm_Bg_Option | option | ||
) |
Set the mode of display for a given background widget's image.
This sets how the background widget will display its image. This will only work if the Efl.File.file.set was previously called with an image file on obj
. The image can be display tiled, scaled, centered or stretched. Elm_Bg_Option::ELM_BG_OPTION_SCALE by default.
See also elm_bg_option_get.
[in] | option | The desired background option(See Elm_Bg_Option) |
References elm_obj_bg_option_set().
EINA_DEPRECATED Evas_Object* elm_bg_overlay_get | ( | const Evas_Object * | obj | ) |
Get the overlay object used for the background object.
obj | The bg object |
Return the content object which is set for this widget
EINA_DEPRECATED void elm_bg_overlay_set | ( | Evas_Object * | obj, |
Evas_Object * | overlay | ||
) |
Set the overlay object used for the background object.
obj | The bg object |
overlay | The overlay object |
This provides a way for elm_bg to have an 'overlay' 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 elm_bg_overlay_unset() function.
EINA_DEPRECATED Evas_Object* elm_bg_overlay_unset | ( | Evas_Object * | obj | ) |
Get the overlay object used for the background object.
obj | The bg object |
Unparent and return the overlay object which was set for this widget
EOAPI void elm_obj_bg_color_get | ( | int * | r, |
int * | g, | ||
int * | b, | ||
int * | a | ||
) |
Get the color set on a given background widget.
null
pointers on the file components you're not interested in: they'll be ignored by the function.See also elm_obj_bg_color_get for more details
[out] | r | The red color component's value |
[out] | g | The green color component's value |
[out] | b | The blue color component's value |
[out] | a | The blue color component's value |
Referenced by elm_bg_color_get().
EOAPI void elm_obj_bg_color_set | ( | int | r, |
int | g, | ||
int | b, | ||
int | a | ||
) |
Set the color on a given background widget.
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.See also elm_obj_bg_color_get
[in] | r | The red color component's value |
[in] | g | The green color component's value |
[in] | b | The blue color component's value |
[in] | a | The blue color component's value |
Referenced by elm_bg_color_set().
EOAPI void elm_obj_bg_load_size_set | ( | Evas_Coord | w, |
Evas_Coord | h | ||
) |
Set the size of the pixmap representation of the image set on a given background widget.
obj
, with efl_file_setThis 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)
[in] | w | The new width of the image pixmap representation. |
[in] | h | The new height of the image pixmap representation. |
Referenced by elm_bg_load_size_set().
EOAPI Elm_Bg_Option elm_obj_bg_option_get | ( | void | ) |
Get the mode of display for a given background widget's image.
See also elm_obj_bg_option_set for more details
Referenced by elm_bg_option_get().
EOAPI void elm_obj_bg_option_set | ( | Elm_Bg_Option | option | ) |
Set the mode of display for a given background widget's image.
This sets how the background widget will display its image. This will only work if the efl_file_set was previously called with an image file on obj
. The image can be display tiled, scaled, centered or stretched. Elm_Bg_Option::ELM_BG_OPTION_SCALE by default.
See also elm_obj_bg_option_get.
[in] | option | The desired background option(See Elm_Bg_Option) |
Referenced by elm_bg_option_set().