Merge "[copy&paste] add interface for OSP"

[framework/uifw/elementary.git] / src / lib / elm_bg.h

diff --git a/src/lib/elm_bg.h b/src/lib/elm_bg.h
index 1af2aa3..6ba62b1 100644 (file)
--- a/src/lib/elm_bg.h
+++ b/src/lib/elm_bg.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Bg Bg
+ * @ingroup Elementary
  *
  * @image html img/widget/bg/preview-00.png
  * @image latex img/widget/bg/preview-00.eps
@@ -17,9 +18,9 @@
  * @li "overlay" - overlay of the bg
  *
  * Supported elm_object common APIs.
- * @li elm_object_part_content_set
- * @li elm_object_part_content_get
- * @li elm_object_part_content_unset
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
  *
  * Here is some sample code using it:
  * @li @ref bg_01_example_page
@@ -29,10 +30,12 @@
 
 /**
  * Identifiers on how a background widget is to display its image --
- * if it was tset to use an image file.
+ * if it was set to use an image file.
  *
  * @see elm_bg_option_set()
  * @see elm_bg_option_get()
+ *
+ * @ingroup Bg
  */
 typedef enum
 {
@@ -90,32 +93,30 @@ EAPI Eina_Bool                    elm_bg_file_set(Evas_Object *obj, const char *
  * @param file Where to store the requested file's path
  * @param group Where to store the optional key within @a file, @b if
  * it's an Edje file
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @note Use @c NULL pointers on the file components you're not
  * interested in: they'll be ignored by the function.
  *
  * @ingroup Bg
  */
-EAPI Eina_Bool                    elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group);
+EAPI void                         elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group);
 
 /**
  * Set the mode of display for a given background widget's image
  *
  * @param obj The background object handle
  * @param option The desired background option (see #Elm_Bg_Option)
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * 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 streched.
+ * centered or stretched.
  *
  * @see elm_bg_option_get()
  *
  * @ingroup Bg
  */
-EAPI Eina_Bool                    elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option);
+EAPI void                         elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option);
 
 /**
  * Get the mode of display for a given background widget's image
@@ -137,7 +138,6 @@ EAPI Elm_Bg_Option                elm_bg_option_get(const Evas_Object *obj);
  * @param r The red color component's value
  * @param g The green color component's value
  * @param b The blue color component's value
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * This sets the color used for the background rectangle, in RGB
  * format. Each color component's range is from 0 to 255.
@@ -150,7 +150,7 @@ EAPI Elm_Bg_Option                elm_bg_option_get(const Evas_Object *obj);
  *
  * @ingroup Bg
  */
-EAPI Eina_Bool                    elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
+EAPI void                         elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
 
 /**
  * Get the color set on a given background widget
@@ -159,7 +159,6 @@ EAPI Eina_Bool                    elm_bg_color_set(Evas_Object *obj, int r, int
  * @param r Where to store the red color component's value
  * @param g Where to store the green color component's value
  * @param b Where to store the blue color component's value
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @note Use @c NULL pointers on the file components you're not
  * interested in: they'll be ignored by the function.
@@ -168,7 +167,7 @@ EAPI Eina_Bool                    elm_bg_color_set(Evas_Object *obj, int r, int
  *
  * @ingroup Bg
  */
-EAPI Eina_Bool                    elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
+EAPI void                         elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
 
 /**
  * Set the size of the pixmap representation of the image set on a
@@ -193,7 +192,7 @@ EAPI Eina_Bool                    elm_bg_color_get(const Evas_Object *obj, int *
  *
  * @ingroup Bg
  */
-EAPI Eina_Bool                    elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
+EAPI void                         elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
 
 /**
  * @}