seoz pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=00735aca2acac0302ed7cb054e37d27131382d84
commit 00735aca2acac0302ed7cb054e37d27131382d84 Author: Daniel Juyung Seo <[email protected]> Date: Fri Nov 14 15:27:54 2014 +0900 bg: Flourish bg documentations and comments. --- src/lib/elm_bg.eo | 2 +- src/lib/elm_bg_common.h | 2 +- src/lib/elm_bg_legacy.h | 2 +- src/lib/elm_widget_bg.h | 13 +++---------- 4 files changed, 6 insertions(+), 13 deletions(-) diff --git a/src/lib/elm_bg.eo b/src/lib/elm_bg.eo index 0ba1e5e..9373b6c 100644 --- a/src/lib/elm_bg.eo +++ b/src/lib/elm_bg.eo @@ -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() diff --git a/src/lib/elm_bg_common.h b/src/lib/elm_bg_common.h index 5a81d6a..0d3ad72 100644 --- a/src/lib/elm_bg_common.h +++ b/src/lib/elm_bg_common.h @@ -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 */ diff --git a/src/lib/elm_bg_legacy.h b/src/lib/elm_bg_legacy.h index 612624c..16444ec 100644 --- a/src/lib/elm_bg_legacy.h +++ b/src/lib/elm_bg_legacy.h @@ -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(). diff --git a/src/lib/elm_widget_bg.h b/src/lib/elm_widget_bg.h index e8541f7..633d955 100644 --- a/src/lib/elm_widget_bg.h +++ b/src/lib/elm_widget_bg.h @@ -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 { --
