enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

docs: bring back docs from eo files by switching to the new group name 

During the migration of docs to the eo file the group name changed to have a
Elm_ prefix which resulted in our docs not including this group and not showing
any of the docs in there. Switching to the new name fixes this.

Having this prefix makes sense especially as we are now merging elm into efl.

Hopefully that will be the last change.

@fix

Ref T3109
This commit is contained in:
Stefan Schmidt 2016-03-16 22:52:23 +01:00
parent 6dcd4f6287
commit 407a717200
22 changed files with 363 additions and 363 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
legacy/elementary/doc/index.doxy
View File

@ -4,29 +4,29 @@
* Elementary is mostly composed of widgets, but it also contains some * Elementary is mostly composed of widgets, but it also contains some
* infrastructure modules that facilitate the use of widgets. These are the * infrastructure modules that facilitate the use of widgets. These are the
* infrastructure modules: * infrastructure modules:
* @li @ref App * @li @ref Elm_App
* @li @ref Caches * @li @ref Elm_Caches
* @li @ref Cursors * @li @ref Elm_Cursors
* @li @ref Debug * @li @ref Elm_Debug
* @li @ref Config * @li @ref Elm_Config
* @li @ref Engine * @li @ref Elm_Engine
* @li @ref Fonts * @li @ref Elm_Fonts
* @li @ref Profile * @li @ref Elm_Profile
* @li @ref Fingers * @li @ref Elm_Fingers
* @li @ref Focus * @li @ref Elm_Focus
* @li @ref General * @li @ref Elm_General
* @li @ref Elm_Gesture_Layer * @li @ref Elm_Gesture_Layer
* @li @ref Password_last_show * @li @ref Elm_Password_last_show
* @li @ref elm-prefs-data * @li @ref elm-prefs-data
* @li @ref Start * @li @ref Elm_Start
* @li @ref Scrolling * @li @ref Elm_Scrolling
* @li @ref Scrollhints * @li @ref Elm_Scrollhints
* @li @ref Mirroring * @li @ref Elm_Mirroring
* @li @ref Scaling * @li @ref Elm_Scaling
* @li @ref Styles * @li @ref Elm_Styles
* @li @ref Theme * @li @ref Elm_Theme
* @li @ref Transit * @li @ref Elm_Transit
* @li @ref WidgetNavigation * @li @ref Elm_WidgetNavigation
* *
* The other two main groups in Elementary are: * The other two main groups in Elementary are:
* @li @ref widgetslist - These are the widgets you'll compose your UI out of. * @li @ref widgetslist - These are the widgets you'll compose your UI out of.

36
legacy/elementary/src/lib/elm_app.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup App App * @defgroup Elm_App App
* @ingroup Elementary * @ingroup Elementary
* Provide information in order to make Elementary determine the @b * Provide information in order to make Elementary determine the @b
* run time location of the software in question, so other data files * run time location of the software in question, so other data files
@ -8,7 +8,7 @@
*/ */
/** /**
* @addtogroup App * @addtogroup Elm_App
* @{ * @{
*/ */
@ -82,7 +82,7 @@
* @see elm_app_data_dir_get() * @see elm_app_data_dir_get()
* @see elm_app_locale_dir_get() * @see elm_app_locale_dir_get()
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile); EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
@ -91,7 +91,7 @@ EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *c
* *
* @param name Application name. * @param name Application name.
* *
* @ingroup App * @ingroup Elm_App
* @since 1.8 * @since 1.8
*/ */
EAPI void elm_app_name_set(const char *name); EAPI void elm_app_name_set(const char *name);
@ -105,7 +105,7 @@ EAPI void elm_app_name_set(const char *name);
* @warning Since this path is very environment dependent, * @warning Since this path is very environment dependent,
* this will hold whatever value is passed to it. * this will hold whatever value is passed to it.
* *
* @ingroup App * @ingroup Elm_App
* @since 1.8 * @since 1.8
*/ */
EAPI void elm_app_desktop_entry_set(const char *path); EAPI void elm_app_desktop_entry_set(const char *path);
@ -126,7 +126,7 @@ EAPI void elm_app_desktop_entry_set(const char *path);
* @warning You should call this function @b before * @warning You should call this function @b before
* elm_app_info_set(). * elm_app_info_set().
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI void elm_app_compile_bin_dir_set(const char *dir); EAPI void elm_app_compile_bin_dir_set(const char *dir);
@ -146,7 +146,7 @@ EAPI void elm_app_compile_bin_dir_set(const char *dir);
* @warning You should call this function @b before * @warning You should call this function @b before
* elm_app_info_set(). * elm_app_info_set().
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI void elm_app_compile_lib_dir_set(const char *dir); EAPI void elm_app_compile_lib_dir_set(const char *dir);
@ -166,7 +166,7 @@ EAPI void elm_app_compile_lib_dir_set(const char *dir);
* @warning You should call this function @b before * @warning You should call this function @b before
* elm_app_info_set(). * elm_app_info_set().
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI void elm_app_compile_data_dir_set(const char *dir); EAPI void elm_app_compile_data_dir_set(const char *dir);
@ -181,7 +181,7 @@ EAPI void elm_app_compile_data_dir_set(const char *dir);
* @warning You should call this function @b before * @warning You should call this function @b before
* elm_app_info_set(). * elm_app_info_set().
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI void elm_app_compile_locale_set(const char *dir); EAPI void elm_app_compile_locale_set(const char *dir);
@ -190,7 +190,7 @@ EAPI void elm_app_compile_locale_set(const char *dir);
* *
* @return The application formal name. * @return The application formal name.
* *
* @ingroup App * @ingroup Elm_App
* @since 1.8 * @since 1.8
*/ */
EAPI const char *elm_app_name_get(void); EAPI const char *elm_app_name_get(void);
@ -201,7 +201,7 @@ EAPI const char *elm_app_name_get(void);
* *
* @return The '.desktop' file path. * @return The '.desktop' file path.
* *
* @ingroup App * @ingroup Elm_App
* @since 1.8 * @since 1.8
*/ */
EAPI const char *elm_app_desktop_entry_get(void); EAPI const char *elm_app_desktop_entry_get(void);
@ -213,7 +213,7 @@ EAPI const char *elm_app_desktop_entry_get(void);
* *
* @return The directory prefix the application is actually using. * @return The directory prefix the application is actually using.
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI const char *elm_app_prefix_dir_get(void); EAPI const char *elm_app_prefix_dir_get(void);
@ -225,7 +225,7 @@ EAPI const char *elm_app_prefix_dir_get(void);
* @return The binaries directory prefix the application is actually * @return The binaries directory prefix the application is actually
* using. * using.
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI const char *elm_app_bin_dir_get(void); EAPI const char *elm_app_bin_dir_get(void);
@ -237,7 +237,7 @@ EAPI const char *elm_app_bin_dir_get(void);
* @return The libraries directory prefix the application is actually * @return The libraries directory prefix the application is actually
* using. * using.
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI const char *elm_app_lib_dir_get(void); EAPI const char *elm_app_lib_dir_get(void);
@ -249,7 +249,7 @@ EAPI const char *elm_app_lib_dir_get(void);
* @return The data directory prefix the application is actually * @return The data directory prefix the application is actually
* using. * using.
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI const char *elm_app_data_dir_get(void); EAPI const char *elm_app_data_dir_get(void);
@ -261,7 +261,7 @@ EAPI const char *elm_app_data_dir_get(void);
* @return The locale directory prefix the application is actually * @return The locale directory prefix the application is actually
* using. * using.
* *
* @ingroup App * @ingroup Elm_App
*/ */
EAPI const char *elm_app_locale_dir_get(void); EAPI const char *elm_app_locale_dir_get(void);
@ -277,7 +277,7 @@ EAPI const char *elm_app_locale_dir_get(void);
* *
* @note You should call this function @b before using ELM_SCALE_SIZE macro. * @note You should call this function @b before using ELM_SCALE_SIZE macro.
* *
* @ingroup App * @ingroup Elm_App
* @since 1.12 * @since 1.12
*/ */
EAPI void elm_app_base_scale_set(double base_scale); EAPI void elm_app_base_scale_set(double base_scale);
@ -287,7 +287,7 @@ EAPI void elm_app_base_scale_set(double base_scale);
* *
* @return The base scale which the application sets. * @return The base scale which the application sets.
* *
* @ingroup App * @ingroup Elm_App
* @since 1.12 * @since 1.12
*/ */
EAPI double elm_app_base_scale_get(void); EAPI double elm_app_base_scale_get(void);

4
legacy/elementary/src/lib/elm_cache.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Caches Caches * @defgroup Elm_Caches Caches
* @ingroup Elementary * @ingroup Elementary
* *
* These are functions which let one fine-tune some cache values for * These are functions which let one fine-tune some cache values for
@ -22,7 +22,7 @@
* @li evas_render_dump() * @li evas_render_dump()
* @note Evas caches are flushed for every canvas associated with a window. * @note Evas caches are flushed for every canvas associated with a window.
* *
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI void elm_cache_all_flush(void); EAPI void elm_cache_all_flush(void);

