summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-03-09 11:43:33 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2020-03-09 13:03:54 +0100
commit0fbeddfc91fe2f512ce985eb83bf4c9719759da7 (patch)
tree2835339937f69535f6eef6ec29d6edc422ca036b
parentb828343175bdf6c2d80c3046b8ee3deb6bf81af6 (diff)
doxygen docs: Move smart object methods to proper group
Move smart object methods from @ingroup Evas_Canvas to Evas_Smart_Object_Group Also, remove lots of redundant @ingroup Evas_Smart_Object_Group
-rw-r--r--src/lib/evas/Evas_Legacy.h44
1 files changed, 0 insertions, 44 deletions
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 387db2748b..78ca7df9ec 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -6331,8 +6331,6 @@ EAPI void evas_object_polygon_points_clear(Evas_Object *obj);
6331/** Call user-provided @c calculate smart functions and unset the flag 6331/** Call user-provided @c calculate smart functions and unset the flag
6332 * signalling that the object needs to get recalculated to all smart objects in 6332 * signalling that the object needs to get recalculated to all smart objects in
6333 * the canvas. 6333 * the canvas.
6334 *
6335 * @ingroup Evas_Canvas
6336 */ 6334 */
6337EAPI void evas_smart_objects_calculate(Eo *obj); 6335EAPI void evas_smart_objects_calculate(Eo *obj);
6338 6336
@@ -6342,8 +6340,6 @@ EAPI void evas_smart_objects_calculate(Eo *obj);
6342 * @param[in] obj The object. 6340 * @param[in] obj The object.
6343 * 6341 *
6344 * @return @c true if currently calculating smart objects. 6342 * @return @c true if currently calculating smart objects.
6345 *
6346 * @ingroup Evas_Canvas
6347 */ 6343 */
6348EAPI Eina_Bool evas_smart_objects_calculating_get(const Eo *obj); 6344EAPI Eina_Bool evas_smart_objects_calculating_get(const Eo *obj);
6349 6345
@@ -6359,8 +6355,6 @@ EAPI Eina_Bool evas_smart_objects_calculating_get(const Eo *obj);
6359 * canvas. It will take care of setting all of its internals to work 6355 * canvas. It will take care of setting all of its internals to work
6360 * as they should, if the user set things properly, as seem on the 6356 * as they should, if the user set things properly, as seem on the
6361 * #EVAS_SMART_SUBCLASS_NEW, for example. 6357 * #EVAS_SMART_SUBCLASS_NEW, for example.
6362 *
6363 * @ingroup Evas_Smart_Object_Group
6364 */ 6358 */
6365EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_MALLOC; 6359EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_MALLOC;
6366 6360
@@ -6381,8 +6375,6 @@ EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED
6381 * 6375 *
6382 * @see evas_object_smart_member_del() 6376 * @see evas_object_smart_member_del()
6383 * @see evas_object_smart_members_get() 6377 * @see evas_object_smart_members_get()
6384 *
6385 * @ingroup Evas_Smart_Object_Group
6386 */ 6378 */
6387EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *smart_obj) EINA_ARG_NONNULL(1, 2); 6379EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *smart_obj) EINA_ARG_NONNULL(1, 2);
6388 6380
@@ -6390,7 +6382,6 @@ EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *sm
6390 * Removes a member object from a given smart object. 6382 * Removes a member object from a given smart object.
6391 * 6383 *
6392 * @param obj the member object 6384 * @param obj the member object
6393 * @ingroup Evas_Smart_Object_Group
6394 * 6385 *
6395 * This removes a member object from a smart object, if it was added 6386 * This removes a member object from a smart object, if it was added
6396 * to any. The object will still be on the canvas, but no longer 6387 * to any. The object will still be on the canvas, but no longer
@@ -6437,7 +6428,6 @@ EAPI void evas_object_smart_member_del(Evas_Object *obj) EINA_ARG_NONNUL
6437 * @see @ref Evas_Smart_Object_Group_Callbacks for more details. 6428 * @see @ref Evas_Smart_Object_Group_Callbacks for more details.
6438 * 6429 *
6439 * @see evas_object_smart_callback_del() 6430 * @see evas_object_smart_callback_del()
6440 * @ingroup Evas_Smart_Object_Group
6441 */ 6431 */
6442EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3); 6432EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3);
6443 6433
@@ -6454,7 +6444,6 @@ EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *e
6454 * 6444 *
6455 * @see evas_object_smart_callback_add 6445 * @see evas_object_smart_callback_add
6456 * @since 1.1 6446 * @since 1.1
6457 * @ingroup Evas_Smart_Object_Group
6458 */ 6447 */
6459EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, const char *event, Evas_Callback_Priority priority, Evas_Smart_Cb func, const void *data); 6448EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, const char *event, Evas_Callback_Priority priority, Evas_Smart_Cb func, const void *data);
6460 6449
@@ -6476,8 +6465,6 @@ EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, cons
6476 * not successful @c NULL will be returned. 6465 * not successful @c NULL will be returned.
6477 * 6466 *
6478 * @see evas_object_smart_callback_add() for more details. 6467 * @see evas_object_smart_callback_add() for more details.
6479 *
6480 * @ingroup Evas_Smart_Object_Group
6481 */ 6468 */
6482EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3); 6469EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3);
6483 6470
@@ -6502,7 +6489,6 @@ EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *e
6502 * 6489 *
6503 * @see evas_object_smart_callback_add() for more details. 6490 * @see evas_object_smart_callback_add() for more details.
6504 * @since 1.2 6491 * @since 1.2
6505 * @ingroup Evas_Smart_Object_Group
6506 * 6492 *
6507 * @note To delete all smart event callbacks which match @p type and @p func, 6493 * @note To delete all smart event callbacks which match @p type and @p func,
6508 * use evas_object_smart_callback_del(). 6494 * use evas_object_smart_callback_del().
@@ -6527,8 +6513,6 @@ EAPI void *evas_object_smart_callback_del_full(Evas_Object *obj, const ch
6527 * encouraged to properly set the Evas_Smart_Class::callbacks 6513 * encouraged to properly set the Evas_Smart_Class::callbacks
6528 * callbacks description array, so that the users of the smart object 6514 * callbacks description array, so that the users of the smart object
6529 * can have introspection on its events API <b>at run time</b>. 6515 * can have introspection on its events API <b>at run time</b>.
6530 *
6531 * @ingroup Evas_Smart_Object_Group
6532 */ 6516 */
6533EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char *event, void *event_info) EINA_ARG_NONNULL(1, 2); 6517EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char *event, void *event_info) EINA_ARG_NONNULL(1, 2);
6534 6518
@@ -6577,8 +6561,6 @@ EAPI void *evas_object_smart_interface_data_get(const Evas_Object *o
6577 * See also @ref evas_object_smart_type_check_ptr. 6561 * See also @ref evas_object_smart_type_check_ptr.
6578 * 6562 *
6579 * @param[in] type The name (type) of the smart class to check for. 6563 * @param[in] type The name (type) of the smart class to check for.
6580 *
6581 * @ingroup Evas_Object
6582 */ 6564 */
6583EAPI Eina_Bool evas_object_smart_type_check(const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2); 6565EAPI Eina_Bool evas_object_smart_type_check(const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2);
6584 6566
@@ -6590,8 +6572,6 @@ EAPI Eina_Bool evas_object_smart_type_check(const Evas_Object *obj, const char *
6590 * 6572 *
6591 * @return @c true if @c obj or any of its parents is of type @c type, @c false 6573 * @return @c true if @c obj or any of its parents is of type @c type, @c false
6592 * otherwise. 6574 * otherwise.
6593 *
6594 * @ingroup Evas_Object
6595 */ 6575 */
6596EAPI Eina_Bool evas_object_smart_type_check_ptr(const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2); 6576EAPI Eina_Bool evas_object_smart_type_check_ptr(const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2);
6597 6577
@@ -6622,8 +6602,6 @@ EAPI Eina_Bool evas_object_smart_type_check_ptr(const Evas_Object *obj, const ch
6622 * made, so this array should be kept alive during the whole object's lifetime. 6602 * made, so this array should be kept alive during the whole object's lifetime.
6623 * 6603 *
6624 * @return @c true on success, @c false on failure. 6604 * @return @c true on success, @c false on failure.
6625 *
6626 * @ingroup Evas_Object_Smart
6627 */ 6605 */
6628EAPI Eina_Bool evas_object_smart_callbacks_descriptions_set(Evas_Object *obj, const Evas_Smart_Cb_Description *descriptions); 6606EAPI Eina_Bool evas_object_smart_callbacks_descriptions_set(Evas_Object *obj, const Evas_Smart_Cb_Description *descriptions);
6629 6607
@@ -6654,8 +6632,6 @@ EAPI Eina_Bool evas_object_smart_callbacks_descriptions_set(Evas_Object *obj, co
6654 * is returned. 6632 * is returned.
6655 * @param[out] instance_count Returns how many instance callbacks descriptions 6633 * @param[out] instance_count Returns how many instance callbacks descriptions
6656 * are known. 6634 * are known.
6657 *
6658 * @ingroup Evas_Object_Smart
6659 */ 6635 */
6660EAPI void evas_object_smart_callbacks_descriptions_get(const Evas_Object *obj, const Evas_Smart_Cb_Description ***class_descriptions, unsigned int *class_count, const Evas_Smart_Cb_Description ***instance_descriptions, unsigned int *instance_count); 6636EAPI void evas_object_smart_callbacks_descriptions_get(const Evas_Object *obj, const Evas_Smart_Cb_Description ***class_descriptions, unsigned int *class_count, const Evas_Smart_Cb_Description ***instance_descriptions, unsigned int *instance_count);
6661 6637
@@ -6673,8 +6649,6 @@ EAPI void evas_object_smart_callbacks_descriptions_get(const Evas_Object *obj, c
6673 * if not found. If parameter is @c null, no search will be done on class 6649 * if not found. If parameter is @c null, no search will be done on class
6674 * descriptions. 6650 * descriptions.
6675 * @param[out] instance_description pointer to return instance description. 6651 * @param[out] instance_description pointer to return instance description.
6676 *
6677 * @ingroup Evas_Object_Smart
6678 */ 6652 */
6679EAPI void evas_object_smart_callback_description_find(const Evas_Object *obj, const char *name, const Evas_Smart_Cb_Description **class_description, const Evas_Smart_Cb_Description **instance_description) EINA_ARG_NONNULL(2); 6653EAPI void evas_object_smart_callback_description_find(const Evas_Object *obj, const char *name, const Evas_Smart_Cb_Description **class_description, const Evas_Smart_Cb_Description **instance_description) EINA_ARG_NONNULL(2);
6680 6654
@@ -6694,8 +6668,6 @@ EAPI Evas_Smart *evas_object_smart_smart_get(const Evas_Object *obj) EINA_WARN_U
6694 * See also @ref evas_object_smart_data_get. 6668 * See also @ref evas_object_smart_data_get.
6695 * 6669 *
6696 * @param[in] data A pointer to user data. 6670 * @param[in] data A pointer to user data.
6697 *
6698 * @ingroup Evas_Object_Smart
6699 */ 6671 */
6700EAPI void evas_object_smart_data_set(Evas_Object *obj, void *data); 6672EAPI void evas_object_smart_data_set(Evas_Object *obj, void *data);
6701EAPI void *evas_object_smart_data_get(const Evas_Object *obj); 6673EAPI void *evas_object_smart_data_get(const Evas_Object *obj);
@@ -6705,8 +6677,6 @@ EAPI void *evas_object_smart_data_get(const Evas_Object *obj);
6705 * 6677 *
6706 * Use this function if you want to change any of this clipper's properties, 6678 * Use this function if you want to change any of this clipper's properties,
6707 * like colors. 6679 * like colors.
6708 *
6709 * @ingroup Evas_Object_Smart
6710 */ 6680 */
6711EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; 6681EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
6712 6682
@@ -6725,8 +6695,6 @@ EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Object *obj)
6725 * @return Returns the list of the member objects of @c obj. 6695 * @return Returns the list of the member objects of @c obj.
6726 * 6696 *
6727 * @since 1.7 6697 * @since 1.7
6728 *
6729 * @ingroup Evas_Object_Smart
6730 */ 6698 */
6731EAPI Eina_List *evas_object_smart_members_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; 6699EAPI Eina_List *evas_object_smart_members_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
6732 6700
@@ -6751,8 +6719,6 @@ EAPI Eina_List *evas_object_smart_members_get(const Evas_Object *obj) EINA_WARN_
6751 * 6719 *
6752 * @param[in] value whether one wants to set ($true) or to unset ($false) the 6720 * @param[in] value whether one wants to set ($true) or to unset ($false) the
6753 * flag. 6721 * flag.
6754 *
6755 * @ingroup Evas_Object_Smart
6756 */ 6722 */
6757EAPI void evas_object_smart_need_recalculate_set(Evas_Object *obj, Eina_Bool value); 6723EAPI void evas_object_smart_need_recalculate_set(Evas_Object *obj, Eina_Bool value);
6758 6724
@@ -6767,8 +6733,6 @@ EAPI void evas_object_smart_need_recalculate_set(Evas_Object *obj, Eina_Bool val
6767 * See also @ref evas_object_smart_need_recalculate_set, for more details. 6733 * See also @ref evas_object_smart_need_recalculate_set, for more details.
6768 * 6734 *
6769 * @return whether one wants to set ($true) or to unset ($false) the flag. 6735 * @return whether one wants to set ($true) or to unset ($false) the flag.
6770 *
6771 * @ingroup Evas_Object_Smart
6772 */ 6736 */
6773EAPI Eina_Bool evas_object_smart_need_recalculate_get(const Evas_Object *obj); 6737EAPI Eina_Bool evas_object_smart_need_recalculate_get(const Evas_Object *obj);
6774 6738
@@ -6782,8 +6746,6 @@ EAPI Eina_Bool evas_object_smart_need_recalculate_get(const Evas_Object *obj);
6782 * @return Returns the iterator of the member objects of @c obj. 6746 * @return Returns the iterator of the member objects of @c obj.
6783 * 6747 *
6784 * @since 1.8 6748 * @since 1.8
6785 *
6786 * @ingroup Evas_Object_Smart
6787 */ 6749 */
6788EAPI Eina_Iterator *evas_object_smart_iterator_new(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; 6750EAPI Eina_Iterator *evas_object_smart_iterator_new(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT;
6789 6751
@@ -6796,8 +6758,6 @@ EAPI Eina_Iterator *evas_object_smart_iterator_new(const Evas_Object *obj) EINA_
6796 * needs recalculation for the next rendering phase. 6758 * needs recalculation for the next rendering phase.
6797 * 6759 *
6798 * See also @ref evas_object_smart_need_recalculate_set 6760 * See also @ref evas_object_smart_need_recalculate_set
6799 *
6800 * @ingroup Evas_Object_Smart
6801 */ 6761 */
6802EAPI void evas_object_smart_calculate(Evas_Object *obj); 6762EAPI void evas_object_smart_calculate(Evas_Object *obj);
6803 6763
@@ -6810,8 +6770,6 @@ EAPI void evas_object_smart_calculate(Evas_Object *obj);
6810 * 6770 *
6811 * See also @ref evas_object_smart_need_recalculate_set and 6771 * See also @ref evas_object_smart_need_recalculate_set and
6812 * @ref evas_object_smart_calculate. 6772 * @ref evas_object_smart_calculate.
6813 *
6814 * @ingroup Evas_Object_Smart
6815 */ 6773 */
6816EAPI void evas_object_smart_changed(Evas_Object *obj); 6774EAPI void evas_object_smart_changed(Evas_Object *obj);
6817 6775
@@ -6829,8 +6787,6 @@ EAPI void evas_object_smart_changed(Evas_Object *obj);
6829 * 6787 *
6830 * @param[in] dx Horizontal offset (delta). 6788 * @param[in] dx Horizontal offset (delta).
6831 * @param[in] dy Vertical offset (delta). 6789 * @param[in] dy Vertical offset (delta).
6832 *
6833 * @ingroup Evas_Object_Smart
6834 */ 6790 */
6835EAPI void evas_object_smart_move_children_relative(Evas_Object *obj, Evas_Coord dx, Evas_Coord dy); 6791EAPI void evas_object_smart_move_children_relative(Evas_Object *obj, Evas_Coord dx, Evas_Coord dy);
6836 6792