From d2d82342b5e0daa4464bd787f6f1fa905ed0dfbe Mon Sep 17 00:00:00 2001 From: Mike McCormack Date: Fri, 4 Nov 2011 08:29:52 +0900 Subject: [PATCH] Remove documentation, sync with upstream --- src/lib/els_cursor.c | 107 --------------------------------------------------- 1 file changed, 107 deletions(-) diff --git a/src/lib/els_cursor.c b/src/lib/els_cursor.c index b8e00a0..12e7ef7 100644 --- a/src/lib/els_cursor.c +++ b/src/lib/els_cursor.c @@ -7,15 +7,6 @@ #include #endif -/** - * @defgroup Cursors Cursors - * - * The Cursor is an internal smart object used to customize the - * cursor displayed over objects (or widgets). - * It can use default X cursors (if using X), or cursors from a - * theme. - */ - #define _cursor_key "_elm_cursor" struct _Cursor_Id @@ -395,22 +386,6 @@ elm_object_sub_cursor_set(Evas_Object *eventarea, Evas_Object *owner, const char _elm_cursor_del, cur); } -/** - * Set the cursor to be shown when mouse is over the object - * - * Set the cursor that will be displayed when mouse is over the - * object. The object can have only one cursor set to it, so if - * this function is called twice for an object, the previous set - * will be unset. - * If using X cursors, a definition of all the valid cursor names - * is listed on Elementary_Cursors.h. If an invalid name is set - * the default cursor will be used. - * - * @param obj the object being set a cursor. - * @param cursor the cursor name to be used. - * - * @ingroup Cursors - */ EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) { @@ -418,14 +393,6 @@ elm_object_cursor_set(Evas_Object *obj, const char *cursor) elm_object_sub_cursor_set(obj, obj, cursor); } -/** - * Get the cursor to be shown when mouse is over the object - * - * @param obj an object with cursor already set. - * @return the cursor name. - * - * @ingroup Cursors - */ EAPI const char * elm_object_cursor_get(const Evas_Object *obj) { @@ -433,17 +400,6 @@ elm_object_cursor_get(const Evas_Object *obj) return cur->cursor_name; } -/** - * Unset cursor for object - * - * Unset cursor for object, and set the cursor to default if the mouse - * was over this object. - * - * @param obj Target object - * @see elm_object_cursor_set() - * - * @ingroup Cursors - */ EAPI void elm_object_cursor_unset(Evas_Object *obj) { @@ -479,17 +435,6 @@ elm_object_cursor_unset(Evas_Object *obj) free(cur); } -/** - * Sets a different style for this object cursor. - * - * @note before you set a style you should define a cursor with - * elm_object_cursor_set() - * - * @param obj an object with cursor already set. - * @param style the theme style to use (default, transparent, ...) - * - * @ingroup Cursors - */ EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) { @@ -517,15 +462,6 @@ elm_object_cursor_style_set(Evas_Object *obj, const char *style) } } -/** - * Get the style for this object cursor. - * - * @param obj an object with cursor already set. - * @return style the theme style in use, defaults to "default". If the - * object does not have a cursor set, then NULL is returned. - * - * @ingroup Cursors - */ EAPI const char * elm_object_cursor_style_get(const Evas_Object *obj) { @@ -548,20 +484,6 @@ elm_cursor_theme(Elm_Cursor *cur) _elm_cursor_set_hot_spots(cur); } -/** - * Set if the cursor set should be searched on the theme or should use - * the provided by the engine, only. - * - * @note before you set if should look on theme you should define a cursor - * with elm_object_cursor_set(). By default it will only look for cursors - * provided by the engine. - * - * @param obj an object with cursor already set. - * @param engine_only boolean to define it cursors should be looked only - * between the provided by the engine or searched on widget's theme as well. - * - * @ingroup Cursors - */ EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) { @@ -575,16 +497,6 @@ elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) _elm_cursor_cur_set(cur); } -/** - * Get the cursor engine only usage for this object cursor. - * - * @param obj an object with cursor already set. - * @return engine_only boolean to define it cursors should be looked only - * between the provided by the engine or searched on widget's theme as well. If - * the object does not have a cursor set, then EINA_FALSE is returned. - * - * @ingroup Cursors - */ EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) { @@ -592,31 +504,12 @@ elm_object_cursor_engine_only_get(const Evas_Object *obj) return cur->engine_only; } -/** - * Get the configured cursor engine only usage - * - * This gets the globally configured exclusive usage of engine cursors. - * - * @return 1 if only engine cursors should be used - * @ingroup Cursors - */ EAPI int elm_cursor_engine_only_get(void) { return _elm_config->cursor_engine_only; } -/** - * Set the configured cursor engine only usage - * - * This sets the globally configured exclusive usage of engine cursors. - * It won't affect cursors set before changing this value. - * - * @param engine_only If 1 only engine cursors will be enabled, if 0 will - * look for them on theme before. - * @return EINA_TRUE if value is valid and setted (0 or 1) - * @ingroup Cursors - */ EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only) { -- 2.7.4