218
legacy/elementary/src/lib/elm_config.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Config Elementary Config * @defgroup Elm_Config Elementary Config
* @ingroup Elementary * @ingroup Elementary
* *
* Elementary configuration is formed by a set options bounded to a * Elementary configuration is formed by a set options bounded to a
@ -17,7 +17,7 @@
* future sessions. * future sessions.
* *
* @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise. * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
* @ingroup Config * @ingroup Elm_Config
* *
* This function will take effect -- thus, do I/O -- immediately. Use * This function will take effect -- thus, do I/O -- immediately. Use
* it when you want to save all configuration changes at once. The * it when you want to save all configuration changes at once. The
@ -32,7 +32,7 @@ EAPI Eina_Bool elm_config_save(void);
* profile. * profile.
* *
* @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise. * @return @c EINA_TRUE, when successful. @c EINA_FALSE, otherwise.
* @ingroup Config * @ingroup Elm_Config
* *
* Useful when you want to force reloading of configuration values for * Useful when you want to force reloading of configuration values for
* a profile. If one removes user custom configuration directories, * a profile. If one removes user custom configuration directories,
@ -45,7 +45,7 @@ EAPI void elm_config_reload(void);
* Flush all config settings then apply those settings to all applications * Flush all config settings then apply those settings to all applications
* using elementary on the current display. * using elementary on the current display.
* *
* @ingroup Config * @ingroup Elm_Config
*/ */
EAPI void elm_config_all_flush(void); EAPI void elm_config_all_flush(void);
@ -54,7 +54,7 @@ EAPI void elm_config_all_flush(void);
*/ */
/** /**
* @defgroup Profile Elementary Profile * @defgroup Elm_Profile Elementary Profile
* @ingroup Elementary * @ingroup Elementary
* *
* Profiles are pre-set options that affect the whole look-and-feel of * Profiles are pre-set options that affect the whole look-and-feel of
@ -74,7 +74,7 @@ EAPI void elm_config_all_flush(void);
* applications. * applications.
* *
* @return The profile's name * @return The profile's name
* @ingroup Profile * @ingroup Elm_Profile
*/ */
EAPI const char *elm_config_profile_get(void); EAPI const char *elm_config_profile_get(void);
@ -87,7 +87,7 @@ EAPI const char *elm_config_profile_get(void);
* @param is_user Whether to lookup for a user profile (@c EINA_TRUE) * @param is_user Whether to lookup for a user profile (@c EINA_TRUE)
* or a system one (@c EINA_FALSE) * or a system one (@c EINA_FALSE)
* @return The profile's directory path. * @return The profile's directory path.
* @ingroup Profile * @ingroup Elm_Profile
* *
* @note You must free it with elm_config_profile_dir_free(). * @note You must free it with elm_config_profile_dir_free().
*/ */
@ -98,7 +98,7 @@ EAPI const char *elm_config_profile_dir_get(const char *profile, Eina_Bool is_us
* elm_config_profile_dir_get(). * elm_config_profile_dir_get().
* *
* @param p_dir The profile's path * @param p_dir The profile's path
* @ingroup Profile * @ingroup Elm_Profile
* *
*/ */
EAPI void elm_config_profile_dir_free(const char *p_dir); EAPI void elm_config_profile_dir_free(const char *p_dir);
@ -108,7 +108,7 @@ EAPI void elm_config_profile_dir_free(const char *p_dir);
* *
* @return The profiles list. List node data are the profile name * @return The profiles list. List node data are the profile name
* strings. * strings.
* @ingroup Profile * @ingroup Elm_Profile
* *
* @note One must free this list, after usage, with the function * @note One must free this list, after usage, with the function
* elm_config_profile_list_free(). * elm_config_profile_list_free().
@ -123,7 +123,7 @@ EAPI Eina_List *elm_config_profile_list_get(void);
* *
* @return The profiles list. List node data are the profile name * @return The profiles list. List node data are the profile name
* strings. * strings.
* @ingroup Profile * @ingroup Elm_Profile
* *
* @note One must free this list, after usage, with the function * @note One must free this list, after usage, with the function
* elm_config_profile_list_free(). * elm_config_profile_list_free().
@ -135,7 +135,7 @@ EAPI Eina_List *elm_config_profile_list_full_get(void);
* Free Elementary's list of available profiles. * Free Elementary's list of available profiles.
* *
* @param l The profiles list, as returned by elm_config_profile_list_get(). * @param l The profiles list, as returned by elm_config_profile_list_get().
* @ingroup Profile * @ingroup Elm_Profile
* *
*/ */
EAPI void elm_config_profile_list_free(Eina_List *l); EAPI void elm_config_profile_list_free(Eina_List *l);
@ -145,7 +145,7 @@ EAPI void elm_config_profile_list_free(Eina_List *l);
* *
* @return EINA_TRUE if the profile exists, or EINA_FALSE if not * @return EINA_TRUE if the profile exists, or EINA_FALSE if not
* @param profile The profile's name * @param profile The profile's name
* @ingroup Profile * @ingroup Elm_Profile
* *
* @since 1.17 * @since 1.17
*/ */
@ -159,7 +159,7 @@ EAPI Eina_Bool elm_config_profile_exists(const char *profile);
* affected. * affected.
* *
* @param profile The profile's name * @param profile The profile's name
* @ingroup Profile * @ingroup Elm_Profile
* *
*/ */
EAPI void elm_config_profile_set(const char *profile); EAPI void elm_config_profile_set(const char *profile);
@ -172,7 +172,7 @@ EAPI void elm_config_profile_set(const char *profile);
* application or make other processes switch profile. * application or make other processes switch profile.
* *
* @param profile The profile's name * @param profile The profile's name
* @ingroup Profile * @ingroup Elm_Profile
* *
* @since 1.17 * @since 1.17
*/ */
@ -193,7 +193,7 @@ EAPI void elm_config_profile_save(const char *profile);
* @param derive_options A string of derive options detailing how to modify * @param derive_options A string of derive options detailing how to modify
* *
* @see elm_config_profile_derived_del * @see elm_config_profile_derived_del
* @ingroup Profile * @ingroup Elm_Profile
* *
* @since 1.17 * @since 1.17
*/ */
@ -213,7 +213,7 @@ EAPI void elm_config_profile_derived_add(const char *profile, const char
* @param profile The profile's name that is to be deleted * @param profile The profile's name that is to be deleted
* *
* @see elm_config_profile_derived_add * @see elm_config_profile_derived_add
* @ingroup Profile * @ingroup Elm_Profile
* *
* @since 1.17 * @since 1.17
*/ */
@ -224,7 +224,7 @@ EAPI void elm_config_profile_derived_del(const char *profile);
*/ */
/** /**
* @defgroup Scrolling Elementary Scrolling * @defgroup Elm_Scrolling Elementary Scrolling
* @ingroup Elementary * @ingroup Elementary
* *
* These are functions setting how scrollable views in Elementary * These are functions setting how scrollable views in Elementary
@ -240,7 +240,7 @@ EAPI void elm_config_profile_derived_del(const char *profile);
* @return the thumb scroll bouncing state * @return the thumb scroll bouncing state
* *
* This is the default behavior for touch screens, in general. * This is the default behavior for touch screens, in general.
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI Eina_Bool elm_config_scroll_bounce_enabled_get(void); EAPI Eina_Bool elm_config_scroll_bounce_enabled_get(void);
@ -251,7 +251,7 @@ EAPI Eina_Bool elm_config_scroll_bounce_enabled_get(void);
* @param enabled the thumb scroll bouncing state * @param enabled the thumb scroll bouncing state
* *
* @see elm_config_scroll_bounce_enabled_get() * @see elm_config_scroll_bounce_enabled_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_bounce_enabled_set(Eina_Bool enabled); EAPI void elm_config_scroll_bounce_enabled_set(Eina_Bool enabled);
@ -261,7 +261,7 @@ EAPI void elm_config_scroll_bounce_enabled_set(Eina_Bool enabled);
* *
* @return the thumb scroll bounce friction * @return the thumb scroll bounce friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_bounce_friction_get(void); EAPI double elm_config_scroll_bounce_friction_get(void);
@ -272,7 +272,7 @@ EAPI double elm_config_scroll_bounce_friction_get(void);
* @param friction the thumb scroll bounce friction * @param friction the thumb scroll bounce friction
* *
* @see elm_config_scroll_bounce_friction_get() * @see elm_config_scroll_bounce_friction_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_bounce_friction_set(double friction); EAPI void elm_config_scroll_bounce_friction_set(double friction);
@ -282,7 +282,7 @@ EAPI void elm_config_scroll_bounce_friction_set(double friction);
* *
* @return the page scroll friction * @return the page scroll friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_page_scroll_friction_get(void); EAPI double elm_config_scroll_page_scroll_friction_get(void);
@ -293,7 +293,7 @@ EAPI double elm_config_scroll_page_scroll_friction_get(void);
* @param friction the page scroll friction * @param friction the page scroll friction
* *
* @see elm_config_scroll_page_scroll_friction_get() * @see elm_config_scroll_page_scroll_friction_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_page_scroll_friction_set(double friction); EAPI void elm_config_scroll_page_scroll_friction_set(double friction);
@ -323,7 +323,7 @@ EAPI void elm_config_context_menu_disabled_set(Eina_Bool disabled);
* *
* @return the bring in scroll friction * @return the bring in scroll friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_bring_in_scroll_friction_get(void); EAPI double elm_config_scroll_bring_in_scroll_friction_get(void);
@ -334,7 +334,7 @@ EAPI double elm_config_scroll_bring_in_scroll_friction_get(void);
* @param friction the bring in scroll friction * @param friction the bring in scroll friction
* *
* @see elm_config_scroll_bring_in_scroll_friction_get() * @see elm_config_scroll_bring_in_scroll_friction_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_bring_in_scroll_friction_set(double friction); EAPI void elm_config_scroll_bring_in_scroll_friction_set(double friction);
@ -344,7 +344,7 @@ EAPI void elm_config_scroll_bring_in_scroll_friction_set(double friction
* *
* @return the zoom friction * @return the zoom friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_zoom_friction_get(void); EAPI double elm_config_scroll_zoom_friction_get(void);
@ -355,7 +355,7 @@ EAPI double elm_config_scroll_zoom_friction_get(void);
* @param friction the zoom friction * @param friction the zoom friction
* *
* @see elm_config_scroll_zoom_friction_get() * @see elm_config_scroll_zoom_friction_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_zoom_friction_set(double friction); EAPI void elm_config_scroll_zoom_friction_set(double friction);
@ -369,7 +369,7 @@ EAPI void elm_config_scroll_zoom_friction_set(double friction);
* @note All other functions namespaced with "thumbscroll" will only * @note All other functions namespaced with "thumbscroll" will only
* have effect if this mode is enabled. * have effect if this mode is enabled.
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI Eina_Bool elm_config_scroll_thumbscroll_enabled_get(void); EAPI Eina_Bool elm_config_scroll_thumbscroll_enabled_get(void);
@ -380,7 +380,7 @@ EAPI Eina_Bool elm_config_scroll_thumbscroll_enabled_get(void);
* @param enabled the thumb scroll state * @param enabled the thumb scroll state
* *
* @see elm_config_scroll_thumbscroll_enabled_get() * @see elm_config_scroll_thumbscroll_enabled_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_enabled_set(Eina_Bool enabled); EAPI void elm_config_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
@ -392,7 +392,7 @@ EAPI void elm_config_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
* *
* One would use higher values for touch screens, in general, because * One would use higher values for touch screens, in general, because
* of their inherent imprecision. * of their inherent imprecision.
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI unsigned int elm_config_scroll_thumbscroll_threshold_get(void); EAPI unsigned int elm_config_scroll_thumbscroll_threshold_get(void);
@ -403,7 +403,7 @@ EAPI unsigned int elm_config_scroll_thumbscroll_threshold_get(void);
* @param threshold the thumb scroll threshold * @param threshold the thumb scroll threshold
* *
* @see elm_config_thumbscroll_threshold_get() * @see elm_config_thumbscroll_threshold_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_threshold_set(unsigned int threshold); EAPI void elm_config_scroll_thumbscroll_threshold_set(unsigned int threshold);
@ -413,7 +413,7 @@ EAPI void elm_config_scroll_thumbscroll_threshold_set(unsigned int thres
* *
* @return the thumb scroll hold threshold * @return the thumb scroll hold threshold
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI unsigned int elm_config_scroll_thumbscroll_hold_threshold_get(void); EAPI unsigned int elm_config_scroll_thumbscroll_hold_threshold_get(void);
@ -424,7 +424,7 @@ EAPI unsigned int elm_config_scroll_thumbscroll_hold_threshold_get(void);
* @param threshold the thumb scroll hold threshold * @param threshold the thumb scroll hold threshold
* *
* @see elm_config_thumbscroll_hold_threshold_get() * @see elm_config_thumbscroll_hold_threshold_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_hold_threshold_set(unsigned int threshold); EAPI void elm_config_scroll_thumbscroll_hold_threshold_set(unsigned int threshold);
@ -435,7 +435,7 @@ EAPI void elm_config_scroll_thumbscroll_hold_threshold_set(unsigned int
* *
* @return the thumb scroll momentum threshold * @return the thumb scroll momentum threshold
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_momentum_threshold_get(void); EAPI double elm_config_scroll_thumbscroll_momentum_threshold_get(void);
@ -447,7 +447,7 @@ EAPI double elm_config_scroll_thumbscroll_momentum_threshold_get(void);
* @param threshold the thumb scroll momentum threshold * @param threshold the thumb scroll momentum threshold
* *
* @see elm_config_thumbscroll_momentum_threshold_get() * @see elm_config_thumbscroll_momentum_threshold_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_momentum_threshold_set(double threshold); EAPI void elm_config_scroll_thumbscroll_momentum_threshold_set(double threshold);
@ -458,7 +458,7 @@ EAPI void elm_config_scroll_thumbscroll_momentum_threshold_set(double th
* *
* @return the thumb scroll maximum flick distance * @return the thumb scroll maximum flick distance
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get(void); EAPI unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get(void);
@ -470,7 +470,7 @@ EAPI unsigned int elm_config_scroll_thumbscroll_flick_distance_tolerance_get(voi
* @param distance the thumb scroll maximum flick distance * @param distance the thumb scroll maximum flick distance
* *
* @see elm_config_thumbscroll_flick_distance_tolerance_get() * @see elm_config_thumbscroll_flick_distance_tolerance_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_flick_distance_tolerance_set(unsigned int distance); EAPI void elm_config_scroll_thumbscroll_flick_distance_tolerance_set(unsigned int distance);
@ -480,7 +480,7 @@ EAPI void elm_config_scroll_thumbscroll_flick_distance_tolerance_set(uns
* *
* @return the thumb scroll friction * @return the thumb scroll friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_friction_get(void); EAPI double elm_config_scroll_thumbscroll_friction_get(void);
@ -491,7 +491,7 @@ EAPI double elm_config_scroll_thumbscroll_friction_get(void);
* @param friction the thumb scroll friction * @param friction the thumb scroll friction
* *
* @see elm_config_thumbscroll_friction_get() * @see elm_config_thumbscroll_friction_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_friction_set(double friction); EAPI void elm_config_scroll_thumbscroll_friction_set(double friction);
@ -501,7 +501,7 @@ EAPI void elm_config_scroll_thumbscroll_friction_set(double friction);
* *
* @return the thumb scroll min friction * @return the thumb scroll min friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_min_friction_get(void); EAPI double elm_config_scroll_thumbscroll_min_friction_get(void);
@ -512,7 +512,7 @@ EAPI double elm_config_scroll_thumbscroll_min_friction_get(void);
* @param friction the thumb scroll min friction * @param friction the thumb scroll min friction
* *
* @see elm_config_thumbscroll_min_friction_get() * @see elm_config_thumbscroll_min_friction_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_min_friction_set(double friction); EAPI void elm_config_scroll_thumbscroll_min_friction_set(double friction);
@ -523,7 +523,7 @@ EAPI void elm_config_scroll_thumbscroll_min_friction_set(double friction
* *
* @return the thumb scroll friction * @return the thumb scroll friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void); EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
@ -535,7 +535,7 @@ EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
* @param standard the thumb scroll friction standard * @param standard the thumb scroll friction standard
* *
* @see elm_config_thumbscroll_friction_standard_get() * @see elm_config_thumbscroll_friction_standard_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_friction_standard_set(double standard); EAPI void elm_config_scroll_thumbscroll_friction_standard_set(double standard);
@ -546,7 +546,7 @@ EAPI void elm_config_scroll_thumbscroll_friction_standard_set(double sta
* *
* @return the thumb scroll border friction * @return the thumb scroll border friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_border_friction_get(void); EAPI double elm_config_scroll_thumbscroll_border_friction_get(void);
@ -562,7 +562,7 @@ EAPI double elm_config_scroll_thumbscroll_border_friction_get(void);
* @see elm_config_thumbscroll_border_friction_get() * @see elm_config_thumbscroll_border_friction_get()
* @note parameter value will get bound to 0.0 - 1.0 interval, always * @note parameter value will get bound to 0.0 - 1.0 interval, always
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_border_friction_set(double friction); EAPI void elm_config_scroll_thumbscroll_border_friction_set(double friction);
@ -572,7 +572,7 @@ EAPI void elm_config_scroll_thumbscroll_border_friction_set(double frict
* *
* @return the thumb scroll sensitivity friction * @return the thumb scroll sensitivity friction
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_sensitivity_friction_get(void); EAPI double elm_config_scroll_thumbscroll_sensitivity_friction_get(void);
@ -587,7 +587,7 @@ EAPI double elm_config_scroll_thumbscroll_sensitivity_friction_get(void);
* @see elm_config_thumbscroll_sensitivity_friction_get() * @see elm_config_thumbscroll_sensitivity_friction_get()
* @note parameter value will get bound to 0.1 - 1.0 interval, always * @note parameter value will get bound to 0.1 - 1.0 interval, always
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_sensitivity_friction_set(double friction); EAPI void elm_config_scroll_thumbscroll_sensitivity_friction_set(double friction);
@ -599,7 +599,7 @@ EAPI void elm_config_scroll_thumbscroll_sensitivity_friction_set(double
* @see elm_config_scroll_thumbscroll_smooth_start_set() * @see elm_config_scroll_thumbscroll_smooth_start_set()
* *
* @since 1.16 * @since 1.16
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI Eina_Bool elm_config_scroll_thumbscroll_smooth_start_get(void); EAPI Eina_Bool elm_config_scroll_thumbscroll_smooth_start_get(void);
@ -615,7 +615,7 @@ EAPI Eina_Bool elm_config_scroll_thumbscroll_smooth_start_get(void);
* @see elm_config_scroll_thumbscroll_smooth_start_get() * @see elm_config_scroll_thumbscroll_smooth_start_get()
* *
* @since 1.16 * @since 1.16
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_smooth_start_set(Eina_Bool enable); EAPI void elm_config_scroll_thumbscroll_smooth_start_set(Eina_Bool enable);
@ -627,7 +627,7 @@ EAPI void elm_config_scroll_thumbscroll_smooth_start_set(Eina_Bool enabl
* @see elm_config_scroll_animation_disable_set() * @see elm_config_scroll_animation_disable_set()
* *
* @since 1.18 * @since 1.18
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI Eina_Bool elm_config_scroll_animation_disable_get(void); EAPI Eina_Bool elm_config_scroll_animation_disable_get(void);
@ -642,7 +642,7 @@ EAPI Eina_Bool elm_config_scroll_animation_disable_get(void);
* @see elm_config_scroll_animation_disable_get() * @see elm_config_scroll_animation_disable_get()
* *
* @since 1.18 * @since 1.18
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_animation_disable_set(Eina_Bool enable); EAPI void elm_config_scroll_animation_disable_set(Eina_Bool enable);
@ -654,7 +654,7 @@ EAPI void elm_config_scroll_animation_disable_set(Eina_Bool enable);
* @see elm_config_scroll_accel_factor_set() * @see elm_config_scroll_accel_factor_set()
* *
* @since 1.18 * @since 1.18
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_accel_factor_get(void); EAPI double elm_config_scroll_accel_factor_get(void);
@ -671,7 +671,7 @@ EAPI double elm_config_scroll_accel_factor_get(void);
* @note Set 0.0 to disable acceleration * @note Set 0.0 to disable acceleration
* *
* @since 1.18 * @since 1.18
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_accel_factor_set(double factor); EAPI void elm_config_scroll_accel_factor_set(double factor);
@ -683,7 +683,7 @@ EAPI void elm_config_scroll_accel_factor_set(double factor);
* @see elm_config_scroll_thumbscroll_smooth_amount_set() * @see elm_config_scroll_thumbscroll_smooth_amount_set()
* *
* @since 1.16 * @since 1.16
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_smooth_amount_get(void); EAPI double elm_config_scroll_thumbscroll_smooth_amount_get(void);
@ -699,7 +699,7 @@ EAPI double elm_config_scroll_thumbscroll_smooth_amount_get(void);
* @see elm_config_thumbscroll_acceleration_threshold_set() * @see elm_config_thumbscroll_acceleration_threshold_set()
* *
* @since 1.16 * @since 1.16
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_smooth_amount_set(double amount); EAPI void elm_config_scroll_thumbscroll_smooth_amount_set(double amount);
@ -711,7 +711,7 @@ EAPI void elm_config_scroll_thumbscroll_smooth_amount_set(double amount)
* @see elm_config_scroll_thumbscroll_smooth_time_window_set() * @see elm_config_scroll_thumbscroll_smooth_time_window_set()
* *
* @since 1.16 * @since 1.16
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_smooth_time_window_get(void); EAPI double elm_config_scroll_thumbscroll_smooth_time_window_get(void);
@ -727,7 +727,7 @@ EAPI double elm_config_scroll_thumbscroll_smooth_time_window_get(void);
* @see elm_config_scroll_thumbscroll_smooth_time_window_get() * @see elm_config_scroll_thumbscroll_smooth_time_window_get()
* *
* @since 1.16 * @since 1.16
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_smooth_time_window_set(double amount); EAPI void elm_config_scroll_thumbscroll_smooth_time_window_set(double amount);
@ -738,7 +738,7 @@ EAPI void elm_config_scroll_thumbscroll_smooth_time_window_set(double am
* *
* @return the thumb scroll acceleration threshold * @return the thumb scroll acceleration threshold
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_acceleration_threshold_get(void); EAPI double elm_config_scroll_thumbscroll_acceleration_threshold_get(void);
@ -750,7 +750,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_threshold_get(void)
* @param threshold the thumb scroll acceleration threshold * @param threshold the thumb scroll acceleration threshold
* *
* @see elm_config_thumbscroll_acceleration_threshold_get() * @see elm_config_thumbscroll_acceleration_threshold_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_acceleration_threshold_set(double threshold); EAPI void elm_config_scroll_thumbscroll_acceleration_threshold_set(double threshold);
@ -759,7 +759,7 @@ EAPI void elm_config_scroll_thumbscroll_acceleration_threshold_set(doubl
* *
* @return the thumb scroll acceleration time limit * @return the thumb scroll acceleration time limit
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void); EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void);
@ -769,7 +769,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void
* @param time_limit the thumb scroll acceleration time limit * @param time_limit the thumb scroll acceleration time limit
* *
* @see elm_config_thumbscroll_acceleration_time_limit_get() * @see elm_config_thumbscroll_acceleration_time_limit_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_acceleration_time_limit_set(double time_limit); EAPI void elm_config_scroll_thumbscroll_acceleration_time_limit_set(double time_limit);
@ -778,7 +778,7 @@ EAPI void elm_config_scroll_thumbscroll_acceleration_time_limit_set(doub
* *
* @return the thumb scroll acceleration weight * @return the thumb scroll acceleration weight
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void); EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
@ -788,7 +788,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
* @param weight the thumb scroll acceleration weight * @param weight the thumb scroll acceleration weight
* *
* @see elm_config_thumbscroll_acceleration_weight_get() * @see elm_config_thumbscroll_acceleration_weight_get()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EAPI void elm_config_scroll_thumbscroll_acceleration_weight_set(double weight); EAPI void elm_config_scroll_thumbscroll_acceleration_weight_set(double weight);
@ -796,7 +796,7 @@ EAPI void elm_config_scroll_thumbscroll_acceleration_weight_set(double w
* Focus Autoscroll Mode * Focus Autoscroll Mode
* *
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
typedef enum typedef enum
{ {
@ -813,7 +813,7 @@ typedef enum
* viewport. * viewport.
* *
* @see elm_config_focus_autoscroll_mode_set() * @see elm_config_focus_autoscroll_mode_set()
* @ingroup Focus * @ingroup Elm_Focus
* @since 1.10 * @since 1.10
*/ */
EAPI Elm_Focus_Autoscroll_Mode elm_config_focus_autoscroll_mode_get(void); EAPI Elm_Focus_Autoscroll_Mode elm_config_focus_autoscroll_mode_get(void);
@ -831,7 +831,7 @@ EAPI Elm_Focus_Autoscroll_Mode elm_config_focus_autoscroll_mode_get(void);
* default historically. * default historically.
* *
* @see elm_config_focus_autoscroll_mode_get() * @see elm_config_focus_autoscroll_mode_get()
* @ingroup Focus * @ingroup Elm_Focus
* @since 1.10 * @since 1.10
*/ */
EAPI void elm_config_focus_autoscroll_mode_set(Elm_Focus_Autoscroll_Mode mode); EAPI void elm_config_focus_autoscroll_mode_set(Elm_Focus_Autoscroll_Mode mode);
@ -935,7 +935,7 @@ EAPI void elm_config_tooltip_delay_set(double delay);
* This gets the globally configured exclusive usage of engine cursors. * This gets the globally configured exclusive usage of engine cursors.
* *
* @return 1 if only engine cursors should be used * @return 1 if only engine cursors should be used
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI Eina_Bool elm_config_cursor_engine_only_get(void); EAPI Eina_Bool elm_config_cursor_engine_only_get(void);
@ -947,7 +947,7 @@ EAPI Eina_Bool elm_config_cursor_engine_only_get(void);
* *
* @param engine_only If 1 only engine cursors will be enabled, if 0 will * @param engine_only If 1 only engine cursors will be enabled, if 0 will
* look for them on theme before. * look for them on theme before.
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI void elm_config_cursor_engine_only_set(Eina_Bool engine_only); EAPI void elm_config_cursor_engine_only_set(Eina_Bool engine_only);
@ -958,7 +958,7 @@ EAPI void elm_config_cursor_engine_only_set(Eina_Bool engine_only);
* objects. * objects.
* *
* @return The scaling factor * @return The scaling factor
* @ingroup Scaling * @ingroup Elm_Scaling
*/ */
EAPI double elm_config_scale_get(void); EAPI double elm_config_scale_get(void);
@ -969,12 +969,12 @@ EAPI double elm_config_scale_get(void);
* objects. * objects.
* *
* @param scale The scaling factor to set * @param scale The scaling factor to set
* @ingroup Scaling * @ingroup Elm_Scaling
*/ */
EAPI void elm_config_scale_set(double scale); EAPI void elm_config_scale_set(double scale);
/** /**
* @defgroup Password_last_show Password show last * @defgroup Elm_Password_last_show Password show last
* @ingroup Elementary * @ingroup Elementary
* *
* Show last feature of password mode enables user to view * Show last feature of password mode enables user to view
@ -995,7 +995,7 @@ EAPI void elm_config_scale_set(double scale);
* @return @c EINA_TRUE, if the "show last" setting is enabled, * @return @c EINA_TRUE, if the "show last" setting is enabled,
* @c EINA_FALSE if it's disabled. * @c EINA_FALSE if it's disabled.
* *
* @ingroup Password_last_show * @ingroup Elm_Password_last_show
*/ */
EAPI Eina_Bool elm_config_password_show_last_get(void); EAPI Eina_Bool elm_config_password_show_last_get(void);
@ -1006,7 +1006,7 @@ EAPI Eina_Bool elm_config_password_show_last_get(void);
* *
* @param password_show_last If @c EINA_TRUE, enables "show last" in password mode. * @param password_show_last If @c EINA_TRUE, enables "show last" in password mode.
* @see elm_config_password_show_last_timeout_set() * @see elm_config_password_show_last_timeout_set()
* @ingroup Password_last_show * @ingroup Elm_Password_last_show
*/ */
EAPI void elm_config_password_show_last_set(Eina_Bool password_show_last); EAPI void elm_config_password_show_last_set(Eina_Bool password_show_last);
@ -1017,7 +1017,7 @@ EAPI void elm_config_password_show_last_set(Eina_Bool password_show_last);
* mode will be visible. * mode will be visible.
* *
* @return The timeout value of "show last" password mode. * @return The timeout value of "show last" password mode.
* @ingroup Password_last_show * @ingroup Elm_Password_last_show
*/ */
EAPI double elm_config_password_show_last_timeout_get(void); EAPI double elm_config_password_show_last_timeout_get(void);
@ -1029,7 +1029,7 @@ EAPI double elm_config_password_show_last_timeout_get(void);
* *
* @param password_show_last_timeout The timeout value. * @param password_show_last_timeout The timeout value.
* @see elm_config_password_show_last_set() * @see elm_config_password_show_last_set()
* @ingroup Password_last_show * @ingroup Elm_Password_last_show
*/ */
EAPI void elm_config_password_show_last_timeout_set(double password_show_last_timeout); EAPI void elm_config_password_show_last_timeout_set(double password_show_last_timeout);
@ -1038,7 +1038,7 @@ EAPI void elm_config_password_show_last_timeout_set(double password_show_la
*/ */
/** /**
* @defgroup Engine Elementary Engine * @defgroup Elm_Engine Elementary Engine
* @ingroup Elementary * @ingroup Elementary
* *
* These are functions setting and querying which rendering engine * These are functions setting and querying which rendering engine
@ -1195,7 +1195,7 @@ typedef struct _Elm_Font_Overlay
* Get Elementary's list of supported text classes. * Get Elementary's list of supported text classes.
* *
* @return The text classes list, with @c Elm_Text_Class blobs as data. * @return The text classes list, with @c Elm_Text_Class blobs as data.
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* Release the list with elm_text_classes_list_free(). * Release the list with elm_text_classes_list_free().
*/ */
@ -1204,7 +1204,7 @@ EAPI Eina_List *elm_config_text_classes_list_get(void);
/** /**
* Free Elementary's list of supported text classes. * Free Elementary's list of supported text classes.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* @see elm_config_text_classes_list_get(). * @see elm_config_text_classes_list_get().
*/ */
@ -1217,7 +1217,7 @@ EAPI void elm_config_text_classes_list_free(Eina_List *list);
* @return The font overlays list, with @c Elm_Font_Overlay blobs as * @return The font overlays list, with @c Elm_Font_Overlay blobs as
* data. * data.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* For each text class, one can set a <b>font overlay</b> for it, * For each text class, one can set a <b>font overlay</b> for it,
* overriding the default font properties for that class coming from * overriding the default font properties for that class coming from
@ -1236,7 +1236,7 @@ EAPI const Eina_List *elm_config_font_overlay_list_get(void);
* *
* @note If the @p size is lower than zero, the value will be the amount of the size percentage. ex) -50: half of the current size, -100: current size, -10: 1/10 size. * @note If the @p size is lower than zero, the value will be the amount of the size percentage. ex) -50: half of the current size, -100: current size, -10: 1/10 size.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* @p font has to be in the format returned by elm_font_fontconfig_name_get(). * @p font has to be in the format returned by elm_font_fontconfig_name_get().
* @see elm_config_font_overlay_list_get() * @see elm_config_font_overlay_list_get()
@ -1307,7 +1307,7 @@ EAPI void elm_config_selection_unfocused_clear_set(Eina_Bool enabled
* *
* @param text_class Text class name * @param text_class Text class name
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* This will bring back text elements belonging to text class * This will bring back text elements belonging to text class
* @p text_class back to their default font settings. * @p text_class back to their default font settings.
@ -1318,7 +1318,7 @@ EAPI void elm_config_font_overlay_unset(const char *text_class);
* Apply the changes made with elm_config_font_overlay_set() and * Apply the changes made with elm_config_font_overlay_set() and
* elm_config_font_overlay_unset() on the current Elementary window. * elm_config_font_overlay_unset() on the current Elementary window.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* This applies all font overlays set to all objects in the UI. * This applies all font overlays set to all objects in the UI.
*/ */
@ -1330,7 +1330,7 @@ EAPI void elm_config_font_overlay_apply(void);
* EVAS_FONT_HINTING_AUTO < Automatic font hinting * EVAS_FONT_HINTING_AUTO < Automatic font hinting
* EVAS_FONT_HINTING_BYTECODE < Bytecode font hinting * EVAS_FONT_HINTING_BYTECODE < Bytecode font hinting
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* This applies font hint changes to all windows of the current application. * This applies font hint changes to all windows of the current application.
* *
@ -1345,7 +1345,7 @@ EAPI void elm_config_font_hint_type_set(int type);
* *
* This gets the globally configured finger size, <b>in pixels</b> * This gets the globally configured finger size, <b>in pixels</b>
* *
* @ingroup Fingers * @ingroup Elm_Fingers
*/ */
EAPI Evas_Coord elm_config_finger_size_get(void); EAPI Evas_Coord elm_config_finger_size_get(void);
@ -1355,7 +1355,7 @@ EAPI Evas_Coord elm_config_finger_size_get(void);
* This sets the globally configured finger size in pixels * This sets the globally configured finger size in pixels
* *
* @param size The finger size * @param size The finger size
* @ingroup Fingers * @ingroup Elm_Fingers
*/ */
EAPI void elm_config_finger_size_set(Evas_Coord size); EAPI void elm_config_finger_size_set(Evas_Coord size);
@ -1366,7 +1366,7 @@ EAPI void elm_config_finger_size_set(Evas_Coord size);
* ticks * ticks
* *
* @return The cache flush interval time * @return The cache flush interval time
* @ingroup Caches * @ingroup Elm_Caches
* *
* @see elm_cache_all_flush() * @see elm_cache_all_flush()
*/ */
@ -1382,7 +1382,7 @@ EAPI int elm_config_cache_flush_interval_get(void);
* @note The @p size must be greater than 0. if not, the cache flush will be * @note The @p size must be greater than 0. if not, the cache flush will be
* ignored. * ignored.
* *
* @ingroup Caches * @ingroup Elm_Caches
* *
* @see elm_cache_all_flush() * @see elm_cache_all_flush()
*/ */
@ -1400,7 +1400,7 @@ EAPI void elm_config_cache_flush_interval_set(int size);
* not rendering or doing anything graphically right now. * not rendering or doing anything graphically right now.
* *
* @return The cache flush state * @return The cache flush state
* @ingroup Caches * @ingroup Elm_Caches
* *
* @see elm_cache_all_flush() * @see elm_cache_all_flush()
*/ */
@ -1412,7 +1412,7 @@ EAPI Eina_Bool elm_config_cache_flush_enabled_get(void);
* This sets the globally configured cache flush enabled state. * This sets the globally configured cache flush enabled state.
* *
* @param enabled The cache flush enabled state * @param enabled The cache flush enabled state
* @ingroup Caches * @ingroup Elm_Caches
* *
* @see elm_cache_all_flush() * @see elm_cache_all_flush()
*/ */
@ -1424,7 +1424,7 @@ EAPI void elm_config_cache_flush_enabled_set(Eina_Bool enabled);
* This gets the globally configured font cache size, in kilo bytes. * This gets the globally configured font cache size, in kilo bytes.
* *
* @return The font cache size * @return The font cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI int elm_config_cache_font_cache_size_get(void); EAPI int elm_config_cache_font_cache_size_get(void);
@ -1434,7 +1434,7 @@ EAPI int elm_config_cache_font_cache_size_get(void);
* This sets the globally configured font cache size, in kilo bytes * This sets the globally configured font cache size, in kilo bytes
* *
* @param size The font cache size * @param size The font cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI void elm_config_cache_font_cache_size_set(int size); EAPI void elm_config_cache_font_cache_size_set(int size);
@ -1444,7 +1444,7 @@ EAPI void elm_config_cache_font_cache_size_set(int size);
* This gets the globally configured image cache size, in kilo bytes * This gets the globally configured image cache size, in kilo bytes
* *
* @return The image cache size * @return The image cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI int elm_config_cache_image_cache_size_get(void); EAPI int elm_config_cache_image_cache_size_get(void);
@ -1454,7 +1454,7 @@ EAPI int elm_config_cache_image_cache_size_get(void);
* This sets the globally configured image cache size, in kilo bytes * This sets the globally configured image cache size, in kilo bytes
* *
* @param size The image cache size * @param size The image cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI void elm_config_cache_image_cache_size_set(int size); EAPI void elm_config_cache_image_cache_size_set(int size);
@ -1465,7 +1465,7 @@ EAPI void elm_config_cache_image_cache_size_set(int size);
* of files. * of files.
* *
* @return The edje file cache size * @return The edje file cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI int elm_config_cache_edje_file_cache_size_get(void); EAPI int elm_config_cache_edje_file_cache_size_get(void);
@ -1476,7 +1476,7 @@ EAPI int elm_config_cache_edje_file_cache_size_get(void);
* of files. * of files.
* *
* @param size The edje file cache size * @param size The edje file cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI void elm_config_cache_edje_file_cache_size_set(int size); EAPI void elm_config_cache_edje_file_cache_size_set(int size);
@ -1487,7 +1487,7 @@ EAPI void elm_config_cache_edje_file_cache_size_set(int size);
* number of collections. * number of collections.
* *
* @return The edje collections cache size * @return The edje collections cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI int elm_config_cache_edje_collection_cache_size_get(void); EAPI int elm_config_cache_edje_collection_cache_size_get(void);
@ -1498,7 +1498,7 @@ EAPI int elm_config_cache_edje_collection_cache_size_get(void);
* number of collections. * number of collections.
* *
* @param size The edje collections cache size * @param size The edje collections cache size
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EAPI void elm_config_cache_edje_collection_cache_size_set(int size); EAPI void elm_config_cache_edje_collection_cache_size_set(int size);
@ -1565,7 +1565,7 @@ EAPI void elm_config_accel_preference_override_set(Eina_Bool enabled);
* otherwise. * otherwise.
* *
* @see elm_config_focus_highlight_enabled_set() * @see elm_config_focus_highlight_enabled_set()
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void); EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void);
@ -1580,7 +1580,7 @@ EAPI Eina_Bool elm_config_focus_highlight_enabled_get(void);
* this is called. * this is called.
* *
* @see elm_config_focus_highlight_enabled_get() * @see elm_config_focus_highlight_enabled_get()
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_config_focus_highlight_enabled_set(Eina_Bool enable); EAPI void elm_config_focus_highlight_enabled_set(Eina_Bool enable);
@ -1594,7 +1594,7 @@ EAPI void elm_config_focus_highlight_enabled_set(Eina_Bool enabl
* one object to the next * one object to the next
* *
* @see elm_config_focus_highlight_animate_set() * @see elm_config_focus_highlight_animate_set()
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_config_focus_highlight_animate_get(void); EAPI Eina_Bool elm_config_focus_highlight_animate_get(void);
@ -1610,7 +1610,7 @@ EAPI Eina_Bool elm_config_focus_highlight_animate_get(void);
* this is called. * this is called.
* *
* @see elm_config_focus_highlight_animate_get() * @see elm_config_focus_highlight_animate_get()
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_config_focus_highlight_animate_set(Eina_Bool animate); EAPI void elm_config_focus_highlight_animate_set(Eina_Bool animate);
@ -1625,7 +1625,7 @@ EAPI void elm_config_focus_highlight_animate_set(Eina_Bool anima
* *
* @see elm_config_focus_highlight_clip_disabled_set() * @see elm_config_focus_highlight_clip_disabled_set()
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_config_focus_highlight_clip_disabled_get(void); EAPI Eina_Bool elm_config_focus_highlight_clip_disabled_get(void);
@ -1637,7 +1637,7 @@ EAPI Eina_Bool elm_config_focus_highlight_clip_disabled_get(void);
* *
* @see elm_config_focus_highlight_clip_disabled_get() * @see elm_config_focus_highlight_clip_disabled_get()
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_config_focus_highlight_clip_disabled_set(Eina_Bool disable); EAPI void elm_config_focus_highlight_clip_disabled_set(Eina_Bool disable);
@ -1653,7 +1653,7 @@ EAPI void elm_config_focus_highlight_clip_disabled_set(Eina_Bool disable);
* *
* @see elm_config_focus_move_policy_set() * @see elm_config_focus_move_policy_set()
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Elm_Focus_Move_Policy elm_config_focus_move_policy_get(void); EAPI Elm_Focus_Move_Policy elm_config_focus_move_policy_get(void);
@ -1664,7 +1664,7 @@ EAPI Elm_Focus_Move_Policy elm_config_focus_move_policy_get(void);
* *
* @see elm_config_focus_move_policy_get() * @see elm_config_focus_move_policy_get()
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_config_focus_move_policy_set(Elm_Focus_Move_Policy policy); EAPI void elm_config_focus_move_policy_set(Elm_Focus_Move_Policy policy);
@ -1675,7 +1675,7 @@ EAPI void elm_config_focus_move_policy_set(Elm_Focus_Move_Policy policy);
* *
* @see elm_config_item_select_on_focus_disabled_set * @see elm_config_item_select_on_focus_disabled_set
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_config_item_select_on_focus_disabled_get(void); EAPI Eina_Bool elm_config_item_select_on_focus_disabled_get(void);
@ -1686,7 +1686,7 @@ EAPI Eina_Bool elm_config_item_select_on_focus_disabled_get(void);
* *
* @see elm_config_item_select_on_focus_disabled_get * @see elm_config_item_select_on_focus_disabled_get
* @since 1.10 * @since 1.10
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled); EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled);
@ -1697,7 +1697,7 @@ EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled);
* *
* @see elm_config_first_item_focus_on_first_focusin_set * @see elm_config_first_item_focus_on_first_focusin_set
* @since 1.11 * @since 1.11
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_config_first_item_focus_on_first_focusin_get(void); EAPI Eina_Bool elm_config_first_item_focus_on_first_focusin_get(void);
@ -1708,7 +1708,7 @@ EAPI Eina_Bool elm_config_first_item_focus_on_first_focusin_get(void);
* *
* @see elm_config_first_item_focus_on_first_focusin_get * @see elm_config_first_item_focus_on_first_focusin_get
* @since 1.11 * @since 1.11
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_config_first_item_focus_on_first_focusin_set(Eina_Bool enabled); EAPI void elm_config_first_item_focus_on_first_focusin_set(Eina_Bool enabled);

