methods {
@property option {
set {
- [[Set the mode of display for a given background widget's image
+ [[Sets 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
}
get {
- [[Get the mode of display for a given background widget's image.
+ [[Gets the mode of display for a given background widget's image.
See also @.option.set for more details
}
@property color {
set {
- [[Set the color on a given background widget
+ [[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.
legacy: null; /* legacy doesn't have 'a' param */
}
get {
- [[Get the color set on a given background widget
+ [[Gets 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.
}
@property load_size {
set {
- [[Set the size of the pixmap representation of the image set on a
+ [[Sets the size of the pixmap representation of the image set on a
given background widget.
Warning: This function just makes sense if an image file was set on
/**
- * Add a new background to the parent
+ * Adds a new background to the parent.
*
* @param parent The parent object
* @return The new object or @c NULL if it cannot be created
EAPI Evas_Object *elm_bg_add(Evas_Object *parent);
/**
- * Set the color on a given background widget
+ * Sets the color on a given background widget.
*
* @param obj The background object handle
* @param r The red color component's value
*
* @note You can reset the color by setting @p r, @p g, @p b as -1, -1, -1.
*
- * @see elm_bg_color_get()
+ * @see elm_bg_color_get() for more details
*
* @ingroup Elm_Bg
*
EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
/**
- * Get the color set on a given background widget
+ * Gets the color set on a given background widget.
*
* @param obj The background object handle
* @param r Where to store the red color component's value
EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
/**
- * Set the file (image or edje collection) to give life for the
- * background
+ * Sets the file (image or edje collection) to give life for the
+ * background.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group);
/**
- * Get the file (image or edje collection) set on a given background
- * widget
+ * Gets the file (image or edje collection) set on a given background
+ * widget.
*
* @note Use @c NULL pointers on the file components you're not
* interested in: they'll be ignored by the function.
*/
EAPI void elm_bg_file_get(const Eo *obj, const char **file, const char **group);
-// TIZEN_ONLY(20160218): Improve launching performance.
+// TIZEN_ONLY(20160218): Improves launching performance.
/**
* @internal
*
- * Set the precreated object.
+ * Sets the precreated object.
*
* @param obj The background object
*
* @ingroup Elm_Bg
- * @see elm_bg_precreated_object_get()
+ *
+ * @see elm_bg_precreated_object_get() for more details
* @since Tizen 2.4
*/
EAPI void elm_bg_precreated_object_set(Evas_Object *obj);
/**
* @internal
*
- * Get the precreated object.
+ * Gets the precreated object.
*
* @return The precreated background object
*
* @ingroup Elm_Bg
- * @see elm_bg_precreated_object_set()
+ *
+ * @see elm_bg_precreated_object_set() for more details
* @since Tizen 2.4
*/
EAPI Evas_Object *elm_bg_precreated_object_get(void);