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

Elm_Bg_Option elm_bg::option_get () const
 Get the mode of display for a given background widget's image. More...
 
void elm_bg::option_set (Elm_Bg_Option option_) const
 Get the mode of display for a given background widget's image. More...
 
void elm_bg::color_get (int *r_, int *g_, int *b_, int *a_) const
 Get the color set on a given background widget. More...
 
void elm_bg::color_set (int r_, int g_, int b_, int a_) const
 Get the color 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...
 

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

void elm_bg::color_get ( int *  r_,
int *  g_,
int *  b_,
int *  a_ 
) const
inline

Get the color 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.
See also
elm_bg_color_get() for more details
Parameters
rThe red color component's value
gThe green color component's value
bThe blue color component's value
aThe blue color component's value
void elm_bg::color_set ( int  r_,
int  g_,
int  b_,
int  a_ 
) const
inline

Get the color 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.
See also
elm_bg_color_get() for more details
Parameters
rThe red color component's value
gThe green color component's value
bThe blue color component's value
aThe blue color component's value
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

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()
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
EINA_DEPRECATED Evas_Object* elm_bg_overlay_get ( const Evas_Object *  obj)

Get the overlay object used for the background object.

Parameters
objThe bg object
Returns
The content that is being used

Return the content object which is set for this widget

Deprecated:
use elm_object_part_content_get() instead
EINA_DEPRECATED void elm_bg_overlay_set ( Evas_Object *  obj,
Evas_Object *  overlay 
)

Set the overlay object used for the background object.

Parameters
objThe bg object
overlayThe 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.

Deprecated:
use elm_object_part_content_set() instead
EINA_DEPRECATED Evas_Object* elm_bg_overlay_unset ( Evas_Object *  obj)

Get the overlay object used for the background object.

Parameters
objThe bg object
Returns
The content that was being used

Unparent and return the overlay object which was set for this widget

Deprecated:
use elm_object_part_content_unset() instead
Elm_Bg_Option elm_bg::option_get ( ) const
inline

Get the mode of display for a given background widget's image.

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
Parameters
optionThe desired background option (see #Elm_Bg_Option)
void elm_bg::option_set ( Elm_Bg_Option  option_) const
inline

Get the mode of display for a given background widget's image.

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
Parameters
optionThe desired background option (see #Elm_Bg_Option)