16
legacy/elementary/src/lib/elm_cursor.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Cursors Cursors * @defgroup Elm_Cursors Cursors
* @ingroup Elementary * @ingroup Elementary
* *
* The Elementary cursor is an internal smart object used to * The Elementary cursor is an internal smart object used to
@ -37,7 +37,7 @@
* @param obj the object being set a cursor. * @param obj the object being set a cursor.
* @param cursor the cursor name to be used. * @param cursor the cursor name to be used.
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor); EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor);
@ -47,7 +47,7 @@ EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor);
* @param obj an object with cursor already set. * @param obj an object with cursor already set.
* @return the cursor name. * @return the cursor name.
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI const char *elm_object_cursor_get(const Evas_Object *obj); EAPI const char *elm_object_cursor_get(const Evas_Object *obj);
@ -60,7 +60,7 @@ EAPI const char *elm_object_cursor_get(const Evas_Object *obj);
* @param obj Target object * @param obj Target object
* @see elm_object_cursor_set() * @see elm_object_cursor_set()
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI void elm_object_cursor_unset(Evas_Object *obj); EAPI void elm_object_cursor_unset(Evas_Object *obj);
@ -73,7 +73,7 @@ EAPI void elm_object_cursor_unset(Evas_Object *obj);
* @param obj an object with cursor already set. * @param obj an object with cursor already set.
* @param style the theme style to use (default, transparent, ...) * @param style the theme style to use (default, transparent, ...)
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style); EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style);
@ -84,7 +84,7 @@ EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style
* @return style the theme style in use, defaults to "default". If the * @return style the theme style in use, defaults to "default". If the
* object does not have a cursor set, then NULL is returned. * object does not have a cursor set, then NULL is returned.
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj); EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj);
@ -100,7 +100,7 @@ EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj);
* @param theme_search boolean to define if cursors should be searched * @param theme_search boolean to define if cursors should be searched
* on widget's theme. * on widget's theme.
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI void elm_object_cursor_theme_search_enabled_set(Evas_Object *obj, Eina_Bool theme_search); EAPI void elm_object_cursor_theme_search_enabled_set(Evas_Object *obj, Eina_Bool theme_search);
@ -111,7 +111,7 @@ EAPI void elm_object_cursor_theme_search_enabled_set(Evas_Object *obj, Eina_Bool
* @return @c EINA_TRUE if the cursor set should be searched on widget's theme, * @return @c EINA_TRUE if the cursor set should be searched on widget's theme,
* @c EINA_FALSE otherwise. * @c EINA_FALSE otherwise.
* *
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
EAPI Eina_Bool elm_object_cursor_theme_search_enabled_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_cursor_theme_search_enabled_get(const Evas_Object *obj);

6
legacy/elementary/src/lib/elm_debug.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Debug Debug * @defgroup Elm_Debug Debug
* @ingroup Elementary * @ingroup Elementary
* Don't use it unless you are sure. * Don't use it unless you are sure.
* *
@ -10,7 +10,7 @@
* Print Tree object hierarchy in stdout * Print Tree object hierarchy in stdout
* *
* @param top The root object * @param top The root object
* @ingroup Debug * @ingroup Elm_Debug
*/ */
EAPI void elm_object_tree_dump(const Evas_Object *top); EAPI void elm_object_tree_dump(const Evas_Object *top);
@ -19,7 +19,7 @@ EAPI void elm_object_tree_dump(const Evas_Object *top);
* *
* @param top The root object * @param top The root object
* @param file The path of output file * @param file The path of output file
* @ingroup Debug * @ingroup Elm_Debug
*/ */
EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file); EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);

