Removed smooth scrolling. Patch by Jiyoun Park <jy0703.park@samsung.com>
[framework/uifw/elementary.git] / src / lib / elm_icon.h
index 0e835ed..08d6c11 100644 (file)
@@ -1,5 +1,6 @@
 /**
  * @defgroup Icon Icon
+ * @ingroup Elementary
  *
  * @image html img/widget/icon/preview-00.png
  * @image latex img/widget/icon/preview-00.eps
@@ -64,9 +65,9 @@
  * "clicked" - This is called when a user has clicked the icon
  *
  * Supported elm_object common APIs.
- * @li elm_object_signal_emit
- * @li elm_object_signal_callback_add
- * @li elm_object_signal_callback_del
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
  *
  * An example of usage for this API follows:
  * @li @ref tutorial_icon
@@ -294,12 +295,12 @@ EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_
 EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj);
 
 /**
- * Set if the object is (up/down) resizeable.
+ * Set if the object is (up/down) resizable.
  *
  * @param obj The icon object
- * @param size_up A bool to set if the object is resizeable up. Default is
+ * @param size_up A bool to set if the object is resizable up. Default is
  * @c EINA_TRUE.
- * @param size_down A bool to set if the object is resizeable down. Default
+ * @param size_down A bool to set if the object is resizable down. Default
  * is @c EINA_TRUE.
  *
  * This function limits the icon object resize ability. If @p size_up is set to
@@ -313,11 +314,11 @@ EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj);
 EAPI void                  elm_icon_resizable_set(Evas_Object *obj, Eina_Bool size_up, Eina_Bool size_down);
 
 /**
- * Get if the object is (up/down) resizeable.
+ * Get if the object is (up/down) resizable.
  *
  * @param obj The icon object
- * @param size_up A bool to set if the object is resizeable up
- * @param size_down A bool to set if the object is resizeable down
+ * @param size_up A bool to set if the object is resizable up
+ * @param size_down A bool to set if the object is resizable down
  *
  * @see elm_icon_resizable_set()
  *
@@ -452,10 +453,10 @@ EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj);
  * Enable or disable preloading of the icon
  *
  * @param obj The icon object
- * @param disable If EINA_TRUE, preloading will be disabled
+ * @param disabled If EINA_TRUE, preloading will be disabled
  * @ingroup Icon
  */
-EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable);
+EAPI void                  elm_icon_preload_disabled_set(Evas_Object *obj, Eina_Bool disabled);
 
 /**
  * Get if the icon supports animation or not.
@@ -466,7 +467,7 @@ EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disa
  *
  * Return if this elm icon's image can be animated. Currently Evas only
  * supports gif animation. If the return value is EINA_FALSE, other
- * elm_icon_animated_XXX APIs won't work.
+ * elm_icon_animated_xxx APIs won't work.
  * @ingroup Icon
  */
 EAPI Eina_Bool             elm_icon_animated_available_get(const Evas_Object *obj);