kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doxygen docs: Put Evas_Canvas legacy methods in the right group 

"Evas_Group" does not exist, and "Evas" is a top-level group without content
(only subgroups). So I guess all these methods belong to the "Evas_Canvas" group.
This brings even more docs into existence, fixing multiple missing references.
This commit is contained in:
Xavi Artigas 2020-04-27 15:54:10 +02:00
parent bbba18d406
commit 0aa18d93ca
1 changed files with 65 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
src/lib/evas/canvas/evas_canvas_eo.legacy.h
View File

@ -22,7 +22,7 @@ typedef Eo Evas_Canvas;
* @param[in] obj The object.
* @param[in] size The cache size.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_image_cache_set(Evas_Canvas *obj, int size);
@ -35,7 +35,7 @@ EAPI void evas_image_cache_set(Evas_Canvas *obj, int size);
*
* @return The cache size.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_image_cache_get(const Evas_Canvas *obj);
@ -51,7 +51,7 @@ EAPI int evas_image_cache_get(const Evas_Canvas *obj);
*
* @since 1.2
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_event_default_flags_set(Evas_Canvas *obj, Evas_Event_Flags flags);
@ -66,7 +66,7 @@ EAPI void evas_event_default_flags_set(Evas_Canvas *obj, Evas_Event_Flags flags)
*
* @since 1.2
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Evas_Event_Flags evas_event_default_flags_get(const Evas_Canvas *obj);
@ -76,7 +76,7 @@ EAPI Evas_Event_Flags evas_event_default_flags_get(const Evas_Canvas *obj);
* @param[in] obj The object.
* @param[in] size The size in bytes.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_font_cache_set(Evas_Canvas *obj, int size);
@ -87,7 +87,7 @@ EAPI void evas_font_cache_set(Evas_Canvas *obj, int size);
*
* @return The size in bytes.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_font_cache_get(const Evas_Canvas *obj);
@ -97,7 +97,7 @@ EAPI int evas_font_cache_get(const Evas_Canvas *obj);
* @param[in] obj The object.
* @param[in] data The attached pointer.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_data_attach_set(Evas_Canvas *obj, void *data);
@ -108,7 +108,7 @@ EAPI void evas_data_attach_set(Evas_Canvas *obj, void *data);
*
* @return The attached pointer.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void *evas_data_attach_get(const Evas_Canvas *obj);
@ -136,7 +136,7 @@ EAPI void *evas_data_attach_get(const Evas_Canvas *obj);
*
* @return The object that has focus or @c null if there is not one.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Efl_Canvas_Object *evas_focus_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -152,7 +152,7 @@ EAPI Efl_Canvas_Object *evas_focus_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Efl_Canvas_Object *evas_seat_focus_get(const Evas_Canvas *obj, Evas_Device *seat);
@ -172,7 +172,7 @@ EAPI Efl_Canvas_Object *evas_seat_focus_get(const Evas_Canvas *obj, Evas_Device
*
* @return A pointer to the highest object on it (if any) or @c null otherwise.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Efl_Canvas_Object *evas_object_top_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -186,7 +186,7 @@ EAPI Efl_Canvas_Object *evas_object_top_get(const Evas_Canvas *obj) EINA_WARN_UN
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_pointer_canvas_xy_by_device_get(const Evas_Canvas *obj, Evas_Device *dev, int *x, int *y);
@ -202,7 +202,7 @@ EAPI void evas_pointer_canvas_xy_by_device_get(const Evas_Canvas *obj, Evas_Devi
* @param[out] x The pointer to a Evas_Coord to be filled in.
* @param[out] y The pointer to a Evas_Coord to be filled in.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_pointer_canvas_xy_get(const Evas_Canvas *obj, int *x, int *y);
@ -215,7 +215,7 @@ EAPI void evas_pointer_canvas_xy_get(const Evas_Canvas *obj, int *x, int *y);
*
* @since 1.2
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_event_down_count_get(const Evas_Canvas *obj);
@ -237,7 +237,7 @@ EAPI int evas_event_down_count_get(const Evas_Canvas *obj);
*
* @since 1.1
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_smart_objects_calculate_count_get(const Evas_Canvas *obj);
@ -248,7 +248,7 @@ EAPI int evas_smart_objects_calculate_count_get(const Evas_Canvas *obj);
*
* @return @c true if focused, @c false otherwise
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_Bool evas_focus_state_get(const Evas_Canvas *obj);
@ -261,7 +261,7 @@ EAPI Eina_Bool evas_focus_state_get(const Evas_Canvas *obj);
*
* @return @c true if the seat has the canvas focus, @c false otherwise.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_Bool evas_seat_focus_state_get(const Evas_Canvas *obj, Evas_Device *seat);
@ -274,7 +274,7 @@ EAPI Eina_Bool evas_seat_focus_state_get(const Evas_Canvas *obj, Evas_Device *se
*
* @since 1.11
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_Bool evas_changed_get(const Evas_Canvas *obj);
@ -288,7 +288,7 @@ EAPI Eina_Bool evas_changed_get(const Evas_Canvas *obj);
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_pointer_output_xy_by_device_get(const Evas_Canvas *obj, Evas_Device *dev, int *x, int *y);
@ -304,7 +304,7 @@ EAPI void evas_pointer_output_xy_by_device_get(const Evas_Canvas *obj, Evas_Devi
* @param[out] x The pointer to an integer to be filled in.
* @param[out] y The pointer to an integer to be filled in.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_pointer_output_xy_get(const Evas_Canvas *obj, int *x, int *y);
@ -324,7 +324,7 @@ EAPI void evas_pointer_output_xy_get(const Evas_Canvas *obj, int *x, int *y);
*
* @return A pointer to the lowest object on it, if any, or @c null otherwise.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Efl_Canvas_Object *evas_object_bottom_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -336,7 +336,7 @@ EAPI Efl_Canvas_Object *evas_object_bottom_get(const Evas_Canvas *obj) EINA_WARN
*
* @return A bitmask of the currently depressed buttons on the canvas.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI unsigned int evas_pointer_button_down_mask_by_device_get(const Evas_Canvas *obj, Evas_Device *dev);
@ -362,7 +362,7 @@ EAPI unsigned int evas_pointer_button_down_mask_by_device_get(const Evas_Canvas
*
* @return A bitmask of the currently depressed buttons on the canvas.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI unsigned int evas_pointer_button_down_mask_get(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -382,7 +382,7 @@ EAPI unsigned int evas_pointer_button_down_mask_get(const Evas_Canvas *obj) EINA
*
* @return List of objects
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_List *evas_tree_objects_at_xy_get(Evas_Canvas *obj, Efl_Canvas_Object *stop, int x, int y) EINA_WARN_UNUSED_RESULT;
@ -400,7 +400,7 @@ EAPI Eina_List *evas_tree_objects_at_xy_get(Evas_Canvas *obj, Efl_Canvas_Object
* @param[in] obj The object.
* @param[in] keyname The name of the lock to enable.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_lock_on(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -422,7 +422,7 @@ EAPI void evas_key_lock_on(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNU
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_seat_key_lock_on(Evas_Canvas *obj, const char *keyname, Evas_Device *seat) EINA_ARG_NONNULL(2);
@ -443,7 +443,7 @@ EAPI void evas_seat_key_lock_on(Evas_Canvas *obj, const char *keyname, Evas_Devi
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_seat_key_lock_off(Evas_Canvas *obj, const char *keyname, Evas_Device *seat) EINA_ARG_NONNULL(2);
@ -469,7 +469,7 @@ EAPI void evas_seat_key_lock_off(Evas_Canvas *obj, const char *keyname, Evas_Dev
* @param[in] keyname The name of the modifier key to add to the list of Evas
* modifiers.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_modifier_add(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -485,7 +485,7 @@ EAPI void evas_key_modifier_add(Evas_Canvas *obj, const char *keyname) EINA_ARG_
* @param[in] obj The object.
* @param[in] keyname The name of the modifier to disable.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_modifier_off(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -510,13 +510,13 @@ EAPI void evas_key_modifier_off(Evas_Canvas *obj, const char *keyname) EINA_ARG_
*
* @since 1.8
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_Bool evas_render_async(Evas_Canvas *obj);
/** Inform the evas that it lost the focus from the default seat.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_focus_out(Evas_Canvas *obj);
@ -529,7 +529,7 @@ EAPI void evas_focus_out(Evas_Canvas *obj);
* used.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_norender(Evas_Canvas *obj);
@ -544,7 +544,7 @@ EAPI void evas_norender(Evas_Canvas *obj);
*
* @since 1.24
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_norender_with_updates(Eo *eo_e);
@ -558,7 +558,7 @@ EAPI void evas_norender_with_updates(Eo *eo_e);
* with "changed" state.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_nochange_pop(Evas_Canvas *obj);
@ -575,7 +575,7 @@ EAPI void evas_nochange_pop(Evas_Canvas *obj);
* @param[in] obj The object.
* @param[in] keyname The name of the lock to disable.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_lock_off(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -589,13 +589,13 @@ EAPI void evas_key_lock_off(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONN
* with "changed" state.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_nochange_push(Evas_Canvas *obj);
/** Force the given evas and associated engine to flush its font cache.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_font_cache_flush(Evas_Canvas *obj);
@ -612,7 +612,7 @@ EAPI void evas_font_cache_flush(Evas_Canvas *obj);
* @param[in] obj The object.
* @param[in] keyname The name of the modifier to enable.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_modifier_on(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -633,7 +633,7 @@ EAPI void evas_key_modifier_on(Evas_Canvas *obj, const char *keyname) EINA_ARG_N
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_seat_key_modifier_on(Evas_Canvas *obj, const char *keyname, Evas_Device *seat) EINA_ARG_NONNULL(2);
@ -653,7 +653,7 @@ EAPI void evas_seat_key_modifier_on(Evas_Canvas *obj, const char *keyname, Evas_
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_seat_key_modifier_off(Evas_Canvas *obj, const char *keyname, Evas_Device *seat) EINA_ARG_NONNULL(2);
@ -669,7 +669,7 @@ EAPI void evas_seat_key_modifier_off(Evas_Canvas *obj, const char *keyname, Evas
* @return A newly allocated list of strings. Do not change the strings. Be
* sure to call @ref evas_font_available_list_free after you're done.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_List *evas_font_available_list(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -687,7 +687,7 @@ EAPI Eina_List *evas_font_available_list(const Evas_Canvas *obj) EINA_WARN_UNUSE
* @return If successful, the Evas object with the given name. Otherwise,
* @c null.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Efl_Canvas_Object *evas_object_name_find(const Evas_Canvas *obj, const char *name) EINA_WARN_UNUSED_RESULT;
@ -697,13 +697,13 @@ EAPI Efl_Canvas_Object *evas_object_name_find(const Evas_Canvas *obj, const char
* @param[in] obj The object.
* @param[in] path The new font path.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_font_path_append(Evas_Canvas *obj, const char *path) EINA_ARG_NONNULL(2);
/** Removes all font paths loaded into memory for the given evas.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_font_path_clear(Evas_Canvas *obj);
@ -715,7 +715,7 @@ EAPI void evas_font_path_clear(Evas_Canvas *obj);
* @param[in] obj The object.
* @param[in] keyname The name of the key to remove from the locks list.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_lock_del(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -734,13 +734,13 @@ EAPI void evas_key_lock_del(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONN
* @param[in] w The rectangle's width.
* @param[in] h The rectangle's height.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_damage_rectangle_add(Evas_Canvas *obj, int x, int y, int w, int h);
/** Sync evas canvas
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_sync(Evas_Canvas *obj);
@ -751,7 +751,7 @@ EAPI void evas_sync(Evas_Canvas *obj);
*
* @return The list of font paths used.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI const Eina_List *evas_font_path_list(const Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -761,7 +761,7 @@ EAPI const Eina_List *evas_font_path_list(const Evas_Canvas *obj) EINA_WARN_UNUS
* This function reloads the image cache of canvas.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_image_cache_reload(Evas_Canvas *obj);
@ -778,7 +778,7 @@ EAPI void evas_image_cache_reload(Evas_Canvas *obj);
*
* @return The output/screen coordinate translated to output coordinates.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_coord_world_x_to_screen(const Evas_Canvas *obj, int x) EINA_WARN_UNUSED_RESULT;
@ -802,7 +802,7 @@ EAPI int evas_coord_world_x_to_screen(const Evas_Canvas *obj, int x) EINA_WARN_U
* @return A newly allocated list of updated rectangles of the canvas
* (@Eina.Rect structs). Free this list with @ref evas_render_updates_free.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Eina_List *evas_render_updates(Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
@ -812,7 +812,7 @@ EAPI Eina_List *evas_render_updates(Evas_Canvas *obj) EINA_WARN_UNUSED_RESULT;
* This function flushes image cache of canvas.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_image_cache_flush(Evas_Canvas *obj);
@ -829,7 +829,7 @@ EAPI void evas_image_cache_flush(Evas_Canvas *obj);
*
* @return The screen coordinate translated to canvas unit coordinates.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_coord_screen_y_to_world(const Evas_Canvas *obj, int y) EINA_WARN_UNUSED_RESULT;
@ -842,13 +842,13 @@ EAPI int evas_coord_screen_y_to_world(const Evas_Canvas *obj, int y) EINA_WARN_U
* @param[in] obj The object.
* @param[in] keyname The name of the key to remove from the modifiers list.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_modifier_del(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
/** Inform to the evas that it got the focus from the default seat.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_focus_in(Evas_Canvas *obj);
@ -891,7 +891,7 @@ EAPI void evas_focus_in(Evas_Canvas *obj);
* @param[in] w The rectangle's width.
* @param[in] h The rectangle's height.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_obscured_rectangle_add(Evas_Canvas *obj, int x, int y, int w, int h);
@ -906,13 +906,13 @@ EAPI void evas_obscured_rectangle_add(Evas_Canvas *obj, int x, int y, int w, int
* too.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_render_dump(Evas_Canvas *obj);
/** Force renderization of the given canvas.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_render(Evas_Canvas *obj);
@ -923,7 +923,7 @@ EAPI void evas_render(Evas_Canvas *obj);
* @param[in] obj The object.
* @param[in] path The new font path.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_font_path_prepend(Evas_Canvas *obj, const char *path) EINA_ARG_NONNULL(2);
@ -943,7 +943,7 @@ EAPI void evas_font_path_prepend(Evas_Canvas *obj, const char *path) EINA_ARG_NO
* "damage" regions yourself (see @ref evas_damage_rectangle_add).
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_obscured_clear(Evas_Canvas *obj);
@ -960,7 +960,7 @@ EAPI void evas_obscured_clear(Evas_Canvas *obj);
*
* @return The screen coordinate translated to canvas unit coordinates.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_coord_screen_x_to_world(const Evas_Canvas *obj, int x) EINA_WARN_UNUSED_RESULT;
@ -986,7 +986,7 @@ EAPI int evas_coord_screen_x_to_world(const Evas_Canvas *obj, int x) EINA_WARN_U
* @param[in] obj The object.
* @param[in] keyname The name of the key to add to the locks list.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_key_lock_add(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONNULL(2);
@ -998,7 +998,7 @@ EAPI void evas_key_lock_add(Evas_Canvas *obj, const char *keyname) EINA_ARG_NONN
* buffers, cached data to avoid re-compute of that data etc.
* @param[in] obj The object.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI void evas_render_idle_flush(Evas_Canvas *obj);
@ -1014,7 +1014,7 @@ EAPI void evas_render_idle_flush(Evas_Canvas *obj);
*
* @since 1.19
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI Evas_Device *evas_default_device_get(const Evas_Canvas *obj, Evas_Device_Class type);
@ -1031,7 +1031,7 @@ EAPI Evas_Device *evas_default_device_get(const Evas_Canvas *obj, Evas_Device_Cl
*
* @return The output/screen coordinate translated to output coordinates.
*
* @ingroup Evas_Group
* @ingroup Evas_Canvas
*/
EAPI int evas_coord_world_y_to_screen(const Evas_Canvas *obj, int y) EINA_WARN_UNUSED_RESULT;