4
legacy/elementary/src/lib/elm_deprecated.h
View File

@ -511,7 +511,7 @@ EINA_DEPRECATED EAPI Eina_Bool elm_label_slide_get(const Evas_
* *
* @deprecated Use elm_object_domain_translatable_part_text_set() instead. * @deprecated Use elm_object_domain_translatable_part_text_set() instead.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EINA_DEPRECATED EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text); EINA_DEPRECATED EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
@ -529,7 +529,7 @@ EINA_DEPRECATED EAPI void elm_object_domain_translatable_text_part_set(Evas
* *
* @deprecated Use elm_object_translatable_part_text_get() instead. * @deprecated Use elm_object_translatable_part_text_get() instead.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EINA_DEPRECATED EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part); EINA_DEPRECATED EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);

4
legacy/elementary/src/lib/elm_finger.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Fingers Fingers * @defgroup Elm_Fingers Fingers
* @ingroup Elementary * @ingroup Elementary
* *
* Elementary is designed to be finger-friendly for touchscreens, * Elementary is designed to be finger-friendly for touchscreens,
@ -36,7 +36,7 @@
* on size evaluation times for widgets. An external user wouldn't * on size evaluation times for widgets. An external user wouldn't
* be calling, most of the time. * be calling, most of the time.
* *
* @ingroup Fingers * @ingroup Elm_Fingers
*/ */
EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h); EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);

