bg: Flourish bg documentations and comments.

This commit is contained in:
Daniel Juyung Seo 2014-11-14 15:27:54 +09:00
parent fc41978cc2
commit e9fbc706ac
4 changed files with 6 additions and 13 deletions

View File

@ -10,7 +10,7 @@ class Elm_Bg (Elm_Layout, Efl.File)
This sets how the background widget will display its image. This
will only work if the elm_bg_file_set() was previously called with
an image file on @a obj. The image can be display tiled, scaled,
centered or stretched.
centered or stretched. #ELM_BG_OPTION_SCALE by default.
@see elm_bg_option_get()

View File

@ -10,7 +10,7 @@
typedef enum
{
ELM_BG_OPTION_CENTER, /**< center the background image */
ELM_BG_OPTION_SCALE, /**< scale the background image, retaining aspect ratio */
ELM_BG_OPTION_SCALE, /**< scale the background image, retaining aspect ratio (default)*/
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 */

View File

@ -58,7 +58,7 @@ EAPI void elm_bg_color_get(const Evas_Object *obj, int *
* 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 are (thus retaining
* 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().

View File

@ -26,16 +26,9 @@
typedef struct _Elm_Bg_Data Elm_Bg_Data;
struct _Elm_Bg_Data
{
/* the basic background's edje object has three swallow spots, namely:
* - "elm.swallow.rectangle" (elm_bg_color_set),
* - "elm.swallow.background" (elm_bg_file_set) and
* - "elm.swallow.content" (elm_bg_overlay_set).
* the following three variables hold possible content to fit in each
* of them, respectively. */
Evas_Object *rect, *img;
const char *file, *group; /* path to file and group name
* to give life to "img" */
Evas_Object *rect; /*<< Used for elm_bg_color_set(): elm.swallow.rectangle */
Evas_Object *img; /*<< Used for elm_bg_file_set(): elm.swallow.content */
const char *file, *group; /*<< path to file and group name to give life to "img": elm.swallow.background */
Elm_Bg_Option option;
struct
{