Functions |
Evas_Object * | elm_bg_add (Evas_Object *parent) |
| Adds a new background to the parent.
|
Eina_Bool | elm_bg_file_set (Evas_Object *obj, const char *file, const char *group) |
| Sets 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) |
| Gets the file (image or edje collection) set on a given background widget.
|
void | elm_bg_option_set (Evas_Object *obj, Elm_Bg_Option option) |
| Sets the mode of display for a given background widget's image.
|
Elm_Bg_Option | elm_bg_option_get (const Evas_Object *obj) |
| Gets 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) |
| Sets the color on a given background widget.
|
void | elm_bg_color_get (const Evas_Object *obj, int *r, int *g, int *b) |
| Gets the color set on a given background widget.
|
void | elm_bg_load_size_set (Evas_Object *obj, Evas_Coord w, Evas_Coord h) |
| Sets the size of the pixmap representation of the image set on a given background widget.
|
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.
The default content parts of the bg widget that you can use are:
"overlay"
- Overlay of the bg.
Enumeration Type Documentation
Enumeration of identifiers on how a background widget is to display its image, if it is set to use an image file.
- See also:
- elm_bg_option_set()
-
elm_bg_option_get()
- Enumerator:
ELM_BG_OPTION_CENTER |
Center the background image
|
ELM_BG_OPTION_SCALE |
Scale the background image, retaining the aspect ratio
|
ELM_BG_OPTION_STRETCH |
Stretch the background image to fill the widget's area
|
ELM_BG_OPTION_TILE |
Tile background image at its original size
|
ELM_BG_OPTION_LAST |
Sentinel value, also used to indicate errors
|
Function Documentation
Adds a new background to the parent.
- Since :
- 2.3.1
- Parameters:
-
[in] | parent | The parent object |
- Returns:
- The new object, otherwise
NULL
if it cannot be created
Gets the color set on a given background widget.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | The background object handle |
[out] | r | The location to store the red color component's value |
[out] | g | The location to store the green color component's value |
[out] | b | The location to store the blue color component's value |
- See also:
- elm_bg_color_get()
Sets 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
.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | The background object handle |
[in] | r | The red color component's value |
[in] | g | The green color component's value |
[in] | b | The blue color component's value |
- See also:
- elm_bg_color_get()
Gets the file (image or edje collection) set on a given background widget.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | The background object handle |
[out] | file | The location to store the requested file's path |
[out] | group | The group to store the optional key within file, if it's an Edje file |
Sets the file (image or edje collection) to give life for the background.
This sets the image file used in the background object. If the image comes from an Edje group, it is stretched to completely fill the background object. If it comes from a traditional image file, it by default is 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().
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | The background object handle |
[in] | file | The file path |
[in] | group | The optional key (group in Edje) within the file |
- Returns:
EINA_TRUE
on success, otherwise EINA_FALSE
Sets the size of the pixmap representation of the image set on a given background widget.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | The background object handle |
[in] | w | The new width of the image pixmap representation |
[in] | h | The new height of the image pixmap representation |
Gets the mode of display for a given background widget's image.
- Since :
- 2.3.1
- Parameters:
-
[in] | 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()
Sets the mode of display for a given background widget's image.
This sets how the background widget displays its image. This only works 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.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | The background object handle |
[in] | option | The desired background option (see Elm_Bg_Option) |
- See also:
- elm_bg_option_get()