44
legacy/elementary/src/lib/elm_focus.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Focus Focus * @defgroup Elm_Focus Focus
* @ingroup Elementary * @ingroup Elementary
* *
* An Elementary application has, at all times, one (and only one) * An Elementary application has, at all times, one (and only one)
@ -42,7 +42,7 @@
* *
* @see elm_object_focus_set() * @see elm_object_focus_set()
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj);
@ -64,7 +64,7 @@ EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj);
* *
* @see elm_object_focus_get(), elm_object_focus_custom_chain_get() * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus); EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus);
@ -82,7 +82,7 @@ EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus
* will get the event, but not take away the focus from where it * will get the event, but not take away the focus from where it
* was previously. * was previously.
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable); EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable);
@ -97,7 +97,7 @@ EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool
* events are created able to be focused, by default. All the * events are created able to be focused, by default. All the
* others are not. * others are not.
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj);
@ -112,7 +112,7 @@ EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj);
* *
* @param obj The container object * @param obj The container object
* @param objs Chain of objects to pass focus * @param objs Chain of objects to pass focus
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs); EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs);
@ -124,7 +124,7 @@ EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Ei
* Any focus chain previously set on @p obj (for its child objects) * Any focus chain previously set on @p obj (for its child objects)
* is removed entirely after this call. * is removed entirely after this call.
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj); EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj);
@ -132,7 +132,7 @@ EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj);
* Get custom focus chain * Get custom focus chain
* *
* @param obj The container object * @param obj The container object
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj); EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj);
@ -147,7 +147,7 @@ EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *o
* @param obj The container object * @param obj The container object
* @param child The child to be added in custom chain * @param child The child to be added in custom chain
* @param relative_child The relative object to position the child * @param relative_child The relative object to position the child
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child); EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
@ -162,7 +162,7 @@ EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj,
* @param obj The container object * @param obj The container object
* @param child The child to be added in custom chain * @param child The child to be added in custom chain
* @param relative_child The relative object to position the child * @param relative_child The relative object to position the child
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child); EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
@ -178,7 +178,7 @@ EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj
* *
* @see elm_object_focus_next_object_get(), elm_object_focus_next_object_set() * @see elm_object_focus_next_object_get(), elm_object_focus_next_object_set()
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_next(Evas_Object *obj, Elm_Focus_Direction dir); EAPI void elm_object_focus_next(Evas_Object *obj, Elm_Focus_Direction dir);
@ -196,7 +196,7 @@ EAPI void elm_object_focus_next(Evas_Object *obj, Elm_Focus_Dire
* *
* @since 1.8 * @since 1.8
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Evas_Object * elm_object_focus_next_object_get(const Evas_Object *obj, Elm_Focus_Direction dir); EAPI Evas_Object * elm_object_focus_next_object_get(const Evas_Object *obj, Elm_Focus_Direction dir);
@ -216,7 +216,7 @@ EAPI Evas_Object * elm_object_focus_next_object_get(const Evas_Object *ob
* *
* @since 1.8 * @since 1.8
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_next_object_set(Evas_Object *obj, Evas_Object *next, Elm_Focus_Direction dir); EAPI void elm_object_focus_next_object_set(Evas_Object *obj, Evas_Object *next, Elm_Focus_Direction dir);
@ -230,7 +230,7 @@ EAPI void elm_object_focus_next_object_set(Evas_Object *obj, Eva
* *
* @since 1.8 * @since 1.8
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Evas_Object *elm_object_focused_object_get(const Evas_Object *obj); EAPI Evas_Object *elm_object_focused_object_get(const Evas_Object *obj);
@ -252,7 +252,7 @@ EAPI Evas_Object *elm_object_focused_object_get(const Evas_Object *obj);
* *
* @see elm_object_tree_focus_allow_get() * @see elm_object_tree_focus_allow_get()
* *
* @ingroup Focus * @ingroup Elm_Focus
* *
*/ */
EAPI void elm_object_tree_focus_allow_set(Evas_Object *obj, Eina_Bool focusable); EAPI void elm_object_tree_focus_allow_set(Evas_Object *obj, Eina_Bool focusable);
@ -266,7 +266,7 @@ EAPI void elm_object_tree_focus_allow_set(Evas_Object *obj, Eina
* *
* @see elm_object_tree_focus_allow_set() * @see elm_object_tree_focus_allow_set()
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_object_tree_focus_allow_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_tree_focus_allow_get(const Evas_Object *obj);
@ -284,7 +284,7 @@ EAPI Eina_Bool elm_object_tree_focus_allow_get(const Evas_Object *obj
* *
* @since 1.9 * @since 1.9
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Eina_Bool elm_object_focus_highlight_style_set(Evas_Object *obj, const char *style); EAPI Eina_Bool elm_object_focus_highlight_style_set(Evas_Object *obj, const char *style);
@ -298,7 +298,7 @@ EAPI Eina_Bool elm_object_focus_highlight_style_set(Evas_Object *obj, const c
* *
* @since 1.9 * @since 1.9
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI const char *elm_object_focus_highlight_style_get(const Evas_Object *obj); EAPI const char *elm_object_focus_highlight_style_get(const Evas_Object *obj);
@ -312,7 +312,7 @@ EAPI const char *elm_object_focus_highlight_style_get(const Evas_Object *obj);
* *
* @since 1.15 * @since 1.15
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_move_policy_set(Evas_Object *obj, Elm_Focus_Move_Policy policy); EAPI void elm_object_focus_move_policy_set(Evas_Object *obj, Elm_Focus_Move_Policy policy);
@ -334,7 +334,7 @@ EAPI void elm_object_focus_move_policy_set(Evas_Object *obj, Elm
* *
* @since 1.15 * @since 1.15
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Elm_Focus_Move_Policy elm_object_focus_move_policy_get(const Evas_Object *obj); EAPI Elm_Focus_Move_Policy elm_object_focus_move_policy_get(const Evas_Object *obj);
@ -353,7 +353,7 @@ EAPI Elm_Focus_Move_Policy elm_object_focus_move_policy_get(const Evas_Object *
* *
* @since 1.16 * @since 1.16
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_region_show_mode_set(Evas_Object *obj, Elm_Focus_Region_Show_Mode mode); EAPI void elm_object_focus_region_show_mode_set(Evas_Object *obj, Elm_Focus_Region_Show_Mode mode);
@ -367,6 +367,6 @@ EAPI void elm_object_focus_region_show_mode_set(Evas_Objec
* *
* @since 1.16 * @since 1.16
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Elm_Focus_Region_Show_Mode elm_object_focus_region_show_mode_get(const Evas_Object *obj); EAPI Elm_Focus_Region_Show_Mode elm_object_focus_region_show_mode_get(const Evas_Object *obj);

6
legacy/elementary/src/lib/elm_focus_item.h
View File

@ -12,7 +12,7 @@
* see @elm_object_item_focus_set() * see @elm_object_item_focus_set()
* see @elm_object_item_focus_get() * see @elm_object_item_focus_get()
* *
* @ingroup Focus * @ingroup Elm_Focus
* @since 1.10 * @since 1.10
*/ */
EAPI Elm_Object_Item *elm_object_focused_item_get(const Evas_Object *obj); EAPI Elm_Object_Item *elm_object_focused_item_get(const Evas_Object *obj);
@ -32,7 +32,7 @@ EAPI Elm_Object_Item *elm_object_focused_item_get(const Evas_Object
* *
* @since 1.16 * @since 1.16
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI Elm_Object_Item * elm_object_focus_next_item_get(const Evas_Object *obj, Elm_Focus_Direction dir); EAPI Elm_Object_Item * elm_object_focus_next_item_get(const Evas_Object *obj, Elm_Focus_Direction dir);
@ -54,7 +54,7 @@ EAPI Elm_Object_Item * elm_object_focus_next_item_get(const Evas_Object *obj,
* *
* @since 1.16 * @since 1.16
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EAPI void elm_object_focus_next_item_set(Evas_Object *obj, Elm_Object_Item *next_item, Elm_Focus_Direction dir); EAPI void elm_object_focus_next_item_set(Evas_Object *obj, Elm_Object_Item *next_item, Elm_Focus_Direction dir);

14
legacy/elementary/src/lib/elm_font.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Fonts Elementary Fonts * @defgroup Elm_Fonts Elementary Fonts
* @ingroup Elementary * @ingroup Elementary
* *
* These are functions dealing with font rendering, selection and the * These are functions dealing with font rendering, selection and the
@ -23,7 +23,7 @@ typedef struct _Elm_Font_Properties
* @param font The font name and styles string * @param font The font name and styles string
* @return the font properties struct * @return the font properties struct
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* @note The reverse translation can be achieved with * @note The reverse translation can be achieved with
* elm_font_fontconfig_name_get(), for one style only (single font * elm_font_fontconfig_name_get(), for one style only (single font
@ -36,7 +36,7 @@ EAPI Elm_Font_Properties *elm_font_properties_get(const char *font);
* *
* @param efp the font properties struct * @param efp the font properties struct
* *
* @ingroup Fonts * @ingroup Elm_Fonts
*/ */
EAPI void elm_font_properties_free(Elm_Font_Properties *efp); EAPI void elm_font_properties_free(Elm_Font_Properties *efp);
@ -49,7 +49,7 @@ EAPI void elm_font_properties_free(Elm_Font_Properties *efp);
* *
* @return the font name and style string * @return the font name and style string
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* @note The reverse translation can be achieved with * @note The reverse translation can be achieved with
* elm_font_properties_get(), for one style only (single font * elm_font_properties_get(), for one style only (single font
@ -62,7 +62,7 @@ EAPI char *elm_font_fontconfig_name_get(const char *name, const char *style
* *
* @param name the font properties struct * @param name the font properties struct
* *
* @ingroup Fonts * @ingroup Elm_Fonts
*/ */
EAPI void elm_font_fontconfig_name_free(char *name); EAPI void elm_font_fontconfig_name_free(char *name);
@ -77,7 +77,7 @@ EAPI void elm_font_fontconfig_name_free(char *name);
* evas_font_available_list(). * evas_font_available_list().
* @return the font hash. * @return the font hash.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* @note The user is supposed to get it populated at least with 3 * @note The user is supposed to get it populated at least with 3
* default font families (Sans, Serif, Monospace), which should be * default font families (Sans, Serif, Monospace), which should be
@ -90,7 +90,7 @@ EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
* *
* @param hash the hash to be freed. * @param hash the hash to be freed.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
*/ */
EAPI void elm_font_available_hash_del(Eina_Hash *hash); EAPI void elm_font_available_hash_del(Eina_Hash *hash);

20
legacy/elementary/src/lib/elm_general.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup General General * @defgroup Elm_General General
* @ingroup Elementary * @ingroup Elementary
* *
* @brief General Elementary API. Functions that don't relate to * @brief General Elementary API. Functions that don't relate to
@ -14,7 +14,7 @@
*/ */
/** /**
* @addtogroup General * @addtogroup Elm_General
* @{ * @{
*/ */
@ -108,7 +108,7 @@ extern EAPI double _elm_startup_time;
* See the full @ref bg_example_01_c "example". * See the full @ref bg_example_01_c "example".
* *
* @see elm_shutdown(). * @see elm_shutdown().
* @ingroup General * @ingroup Elm_General
*/ */
EAPI int elm_init(int argc, char **argv); EAPI int elm_init(int argc, char **argv);
@ -128,7 +128,7 @@ EAPI int elm_init(int argc, char **argv);
* There is a possibility to call your ecore callbacks(timer, animator, event, * There is a possibility to call your ecore callbacks(timer, animator, event,
* job, and etc.) in elm_shutdown() * job, and etc.) in elm_shutdown()
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI int elm_shutdown(void); EAPI int elm_shutdown(void);
@ -146,7 +146,7 @@ EAPI int elm_shutdown(void);
* *
* @see elm_init() for an example * @see elm_init() for an example
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_run(void); EAPI void elm_run(void);
@ -165,7 +165,7 @@ EAPI void elm_run(void);
* @note By using the appropriate #ELM_POLICY_QUIT on your Elementary * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
* applications, you'll be able to get this function called automatically for you. * applications, you'll be able to get this function called automatically for you.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_exit(void); EAPI void elm_exit(void);
@ -247,7 +247,7 @@ EAPI char *elm_quicklaunch_exe_path_get(const char *exe, const char *cwd);
* @note Currently, we have only one policy identifier/group * @note Currently, we have only one policy identifier/group
* (#ELM_POLICY_QUIT), which has two possible values. * (#ELM_POLICY_QUIT), which has two possible values.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI Eina_Bool elm_policy_set(unsigned int policy, int value); EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
@ -258,7 +258,7 @@ EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
* @return The currently set policy value, for that * @return The currently set policy value, for that
* identifier. Will be @c 0 if @p policy passed is invalid. * identifier. Will be @c 0 if @p policy passed is invalid.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI int elm_policy_get(unsigned int policy); EAPI int elm_policy_get(unsigned int policy);
@ -279,7 +279,7 @@ EAPI int elm_policy_get(unsigned int policy);
* *
* @param lang Language to set, must be the full name of the locale * @param lang Language to set, must be the full name of the locale
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_language_set(const char *lang); EAPI void elm_language_set(const char *lang);
@ -299,7 +299,7 @@ typedef enum _Elm_Process_State
* background application is not user-visible or otherwise important and * background application is not user-visible or otherwise important and
* likely should release resources and not wake up often or process much. * likely should release resources and not wake up often or process much.
* *
* @ingroup General * @ingroup Elm_General
* @since 1.12 * @since 1.12
*/ */
EAPI Elm_Process_State elm_process_state_get(void); EAPI Elm_Process_State elm_process_state_get(void);

2
legacy/elementary/src/lib/elm_getting_started.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Start Getting Started * @defgroup Elm_Start Getting Started
* @ingroup Elementary * @ingroup Elementary
* *
* To write an Elementary app, you can get started with the following: * To write an Elementary app, you can get started with the following:

10
legacy/elementary/src/lib/elm_mirroring.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Mirroring Mirroring * @defgroup Elm_Mirroring Mirroring
* @ingroup Elementary * @ingroup Elementary
* *
* These functions allow you to set ui-mirroring on specific * These functions allow you to set ui-mirroring on specific
@ -19,7 +19,7 @@
* @param obj The widget. * @param obj The widget.
* @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise * @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise
* *
* @ingroup Mirroring * @ingroup Elm_Mirroring
*/ */
EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
@ -29,7 +29,7 @@ EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
* @param obj The widget. * @param obj The widget.
* @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it. * @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it.
* *
* @ingroup Mirroring * @ingroup Elm_Mirroring
*/ */
EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored); EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
@ -39,7 +39,7 @@ EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
* @param obj The widget. * @param obj The widget.
* @return mirrored mode setting of the object. * @return mirrored mode setting of the object.
* *
* @ingroup Mirroring * @ingroup Elm_Mirroring
*/ */
EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
@ -51,7 +51,7 @@ EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
* @param automatic @c EINA_TRUE for auto mirrored mode. @c EINA_FALSE for * @param automatic @c EINA_TRUE for auto mirrored mode. @c EINA_FALSE for
* manual. * manual.
* *
* @ingroup Mirroring * @ingroup Elm_Mirroring
*/ */
EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic); EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);

56
legacy/elementary/src/lib/elm_object.h
View File

@ -7,7 +7,7 @@
* *
* @note Elementary objects may have many text parts (e.g. Action Slider) * @note Elementary objects may have many text parts (e.g. Action Slider)
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *text); EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *text);
@ -22,7 +22,7 @@ EAPI void elm_object_part_text_set(Evas_Object *obj, con
* *
* @note Elementary objects may have many text parts (e.g. Action Slider) * @note Elementary objects may have many text parts (e.g. Action Slider)
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part); EAPI const char *elm_object_part_text_get(const Evas_Object *obj, const char *part);
@ -51,7 +51,7 @@ EAPI const char *elm_object_part_text_get(const Evas_Object *ob
* *
* @since 1.8 * @since 1.8
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_domain_translatable_part_text_set(Evas_Object *obj, const char *part, const char *domain, const char *text); EAPI void elm_object_domain_translatable_part_text_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
@ -77,7 +77,7 @@ EAPI void elm_object_domain_translatable_part_text_set(Evas_Object *obj, co
* *
* @since 1.8 * @since 1.8
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI const char *elm_object_translatable_part_text_get(const Evas_Object *obj, const char *part); EAPI const char *elm_object_translatable_part_text_get(const Evas_Object *obj, const char *part);
@ -104,7 +104,7 @@ EAPI const char *elm_object_translatable_part_text_get(const Evas_Object *obj, c
* *
* @since 1.8 * @since 1.8
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_domain_part_text_translatable_set(Evas_Object *obj, const char *part, const char *domain, Eina_Bool translatable); EAPI void elm_object_domain_part_text_translatable_set(Evas_Object *obj, const char *part, const char *domain, Eina_Bool translatable);
@ -130,7 +130,7 @@ EAPI void elm_object_domain_part_text_translatable_set(Evas_Object *obj, const c
* *
* @see elm_object_part_content_get() * @see elm_object_part_content_get()
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content); EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
@ -147,7 +147,7 @@ EAPI void elm_object_part_content_set(Evas_Object *obj,
* *
* @see elm_object_part_content_set() for more details * @see elm_object_part_content_set() for more details
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part); EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
@ -164,7 +164,7 @@ EAPI Evas_Object *elm_object_part_content_get(const Evas_Object
* *
* @see elm_object_part_content_set() for more details * @see elm_object_part_content_set() for more details
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part); EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
@ -176,7 +176,7 @@ EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj
* @param obj The object which is to be described * @param obj The object which is to be described
* @param txt The text that describes the widget to people with poor or no vision * @param txt The text that describes the widget to people with poor or no vision
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt); EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
@ -186,7 +186,7 @@ EAPI void elm_object_access_info_set(Evas_Object *obj, c
* @param obj The object which is to be described * @param obj The object which is to be described
* @return The text that describes the widget to people with poor or no vision * @return The text that describes the widget to people with poor or no vision
* *
* @ingroup General * @ingroup Elm_General
* *
* @since 1.14 * @since 1.14
*/ */
@ -210,12 +210,12 @@ EAPI const char *elm_object_access_info_get(Evas_Object *obj);
* is unique amongst children. If recurse is set to -1 it will recurse * is unique amongst children. If recurse is set to -1 it will recurse
* without limit. * without limit.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse); EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse);
/** /**
* @defgroup Styles Styles * @defgroup Elm_Styles Styles
* *
* Widgets can have different styles of look. These generic API's * Widgets can have different styles of look. These generic API's
* set styles of widgets, if they support them (and if the theme(s) * set styles of widgets, if they support them (and if the theme(s)
@ -241,7 +241,7 @@ EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, c
* @see elm_theme_overlay_add() * @see elm_theme_overlay_add()
* @see elm_theme_overlay_del() * @see elm_theme_overlay_del()
* *
* @ingroup Styles * @ingroup Elm_Styles
*/ */
EAPI Eina_Bool elm_object_style_set(Evas_Object *obj, const char *style); EAPI Eina_Bool elm_object_style_set(Evas_Object *obj, const char *style);
@ -257,7 +257,7 @@ EAPI Eina_Bool elm_object_style_set(Evas_Object *obj, const char *style);
* *
* @see elm_object_style_set() * @see elm_object_style_set()
* *
* @ingroup Styles * @ingroup Elm_Styles
*/ */
EAPI const char *elm_object_style_get(const Evas_Object *obj); EAPI const char *elm_object_style_get(const Evas_Object *obj);
@ -277,7 +277,7 @@ EAPI const char *elm_object_style_get(const Evas_Object *obj);
* This sets the state for the widget, either disabling it or * This sets the state for the widget, either disabling it or
* enabling it back. * enabling it back.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled); EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled);
@ -290,12 +290,12 @@ EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled);
* *
* This gets the state of the widget, which might be enabled or disabled. * This gets the state of the widget, which might be enabled or disabled.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj);
/** /**
* @defgroup WidgetNavigation Widget Tree Navigation * @defgroup Elm_WidgetNavigation Widget Tree Navigation
* *
* These functions provide checks for if a Evas_Object is an Elementary widget, * These functions provide checks for if a Evas_Object is an Elementary widget,
* the possibility of getting a widget's parent, top level parent and getting a * the possibility of getting a widget's parent, top level parent and getting a
@ -308,7 +308,7 @@ EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj);
* @param obj the object to query. * @param obj the object to query.
* @return @c EINA_TRUE if it is an elementary widget variant, * @return @c EINA_TRUE if it is an elementary widget variant,
* @c EINA_FALSE otherwise * @c EINA_FALSE otherwise
* @ingroup WidgetNavigation * @ingroup Elm_WidgetNavigation
*/ */
EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj); EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj);
@ -328,7 +328,7 @@ EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj);
* application's window, which is the root of that tree, all other * application's window, which is the root of that tree, all other
* objects would have valid Elementary widget parents. * objects would have valid Elementary widget parents.
* *
* @ingroup WidgetNavigation * @ingroup Elm_WidgetNavigation
*/ */
EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj); EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj);
@ -338,7 +338,7 @@ EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj);
* @param obj The object to query. * @param obj The object to query.
* @return The top level Elementary widget, or @c NULL if parent cannot be * @return The top level Elementary widget, or @c NULL if parent cannot be
* found. * found.
* @ingroup WidgetNavigation * @ingroup Elm_WidgetNavigation
*/ */
EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj); EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj);
@ -347,7 +347,7 @@ EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj);
* *
* @param obj the object to query. * @param obj the object to query.
* @return Elementary widget name, or @c NULL if not a valid widget. * @return Elementary widget name, or @c NULL if not a valid widget.
* @ingroup WidgetNavigation * @ingroup Elm_WidgetNavigation
*/ */
EAPI const char *elm_object_widget_type_get(const Evas_Object *obj); EAPI const char *elm_object_widget_type_get(const Evas_Object *obj);
@ -361,7 +361,7 @@ EAPI const char *elm_object_widget_type_get(const Evas_Object *obj);
* @param obj The object * @param obj The object
* @param emission The signal's name. * @param emission The signal's name.
* @param source The signal's source. * @param source The signal's source.
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source); EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source);
@ -378,7 +378,7 @@ EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission,
* @param func The callback function to be executed when the signal is * @param func The callback function to be executed when the signal is
* emitted. * emitted.
* @param data A pointer to data to pass to the callback function. * @param data A pointer to data to pass to the callback function.
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data); EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data);
@ -400,7 +400,7 @@ EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *e
* elm_object_signal_callback_add(). The data pointer that was passed * elm_object_signal_callback_add(). The data pointer that was passed
* to this call will be returned. * to this call will be returned.
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func); EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func);
@ -452,7 +452,7 @@ EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *e
* *
* @see elm_object_event_callback_del() * @see elm_object_event_callback_del()
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data); EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data);
@ -470,7 +470,7 @@ EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb f
* emitted. * emitted.
* @param data Data to pass in to the callback function. * @param data Data to pass in to the callback function.
* @return The data pointer * @return The data pointer
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data); EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data);
@ -490,7 +490,7 @@ EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb f
* *
* @since 1.8 * @since 1.8
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_orientation_mode_disabled_set(Evas_Object *obj, Eina_Bool disabled); EAPI void elm_object_orientation_mode_disabled_set(Evas_Object *obj, Eina_Bool disabled);
@ -504,7 +504,7 @@ EAPI void elm_object_orientation_mode_disabled_set(Evas_Object *obj, Eina
* *
* @since 1.8 * @since 1.8
* *
* @ingroup General * @ingroup Elm_General
*/ */
EAPI Eina_Bool elm_object_orientation_mode_disabled_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_orientation_mode_disabled_get(const Evas_Object *obj);

10
legacy/elementary/src/lib/elm_object_item.h
View File

@ -1,7 +1,7 @@
/** /**
* @typedef Elm_Object_Item * @typedef Elm_Object_Item
* An Elementary Object item handle. * An Elementary Object item handle.
* @ingroup General * @ingroup Elm_General
*/ */
typedef Eo Elm_Object_Item; typedef Eo Elm_Object_Item;
@ -17,7 +17,7 @@ typedef Eo Elm_Object_Item;
* @see elm_object_item_signal_callback_add() * @see elm_object_item_signal_callback_add()
* @since 1.8 * @since 1.8
* *
* @ingroup General * @ingroup Elm_General
*/ */
typedef void (*Elm_Object_Item_Signal_Cb)(void *data, Elm_Object_Item *it, const char *emission, const char *source); typedef void (*Elm_Object_Item_Signal_Cb)(void *data, Elm_Object_Item *it, const char *emission, const char *source);
@ -38,7 +38,7 @@ typedef void (*Elm_Object_Item_Signal_Cb)(void *data, Elm_Objec
* *
* @note Elementary object items may have many labels. * @note Elementary object items may have many labels.
* *
* @ingroup General * @ingroup Elm_General
*/ */
#define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label)) #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
@ -64,7 +64,7 @@ typedef void (*Elm_Object_Item_Signal_Cb)(void *data, Elm_Objec
* @return The data associated with @p it * @return The data associated with @p it
* *
* @note Every elm_object_item supports this API * @note Every elm_object_item supports this API
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void *elm_object_item_data_get(const Elm_Object_Item *it); EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
@ -74,6 +74,6 @@ EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
* @param data The data to be associated with @p it * @param data The data to be associated with @p it
* *
* @note Every elm_object_item supports this API * @note Every elm_object_item supports this API
* @ingroup General * @ingroup Elm_General
*/ */
EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data); EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);

50
legacy/elementary/src/lib/elm_removed.h
View File

@ -190,7 +190,7 @@ EINA_DEPRECATED EAPI const char *elm_engine_current_get(void);
* applications on the display * applications on the display
* *
* @param size The finger size * @param size The finger size
* @ingroup Fingers * @ingroup Elm_Fingers
* @deprecated Use elm_config_finger_size_set() and elm_config_all_flush() * @deprecated Use elm_config_finger_size_set() and elm_config_all_flush()
*/ */
EINA_DEPRECATED EAPI void elm_finger_size_all_set(Evas_Coord size); EINA_DEPRECATED EAPI void elm_finger_size_all_set(Evas_Coord size);
@ -201,7 +201,7 @@ EINA_DEPRECATED EAPI void elm_finger_size_all_set(Evas_Coord size);
* This sets the globally configured scaling factor that is applied to all * This sets the globally configured scaling factor that is applied to all
* objects for all applications. * objects for all applications.
* @param scale The scaling factor to set * @param scale The scaling factor to set
* @ingroup Scaling * @ingroup Elm_Scaling
* @deprecated use elm_scale_set() and elm_config_all_flush() * @deprecated use elm_scale_set() and elm_config_all_flush()
*/ */
EINA_DEPRECATED EAPI void elm_scale_all_set(double scale); EINA_DEPRECATED EAPI void elm_scale_all_set(double scale);
@ -210,7 +210,7 @@ EINA_DEPRECATED EAPI void elm_scale_all_set(double scale);
* Apply the changes made with elm_font_overlay_set() and * Apply the changes made with elm_font_overlay_set() and
* elm_font_overlay_unset() on all Elementary application windows. * elm_font_overlay_unset() on all Elementary application windows.
* *
* @ingroup Fonts * @ingroup Elm_Fonts
* *
* This applies all font overlays set to all objects in the UI. * This applies all font overlays set to all objects in the UI.
* @deprecated Use elm_font_overlay_apply and elm_config_all_flush() * @deprecated Use elm_font_overlay_apply and elm_config_all_flush()
@ -226,7 +226,7 @@ EINA_DEPRECATED EAPI void elm_font_overlay_all_apply(void);
* *
* @param size The cache flush interval time * @param size The cache flush interval time
* @deprecated Use elm_cache_flush_interval_set() and elm_config_all_flush() * @deprecated Use elm_cache_flush_interval_set() and elm_config_all_flush()
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EINA_DEPRECATED EAPI void elm_cache_flush_interval_all_set(int size); EINA_DEPRECATED EAPI void elm_cache_flush_interval_all_set(int size);
@ -239,7 +239,7 @@ EINA_DEPRECATED EAPI void elm_cache_flush_interval_all_set(int size);
* *
* @param enabled The cache flush enabled state * @param enabled The cache flush enabled state
* @deprecated Use elm_cache_flush_enabled_set adnd elm_config_all_flush() * @deprecated Use elm_cache_flush_enabled_set adnd elm_config_all_flush()
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EINA_DEPRECATED EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled); EINA_DEPRECATED EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
@ -252,7 +252,7 @@ EINA_DEPRECATED EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled
* *
* @param size The font cache size * @param size The font cache size
* @deprecated Use elm_font_cache_set() and elm_config_all_flush() * @deprecated Use elm_font_cache_set() and elm_config_all_flush()
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EINA_DEPRECATED EAPI void elm_font_cache_all_set(int size); EINA_DEPRECATED EAPI void elm_font_cache_all_set(int size);
@ -265,7 +265,7 @@ EINA_DEPRECATED EAPI void elm_font_cache_all_set(int size);
* *
* @param size The image cache size * @param size The image cache size
* @deprecated Use elm_image_cache_set() and elm_config_all_flush() * @deprecated Use elm_image_cache_set() and elm_config_all_flush()
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EINA_DEPRECATED EAPI void elm_image_cache_all_set(int size); EINA_DEPRECATED EAPI void elm_image_cache_all_set(int size);
@ -278,7 +278,7 @@ EINA_DEPRECATED EAPI void elm_image_cache_all_set(int size);
* *
* @param size The edje file cache size * @param size The edje file cache size
* @deprecated Use elm_edje_file_cache_set() and elm_config_all_flush() * @deprecated Use elm_edje_file_cache_set() and elm_config_all_flush()
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EINA_DEPRECATED EAPI void elm_edje_file_cache_all_set(int size); EINA_DEPRECATED EAPI void elm_edje_file_cache_all_set(int size);
@ -291,7 +291,7 @@ EINA_DEPRECATED EAPI void elm_edje_file_cache_all_set(int size);
* *
* @param size The edje collections cache size * @param size The edje collections cache size
* @deprecated Use elm_edje_collection_cache_set() and elm_config_all_flush() * @deprecated Use elm_edje_collection_cache_set() and elm_config_all_flush()
* @ingroup Caches * @ingroup Elm_Caches
*/ */
EINA_DEPRECATED EAPI void elm_edje_collection_cache_all_set(int size); EINA_DEPRECATED EAPI void elm_edje_collection_cache_all_set(int size);
@ -303,7 +303,7 @@ EINA_DEPRECATED EAPI void elm_edje_collection_cache_all_set(int size);
* *
* @param profile The profile's name * @param profile The profile's name
* @deprecated Use elm_profile_set() and elm_config_all_flush() * @deprecated Use elm_profile_set() and elm_config_all_flush()
* @ingroup Profile * @ingroup Elm_Profile
* *
*/ */
EINA_DEPRECATED EAPI void elm_profile_all_set(const char *profile); EINA_DEPRECATED EAPI void elm_profile_all_set(const char *profile);
@ -317,7 +317,7 @@ EINA_DEPRECATED EAPI void elm_profile_all_set(const char *profile);
* *
* @see elm_thumbscroll_bounce_enabled_get() * @see elm_thumbscroll_bounce_enabled_get()
* @deprecated Use elm_scroll_bounce_enabled_set() and elm_config_all_flush() * @deprecated Use elm_scroll_bounce_enabled_set() and elm_config_all_flush()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled); EINA_DEPRECATED EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
@ -329,7 +329,7 @@ EINA_DEPRECATED EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool en
* *
* @see elm_thumbscroll_bounce_friction_get() * @see elm_thumbscroll_bounce_friction_get()
* @deprecated Use elm_scroll_bounce_friction_set() and elm_config_all_flush() * @deprecated Use elm_scroll_bounce_friction_set() and elm_config_all_flush()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_bounce_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_bounce_friction_all_set(double friction);
@ -342,7 +342,7 @@ EINA_DEPRECATED EAPI void elm_scroll_bounce_friction_all_set(double fric
* @see elm_thumbscroll_page_scroll_friction_get() * @see elm_thumbscroll_page_scroll_friction_get()
* @deprecated Use elm_scroll_page_scroll_friction_set() and * @deprecated Use elm_scroll_page_scroll_friction_set() and
* elm_config_all_flush() * elm_config_all_flush()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_page_scroll_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
@ -355,7 +355,7 @@ EINA_DEPRECATED EAPI void elm_scroll_page_scroll_friction_all_set(double
* @see elm_thumbscroll_bring_in_scroll_friction_get() * @see elm_thumbscroll_bring_in_scroll_friction_get()
* @deprecated Use elm_scroll_bring_in_scroll_friction_set() and * @deprecated Use elm_scroll_bring_in_scroll_friction_set() and
* elm_config_all_flush() * elm_config_all_flush()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
@ -368,7 +368,7 @@ EINA_DEPRECATED EAPI void elm_scroll_bring_in_scroll_friction_all_set(do
* *
* @see elm_thumbscroll_zoom_friction_get() * @see elm_thumbscroll_zoom_friction_get()
* @deprecated Use elm_scroll_zoom_friction_set() and elm_config_all_flush() * @deprecated Use elm_scroll_zoom_friction_set() and elm_config_all_flush()
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_zoom_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_zoom_friction_all_set(double friction);
@ -382,7 +382,7 @@ EINA_DEPRECATED EAPI void elm_scroll_zoom_friction_all_set(double fricti
* @deprecated Use elm_scroll_thumbscroll_enabled_set() * @deprecated Use elm_scroll_thumbscroll_enabled_set()
* and elm_config_all_flush() * and elm_config_all_flush()
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled); EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
@ -398,7 +398,7 @@ EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bo
* @deprecated Use elm_scroll_thumbscroll_threshold_set() * @deprecated Use elm_scroll_thumbscroll_threshold_set()
* and elm_config_all_flush() * and elm_config_all_flush()
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold); EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
@ -413,7 +413,7 @@ EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_threshold_all_set(unsig
* @deprecated Use elm_scroll_thumbscroll_momentum_threshold_set() * @deprecated Use elm_scroll_thumbscroll_momentum_threshold_set()
* and elm_config_all_flush() * and elm_config_all_flush()
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold); EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
@ -427,7 +427,7 @@ EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_momentum_threshold_all_
* @deprecated Use elm_scroll_thumbscroll_friction_set() * @deprecated Use elm_scroll_thumbscroll_friction_set()
* and elm_config_all_flush() * and elm_config_all_flush()
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
@ -445,7 +445,7 @@ EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_friction_all_set(double
* @deprecated Use elm_scroll_thumbscroll_border_friction_set() * @deprecated Use elm_scroll_thumbscroll_border_friction_set()
* and elm_config_all_flush() * and elm_config_all_flush()
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
@ -462,7 +462,7 @@ EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_border_friction_all_set
* @deprecated Use elm_scroll_thumbscroll_sensitivity_friction_set() * @deprecated Use elm_scroll_thumbscroll_sensitivity_friction_set()
* and elm_config_all_flush() * and elm_config_all_flush()
* *
* @ingroup Scrolling * @ingroup Elm_Scrolling
*/ */
EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction); EINA_DEPRECATED EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
@ -2001,7 +2001,7 @@ EINA_DEPRECATED EAPI double elm_flipselector_interval_get(c
* @see elm_object_focus_get() * @see elm_object_focus_get()
* @deprecated use elm_object_focus_set() instead. * @deprecated use elm_object_focus_set() instead.
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj); EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj);
@ -2017,7 +2017,7 @@ EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj);
* *
* @deprecated Use elm_object_focus_next() instead * @deprecated Use elm_object_focus_next() instead
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EINA_DEPRECATED EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir); EINA_DEPRECATED EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir);
@ -2032,7 +2032,7 @@ EINA_DEPRECATED EAPI void elm_object_focus_cycle(Evas_Object *ob
* @see elm_object_focus() and elm_object_focus_custom_chain_get() * @see elm_object_focus() and elm_object_focus_custom_chain_get()
* @deprecated use elm_object_focus_set() instead. * @deprecated use elm_object_focus_set() instead.
* *
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj); EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj);
@ -2047,7 +2047,7 @@ EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj);
* @param y Vertical component of direction to focus * @param y Vertical component of direction to focus
* *
* @deprecated Support it later. * @deprecated Support it later.
* @ingroup Focus * @ingroup Elm_Focus
*/ */
EINA_DEPRECATED EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y); EINA_DEPRECATED EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y);

6
legacy/elementary/src/lib/elm_scale.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Scaling Widget Scaling * @defgroup Elm_Scaling Widget Scaling
* @ingroup Elementary * @ingroup Elementary
* *
* Different widgets can be scaled independently. These functions * Different widgets can be scaled independently. These functions
@ -21,7 +21,7 @@
* @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
* no scaling) * no scaling)
* *
* @ingroup Scaling * @ingroup Elm_Scaling
*/ */
EAPI void elm_object_scale_set(Evas_Object *obj, double scale); EAPI void elm_object_scale_set(Evas_Object *obj, double scale);
@ -31,6 +31,6 @@ EAPI void elm_object_scale_set(Evas_Object *obj, double scale);
* @param obj The object * @param obj The object
* @return The scaling factor set by elm_object_scale_set() * @return The scaling factor set by elm_object_scale_set()
* *
* @ingroup Scaling * @ingroup Elm_Scaling
*/ */
EAPI double elm_object_scale_get(const Evas_Object *obj); EAPI double elm_object_scale_get(const Evas_Object *obj);

22
legacy/elementary/src/lib/elm_scroll.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Scrollhints Scrollhints * @defgroup Elm_Scrollhints Scrollhints
* @ingroup Elementary * @ingroup Elementary
* *
* Objects when inside a scroller can scroll, but this may not always be * Objects when inside a scroller can scroll, but this may not always be
@ -26,7 +26,7 @@
* take effect on the parents of the indicated object. * take effect on the parents of the indicated object.
* *
* @param obj The object * @param obj The object
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI void elm_object_scroll_hold_push(Evas_Object *obj); EAPI void elm_object_scroll_hold_push(Evas_Object *obj);
@ -37,7 +37,7 @@ EAPI void elm_object_scroll_hold_push(Evas_Object *obj);
* take effect on the parents of the indicated object. * take effect on the parents of the indicated object.
* *
* @param obj The object * @param obj The object
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI void elm_object_scroll_hold_pop(Evas_Object *obj); EAPI void elm_object_scroll_hold_pop(Evas_Object *obj);
@ -49,7 +49,7 @@ EAPI void elm_object_scroll_hold_pop(Evas_Object *obj);
* @param obj The object * @param obj The object
* @return The scroll hold count * @return The scroll hold count
* @since 1.7 * @since 1.7
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI int elm_object_scroll_hold_get(const Evas_Object *obj); EAPI int elm_object_scroll_hold_get(const Evas_Object *obj);
@ -61,7 +61,7 @@ EAPI int elm_object_scroll_hold_get(const Evas_Object *obj);
* object. * object.
* *
* @param obj The object * @param obj The object
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI void elm_object_scroll_freeze_push(Evas_Object *obj); EAPI void elm_object_scroll_freeze_push(Evas_Object *obj);
@ -73,7 +73,7 @@ EAPI void elm_object_scroll_freeze_push(Evas_Object *obj);
* object. * object.
* *
* @param obj The object * @param obj The object
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj); EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj);
@ -85,7 +85,7 @@ EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj);
* @param obj The object * @param obj The object
* @return The scroll freeze count * @return The scroll freeze count
* @since 1.7 * @since 1.7
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI int elm_object_scroll_freeze_get(const Evas_Object *obj); EAPI int elm_object_scroll_freeze_get(const Evas_Object *obj);
@ -97,7 +97,7 @@ EAPI int elm_object_scroll_freeze_get(const Evas_Object *obj);
* *
* @param obj The object * @param obj The object
* @param lock The lock state (1 == locked, 0 == unlocked) * @param lock The lock state (1 == locked, 0 == unlocked)
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock); EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock);
@ -109,7 +109,7 @@ EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock);
* *
* @param obj The object * @param obj The object
* @param lock The lock state (1 == locked, 0 == unlocked) * @param lock The lock state (1 == locked, 0 == unlocked)
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock); EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock);
@ -119,7 +119,7 @@ EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock);
* This gets the lock for X axis scrolling. * This gets the lock for X axis scrolling.
* *
* @param obj The object * @param obj The object
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj);
@ -129,7 +129,7 @@ EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj);
* This gets the lock for Y axis scrolling. * This gets the lock for Y axis scrolling.
* *
* @param obj The object * @param obj The object
* @ingroup Scrollhints * @ingroup Elm_Scrollhints
*/ */
EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj); EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj);

64
legacy/elementary/src/lib/elm_theme.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Theme Theme * @defgroup Elm_Theme Theme
* @ingroup Elementary * @ingroup Elementary
* *
* Elementary uses Edje to theme its widgets, naturally. But for the most * Elementary uses Edje to theme its widgets, naturally. But for the most
@ -93,7 +93,7 @@ typedef struct _Elm_Theme Elm_Theme;
* theme set to show this preview before the user decides to apply it to all * theme set to show this preview before the user decides to apply it to all
* applications). * applications).
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI Elm_Theme *elm_theme_new(void); EAPI Elm_Theme *elm_theme_new(void);
@ -104,7 +104,7 @@ EAPI Elm_Theme *elm_theme_new(void);
* *
* This frees a theme created with elm_theme_new(). * This frees a theme created with elm_theme_new().
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_free(Elm_Theme *th); EAPI void elm_theme_free(Elm_Theme *th);
@ -119,7 +119,7 @@ EAPI void elm_theme_free(Elm_Theme *th);
* @p thdst is also set to reference it, with all the theme settings, * @p thdst is also set to reference it, with all the theme settings,
* overlays and extensions that @p th had. * overlays and extensions that @p th had.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst); EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
@ -133,7 +133,7 @@ EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
* so @p th acts as an override to @p thref, but where its overrides * so @p th acts as an override to @p thref, but where its overrides
* don't apply, it will fall through to @p thref for configuration. * don't apply, it will fall through to @p thref for configuration.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref); EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
@ -146,7 +146,7 @@ EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
* This gets the theme set as the reference theme by elm_theme_ref_set(). * This gets the theme set as the reference theme by elm_theme_ref_set().
* If no theme is set as a reference, NULL is returned. * If no theme is set as a reference, NULL is returned.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th); EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th);
@ -159,7 +159,7 @@ EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th);
* use implicitly unless a specific theme is set. This is also often use * use implicitly unless a specific theme is set. This is also often use
* as a shorthand of NULL. * as a shorthand of NULL.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI Elm_Theme *elm_theme_default_get(void); EAPI Elm_Theme *elm_theme_default_get(void);
@ -181,7 +181,7 @@ EAPI Elm_Theme *elm_theme_default_get(void);
* @see elm_theme_extension_add() * @see elm_theme_extension_add()
* @see elm_theme_overlay_mmap_add() * @see elm_theme_overlay_mmap_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item); EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
@ -193,7 +193,7 @@ EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
* *
* @see elm_theme_overlay_add() * @see elm_theme_overlay_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item); EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
@ -215,7 +215,7 @@ EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
* @see elm_theme_extension_add() * @see elm_theme_extension_add()
* @see elm_theme_overlay_add() * @see elm_theme_overlay_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File *f); EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File *f);
@ -227,7 +227,7 @@ EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File
* *
* @see elm_theme_overlay_mmap_add() * @see elm_theme_overlay_mmap_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File *f); EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File *f);
@ -239,7 +239,7 @@ EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File
* *
* @see elm_theme_overlay_add() * @see elm_theme_overlay_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th); EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
@ -262,7 +262,7 @@ EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
* *
* @see elm_object_style_set() * @see elm_object_style_set()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item); EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
@ -274,7 +274,7 @@ EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
* *
* @see elm_theme_extension_add() * @see elm_theme_extension_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item); EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
@ -297,7 +297,7 @@ EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
* *
* @see elm_object_style_set() * @see elm_object_style_set()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_File *f); EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_File *f);
@ -309,7 +309,7 @@ EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_Fil
* *
* @see elm_theme_extension_add() * @see elm_theme_extension_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_File *f); EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_File *f);
@ -321,7 +321,7 @@ EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_Fil
* *
* @see elm_theme_extension_add() * @see elm_theme_extension_add()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th); EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
@ -341,7 +341,7 @@ EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
* @see elm_theme_get() * @see elm_theme_get()
* @see elm_theme_list_get() * @see elm_theme_list_get()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_set(Elm_Theme *th, const char *theme); EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
@ -357,7 +357,7 @@ EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
* @see elm_theme_set() * @see elm_theme_set()
* @see elm_theme_list_get() * @see elm_theme_list_get()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const char *elm_theme_get(Elm_Theme *th); EAPI const char *elm_theme_get(Elm_Theme *th);
@ -380,7 +380,7 @@ EAPI const char *elm_theme_get(Elm_Theme *th);
* @see elm_theme_set() * @see elm_theme_set()
* @see elm_theme_get() * @see elm_theme_get()
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th); EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
@ -400,7 +400,7 @@ EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
* @c EINA_TRUE if the file was a search-able file and is in the search path, * @c EINA_TRUE if the file was a search-able file and is in the search path,
* and @c EINA_FALSE otherwise. * and @c EINA_FALSE otherwise.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path); EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
@ -414,7 +414,7 @@ EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_
* Call this function if source theme data has changed in such a way as to * Call this function if source theme data has changed in such a way as to
* make any caches Elementary kept invalid. * make any caches Elementary kept invalid.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_flush(Elm_Theme *th); EAPI void elm_theme_flush(Elm_Theme *th);
@ -424,7 +424,7 @@ EAPI void elm_theme_flush(Elm_Theme *th);
* This will flush all themes in the current application context, by calling * This will flush all themes in the current application context, by calling
* elm_theme_flush() on each of them. * elm_theme_flush() on each of them.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_full_flush(void); EAPI void elm_theme_full_flush(void);
@ -438,7 +438,7 @@ EAPI void elm_theme_full_flush(void);
* element names in a list of strings. Free this with * element names in a list of strings. Free this with
* elm_theme_name_available_list_free() when you are done with the list. * elm_theme_name_available_list_free() when you are done with the list.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI Eina_List *elm_theme_name_available_list_new(void); EAPI Eina_List *elm_theme_name_available_list_new(void);
@ -449,7 +449,7 @@ EAPI Eina_List *elm_theme_name_available_list_new(void);
* elm_theme_name_available_list_new(). Once freed the list should no longer * elm_theme_name_available_list_new(). Once freed the list should no longer
* be used. a new list mys be created. * be used. a new list mys be created.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_theme_name_available_list_free(Eina_List *list); EAPI void elm_theme_name_available_list_free(Eina_List *list);
@ -468,7 +468,7 @@ EAPI void elm_theme_name_available_list_free(Eina_List *list);
* configuration difficult. Avoid any custom themes at all if it can be * configuration difficult. Avoid any custom themes at all if it can be
* helped. * helped.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th); EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
@ -483,7 +483,7 @@ EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
* the specific theme set for that specific object. See elm_object_theme_set() * the specific theme set for that specific object. See elm_object_theme_set()
* for more information. * for more information.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj); EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
@ -497,7 +497,7 @@ EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
* This function is used to return data items from edc in @p th, an overlay, or an extension. * This function is used to return data items from edc in @p th, an overlay, or an extension.
* It works the same way as edje_file_data_get() except that the return is stringshared. * It works the same way as edje_file_data_get() except that the return is stringshared.
* *
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key); EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key);
@ -521,7 +521,7 @@ EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key);
* request. * request.
* *
* @since 1.8 * @since 1.8
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group); EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
@ -543,7 +543,7 @@ EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
* may result in a leak. * may result in a leak.
* *
* @since 1.8 * @since 1.8
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI Eina_List *elm_theme_group_base_list(Elm_Theme *th, const char *base); EAPI Eina_List *elm_theme_group_base_list(Elm_Theme *th, const char *base);
@ -558,7 +558,7 @@ EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
* example a theme selector. * example a theme selector.
* *
* @since 1.8 * @since 1.8
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const char *elm_theme_system_dir_get(void); EAPI const char *elm_theme_system_dir_get(void);
@ -576,7 +576,7 @@ EAPI const char *elm_theme_system_dir_get(void);
* directory is normally expected to be writable by the user. * directory is normally expected to be writable by the user.
* *
* @since 1.8 * @since 1.8
* @ingroup Theme * @ingroup Elm_Theme
*/ */
EAPI const char *elm_theme_user_dir_get(void); EAPI const char *elm_theme_user_dir_get(void);

90
legacy/elementary/src/lib/elm_transit.h
View File

@ -1,5 +1,5 @@
/** /**
* @defgroup Transit Transit * @defgroup Elm_Transit Transit
* @ingroup Elementary * @ingroup Elementary
* *
* Transit is designed to apply various animated transition effects to @c * Transit is designed to apply various animated transition effects to @c
@ -160,7 +160,7 @@ typedef void (*Elm_Transit_Del_Cb)(void *data, Elm_Transit *transit);
* *
* @return The transit object. * @return The transit object.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Elm_Transit *elm_transit_add(void); EAPI Elm_Transit *elm_transit_add(void);
@ -177,7 +177,7 @@ EAPI Elm_Transit *elm_transit_add(void);
* *
* @param transit The transit object to be deleted. * @param transit The transit object to be deleted.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_del(Elm_Transit *transit); EAPI void elm_transit_del(Elm_Transit *transit);
@ -209,7 +209,7 @@ EAPI void elm_transit_del(Elm_Transit *transit);
* at the end of the effect, it must finalize the animation and free the * at the end of the effect, it must finalize the animation and free the
* @p data. * @p data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning The transit will free the context data at the and of the * @warning The transit will free the context data at the and of the
* transition with the data_free_cb function. * transition with the data_free_cb function.
* Do not share the context data in between different transit objects. * Do not share the context data in between different transit objects.
@ -232,7 +232,7 @@ EAPI void elm_transit_effect_add(Elm_Transit *transit, Elm_Tra
* @param transition_cb The operation function. * @param transition_cb The operation function.
* @param effect The context data of the effect. * @param effect The context data of the effect.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect); EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect);
@ -253,7 +253,7 @@ EAPI void elm_transit_effect_del(Elm_Transit *transit, Elm_Tra
* @param transit The transit object. * @param transit The transit object.
* @param obj Object to be animated. * @param obj Object to be animated.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is not allowed to add a new object after transit begins. * @warning It is not allowed to add a new object after transit begins.
*/ */
EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj); EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj);
@ -268,7 +268,7 @@ EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Ob
* @param transit The transit object. * @param transit The transit object.
* @param obj Object to be removed from @p transit. * @param obj Object to be removed from @p transit.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is not allowed to remove objects after transit begins. * @warning It is not allowed to remove objects after transit begins.
*/ */
EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj); EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj);
@ -279,7 +279,7 @@ EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas
* @param transit The transit object. * @param transit The transit object.
* @return a Eina_List with the objects from the transit. * @return a Eina_List with the objects from the transit.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit); EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit);
@ -293,7 +293,7 @@ EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit);
* @param transit The transit object. * @param transit The transit object.
* @param state_keep retain the state or not. * @param state_keep retain the state or not.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep); EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep);
@ -308,7 +308,7 @@ EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit
* @return @c EINA_TRUE means the states of the objects will be reset. * @return @c EINA_TRUE means the states of the objects will be reset.
* If @p transit is NULL, @c EINA_FALSE is returned * If @p transit is NULL, @c EINA_FALSE is returned
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit); EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit);
@ -327,7 +327,7 @@ EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_T
* @param enabled Events are received when enabled is @c EINA_TRUE, and * @param enabled Events are received when enabled is @c EINA_TRUE, and
* ignored otherwise. * ignored otherwise.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled); EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled);
@ -340,7 +340,7 @@ EAPI void elm_transit_event_enabled_set(Elm_Transit *transit,
* @return @c EINA_TRUE, when event is enabled. If @p transit is NULL * @return @c EINA_TRUE, when event is enabled. If @p transit is NULL
* @c EINA_FALSE is returned * @c EINA_FALSE is returned
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit); EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit);
@ -355,7 +355,7 @@ EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *tra
* the deletion of the transit. * the deletion of the transit.
* @param data Callback function user data. It is the @p op parameter. * @param data Callback function user data. It is the @p op parameter.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data); EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data);
@ -371,7 +371,7 @@ EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Tra
* @param transit The transit object. * @param transit The transit object.
* @param reverse @c EINA_TRUE means the auto_reverse is on. * @param reverse @c EINA_TRUE means the auto_reverse is on.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse); EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse);
@ -384,7 +384,7 @@ EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, E
* @return @c EINA_TRUE means auto reverse is on. If @p transit is NULL * @return @c EINA_TRUE means auto reverse is on. If @p transit is NULL
* @c EINA_FALSE is returned * @c EINA_FALSE is returned
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit); EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit);
@ -401,7 +401,7 @@ EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *tran
* @param transit The transit object * @param transit The transit object
* @param repeat Repeat count * @param repeat Repeat count
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat); EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat);
@ -414,7 +414,7 @@ EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, i
* @return The repeat count. If @p transit is NULL * @return The repeat count. If @p transit is NULL
* 0 is returned * 0 is returned
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit); EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit);
@ -439,7 +439,7 @@ EAPI int elm_transit_repeat_times_get(const Elm_Transit *tran
* @param transit The transit object. * @param transit The transit object.
* @param tween_mode The tween type. * @param tween_mode The tween type.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode); EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode);
@ -452,7 +452,7 @@ EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm
* @return The tween type. If @p transit is NULL * @return The tween type. If @p transit is NULL
* ELM_TRANSIT_TWEEN_MODE_LINEAR is returned. * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit); EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit);
@ -486,7 +486,7 @@ EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transi
* *
* @see elm_transit_tween_mode_factor_get() * @see elm_transit_tween_mode_factor_get()
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_tween_mode_factor_set(Elm_Transit *transit, double v1, double v2); EAPI void elm_transit_tween_mode_factor_set(Elm_Transit *transit, double v1, double v2);
@ -501,7 +501,7 @@ EAPI void elm_transit_tween_mode_factor_set(Elm_Transit *trans
* *
* @see elm_transit_tween_mode_factor_set() * @see elm_transit_tween_mode_factor_set()
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_tween_mode_factor_get(const Elm_Transit *transit, double *v1, double *v2); EAPI void elm_transit_tween_mode_factor_get(const Elm_Transit *transit, double *v1, double *v2);
@ -537,7 +537,7 @@ EAPI void elm_transit_tween_mode_factor_get(const Elm_Transit
* *
* @see elm_transit_tween_mode_factor_set() * @see elm_transit_tween_mode_factor_set()
* @since 1.13 * @since 1.13
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_tween_mode_factor_n_set(Elm_Transit *transit, unsigned int v_size, double *v); EAPI void elm_transit_tween_mode_factor_n_set(Elm_Transit *transit, unsigned int v_size, double *v);
@ -549,7 +549,7 @@ EAPI void elm_transit_tween_mode_factor_n_set(Elm_Transit *tra
* @param transit The transit object. * @param transit The transit object.
* @param duration The animation time. * @param duration The animation time.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration); EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration);
@ -562,7 +562,7 @@ EAPI void elm_transit_duration_set(Elm_Transit *transit, doubl
* *
* @return The transit animation time. * @return The transit animation time.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI double elm_transit_duration_get(const Elm_Transit *transit); EAPI double elm_transit_duration_get(const Elm_Transit *transit);
@ -574,7 +574,7 @@ EAPI double elm_transit_duration_get(const Elm_Transit *transit)
* *
* @param transit The transit object. * @param transit The transit object.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_go(Elm_Transit *transit); EAPI void elm_transit_go(Elm_Transit *transit);
@ -594,7 +594,7 @@ EAPI void elm_transit_go(Elm_Transit *transit);
* @return @c EINA_TRUE if transition is reverted, @c EINA_FALSE otherwise. * @return @c EINA_TRUE if transition is reverted, @c EINA_FALSE otherwise.
* *
* @since 1.18 * @since 1.18
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Eina_Bool elm_transit_revert(Elm_Transit *transit); EAPI Eina_Bool elm_transit_revert(Elm_Transit *transit);
@ -607,7 +607,7 @@ EAPI Eina_Bool elm_transit_revert(Elm_Transit *transit);
* @param in The interval value in seconds * @param in The interval value in seconds
* *
* @since 1.14 * @since 1.14
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_go_in(Elm_Transit *transit, double in); EAPI void elm_transit_go_in(Elm_Transit *transit, double in);
@ -622,7 +622,7 @@ EAPI void elm_transit_go_in(Elm_Transit *transit, double in);
* @param transit The transit object. * @param transit The transit object.
* @param paused Whether the transition should be paused or not. * @param paused Whether the transition should be paused or not.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused); EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused);
@ -637,7 +637,7 @@ EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bo
* @return @c EINA_TRUE means transition is paused. If @p transit is NULL * @return @c EINA_TRUE means transition is paused. If @p transit is NULL
* @c EINA_FALSE is returned * @c EINA_FALSE is returned
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit); EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit);
@ -654,7 +654,7 @@ EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit);
* @return The time progression value. If @p transit is NULL * @return The time progression value. If @p transit is NULL
* 0 is returned * 0 is returned
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI double elm_transit_progress_value_get(const Elm_Transit *transit); EAPI double elm_transit_progress_value_get(const Elm_Transit *transit);
@ -672,7 +672,7 @@ EAPI double elm_transit_progress_value_get(const Elm_Transit *tr
* transit, and will be started as soon as @p transit ends. See @ref * transit, and will be started as soon as @p transit ends. See @ref
* transit_example_02_explained for a full example. * transit_example_02_explained for a full example.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit); EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit);
@ -687,7 +687,7 @@ EAPI void elm_transit_chain_transit_add(Elm_Transit *transit,
* *
* This function remove the @p chain_transit transition from the @p transit. * This function remove the @p chain_transit transition from the @p transit.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit); EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit);
@ -699,7 +699,7 @@ EAPI void elm_transit_chain_transit_del(Elm_Transit *transit,
* @param transit The transit object. * @param transit The transit object.
* @return chain transit list. * @return chain transit list.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit); EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
@ -717,7 +717,7 @@ EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *tr
* @see evas_map_smooth_set() * @see evas_map_smooth_set()
* @since 1.8 * @since 1.8
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool enabled); EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool enabled);
@ -750,7 +750,7 @@ EAPI Eina_Bool elm_transit_smooth_get(const Elm_Transit *transit);
* @param to_h Object height size when effect ends. * @param to_h Object height size when effect ends.
* @return Resizing effect context data. * @return Resizing effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Elm_Transit_Effect *elm_transit_effect_resizing_add(Elm_Transit *transit, Evas_Coord from_w, Evas_Coord from_h, Evas_Coord to_w, Evas_Coord to_h); EAPI Elm_Transit_Effect *elm_transit_effect_resizing_add(Elm_Transit *transit, Evas_Coord from_w, Evas_Coord from_h, Evas_Coord to_w, Evas_Coord to_h);
@ -769,7 +769,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_resizing_add(Elm_Transit *transit
* @param to_dy Y Position variation when effect ends. * @param to_dy Y Position variation when effect ends.
* @return Translation effect context data. * @return Translation effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects, * This is because this effect needs the geometry information about the objects,
@ -790,7 +790,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_translation_add(Elm_Transit *tran
* @param to_rate Scale rate when effect ends. * @param to_rate Scale rate when effect ends.
* @return Zoom effect context data. * @return Zoom effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects, * This is because this effect needs the geometry information about the objects,
@ -814,7 +814,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, fl
* @param cw Flipping Direction. @c EINA_TRUE is clock-wise. * @param cw Flipping Direction. @c EINA_TRUE is clock-wise.
* @return Flip effect context data. * @return Flip effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects, * This is because this effect needs the geometry information about the objects,
@ -838,7 +838,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, El
* @param cw Flipping Direction. @c EINA_TRUE is clock-wise. * @param cw Flipping Direction. @c EINA_TRUE is clock-wise.
* @return Resizeable flip effect context data. * @return Resizeable flip effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects, * This is because this effect needs the geometry information about the objects,
@ -859,7 +859,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *t
* @param dir Wipe Direction. * @param dir Wipe Direction.
* @return Wipe effect context data. * @return Wipe effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects, * This is because this effect needs the geometry information about the objects,
@ -886,7 +886,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, El
* @param to_a RGB A when effect ends. * @param to_a RGB A when effect ends.
* @return Color effect context data. * @return Color effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Elm_Transit_Effect *elm_transit_effect_color_add(Elm_Transit *transit, unsigned int from_r, unsigned int from_g, unsigned int from_b, unsigned int from_a, unsigned int to_r, unsigned int to_g, unsigned int to_b, unsigned int to_a); EAPI Elm_Transit_Effect *elm_transit_effect_color_add(Elm_Transit *transit, unsigned int from_r, unsigned int from_g, unsigned int from_b, unsigned int from_a, unsigned int to_r, unsigned int to_g, unsigned int to_b, unsigned int to_a);
@ -904,7 +904,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_color_add(Elm_Transit *transit, u
* @param transit Transit object. * @param transit Transit object.
* @return Fade effect context data. * @return Fade effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the color information about the objects, * This is because this effect needs the color information about the objects,
@ -926,7 +926,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
* @param transit Transit object. * @param transit Transit object.
* @return Blend effect context data. * @return Blend effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the color information about the objects, * This is because this effect needs the color information about the objects,
@ -947,7 +947,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
* @param to_degree Degree when effect is ends. * @param to_degree Degree when effect is ends.
* @return Rotation effect context data. * @return Rotation effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
* @warning It is highly recommended just create a transit with this effect when * @warning It is highly recommended just create a transit with this effect when
* the window that the objects of the transit belongs has already been created. * the window that the objects of the transit belongs has already been created.
* This is because this effect needs the geometry information about the objects, * This is because this effect needs the geometry information about the objects,
@ -987,7 +987,7 @@ EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit
* elm_transit_effect_image_animation_context_free() function. * elm_transit_effect_image_animation_context_free() function.
* @return Image Animation effect context data. * @return Image Animation effect context data.
* *
* @ingroup Transit * @ingroup Elm_Transit
*/ */
EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images); EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
/** /**

2
legacy/elementary/src/lib/els_cursor.c
View File

@ -537,7 +537,7 @@ _elm_cursor_cur_set(Elm_Cursor *cur)
* @param cursor the cursor name to be used. * @param cursor the cursor name to be used.
* *
* @internal * @internal
* @ingroup Cursors * @ingroup Elm_Cursors
*/ */
void void
elm_object_sub_cursor_set(Evas_Object *eventarea, Evas_Object *owner, const char *cursor) elm_object_sub_cursor_set(Evas_Object *eventarea, Evas_Object *owner, const char *cursor)