summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-04-29 09:08:45 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2020-04-29 09:08:45 +0200
commit933b2e5a2d8a414cf6b7b15b24375922330a74e8 (patch)
treeefa0fccaffca386c210b44712cedc0f03d024069
parent53004b72a50199e57d6fa8492efcff0ea66cc7f3 (diff)
doxygen docs: Add @since tags to EE selection API
This is the first time Ecore_Evas selection API is released so it has earned some @since 1.24 tags. Also, put these methods in their own group.
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h51
1 files changed, 49 insertions, 2 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index e17208aba2..89a9ff843f 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -45,7 +45,7 @@
45 45
46/* FIXME: 46/* FIXME:
47 * to do soon: 47 * to do soon:
48 * - iconfication api needs to work 48 * - iconification api needs to work
49 * - maximization api needs to work 49 * - maximization api needs to work
50 * 50 *
51 * later: 51 * later:
@@ -3667,11 +3667,24 @@ EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee);
3667 */ 3667 */
3668EAPI int ecore_evas_pixmap_depth_get(const Ecore_Evas *ee); 3668EAPI int ecore_evas_pixmap_depth_get(const Ecore_Evas *ee);
3669 3669
3670/** @defgroup Ecore_Evas_Selection_Group Ecore_Evas methods to handle selection
3671 *
3672 * These methods perform Copy&Paste and Drag&Drop operations.
3673 *
3674 * @since 1.24
3675 *
3676 * @{
3677 */
3678
3679/** @brief Data buffer to use in Copy&Paste (and Drag&Drop) operations
3680 *
3681 * @since 1.24
3682 */
3670typedef enum { 3683typedef enum {
3671 ECORE_EVAS_SELECTION_BUFFER_SELECTION_BUFFER = 0, /**< Stores selected / highlighted selection */ 3684 ECORE_EVAS_SELECTION_BUFFER_SELECTION_BUFFER = 0, /**< Stores selected / highlighted selection */
3672 ECORE_EVAS_SELECTION_BUFFER_COPY_AND_PASTE_BUFFER = 1, /**< Stores copied things (Ctrl + C) */ 3685 ECORE_EVAS_SELECTION_BUFFER_COPY_AND_PASTE_BUFFER = 1, /**< Stores copied things (Ctrl + C) */
3673 ECORE_EVAS_SELECTION_BUFFER_DRAG_AND_DROP_BUFFER = 2, /**< Stores dragged things while drag and drop is happening. */ 3686 ECORE_EVAS_SELECTION_BUFFER_DRAG_AND_DROP_BUFFER = 2, /**< Stores dragged things while drag and drop is happening. */
3674 ECORE_EVAS_SELECTION_BUFFER_LAST = 3, 3687 ECORE_EVAS_SELECTION_BUFFER_LAST = 3, /**< Sentinel value. Do not use. */
3675} Ecore_Evas_Selection_Buffer; 3688} Ecore_Evas_Selection_Buffer;
3676 3689
3677/** 3690/**
@@ -3679,6 +3692,8 @@ typedef enum {
3679 * 3692 *
3680 * @param[in] ee The Ecore_Evas that handles this selection. 3693 * @param[in] ee The Ecore_Evas that handles this selection.
3681 * @param[in] selection The selection buffer that has changed. 3694 * @param[in] selection The selection buffer that has changed.
3695 *
3696 * @since 1.24
3682 */ 3697 */
3683typedef void (*Ecore_Evas_Selection_Changed_Cb)(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer selection); 3698typedef void (*Ecore_Evas_Selection_Changed_Cb)(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer selection);
3684 3699
@@ -3695,6 +3710,8 @@ typedef void (*Ecore_Evas_Selection_Changed_Cb)(Ecore_Evas *ee, unsigned int sea
3695 * 3710 *
3696 * @warning If and when this function is called depends on the underlying 3711 * @warning If and when this function is called depends on the underlying
3697 * windowing system. 3712 * windowing system.
3713 *
3714 * @since 1.24
3698 */ 3715 */
3699EAPI void ecore_evas_callback_selection_changed_set(Ecore_Evas *ee, Ecore_Evas_Selection_Changed_Cb cb); 3716EAPI void ecore_evas_callback_selection_changed_set(Ecore_Evas *ee, Ecore_Evas_Selection_Changed_Cb cb);
3700 3717
@@ -3708,6 +3725,8 @@ EAPI void ecore_evas_callback_selection_changed_set(Ecore_Evas *ee, Ecore_Evas_S
3708 * 3725 *
3709 * @note Only ECORE_EVAS_SELECTION_BUFFER_SELECTION_BUFFER and ECORE_EVAS_SELECTION_BUFFER_COPY_AND_PASTE_BUFFER 3726 * @note Only ECORE_EVAS_SELECTION_BUFFER_SELECTION_BUFFER and ECORE_EVAS_SELECTION_BUFFER_COPY_AND_PASTE_BUFFER
3710 * buffers can be set. Drag and drop operations use a different set of methods. 3727 * buffers can be set. Drag and drop operations use a different set of methods.
3728 *
3729 * @since 1.24
3711 */ 3730 */
3712EAPI Eina_Bool ecore_evas_selection_set(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer buffer, Eina_Content *content); 3731EAPI Eina_Bool ecore_evas_selection_set(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer buffer, Eina_Content *content);
3713 3732
@@ -3723,6 +3742,8 @@ EAPI Eina_Bool ecore_evas_selection_set(Ecore_Evas *ee, unsigned int seat, Ecore
3723 * 3742 *
3724 * @note Due to the asynchronous nature of selection buffers, this method might not return 3743 * @note Due to the asynchronous nature of selection buffers, this method might not return
3725 * the right result when invoked from the selection callback set with ecore_evas_callback_selection_changed_set. 3744 * the right result when invoked from the selection callback set with ecore_evas_callback_selection_changed_set.
3745 *
3746 * @since 1.24
3726 */ 3747 */
3727EAPI Eina_Bool ecore_evas_selection_exists(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer buffer); 3748EAPI Eina_Bool ecore_evas_selection_exists(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer buffer);
3728 3749
@@ -3741,6 +3762,8 @@ EAPI Eina_Bool ecore_evas_selection_exists(Ecore_Evas *ee, unsigned int seat, Ec
3741 * 3762 *
3742 * This method is time consuming, therefore, it is recommended to verify the existence of a selection 3763 * This method is time consuming, therefore, it is recommended to verify the existence of a selection
3743 * using ecore_evas_selection_exists before calling it. 3764 * using ecore_evas_selection_exists before calling it.
3765 *
3766 * @since 1.24
3744 */ 3767 */
3745EAPI Eina_Future* ecore_evas_selection_get(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer buffer, Eina_Iterator *acceptable_types); 3768EAPI Eina_Future* ecore_evas_selection_get(Ecore_Evas *ee, unsigned int seat, Ecore_Evas_Selection_Buffer buffer, Eina_Iterator *acceptable_types);
3746 3769
@@ -3753,6 +3776,8 @@ EAPI Eina_Future* ecore_evas_selection_get(Ecore_Evas *ee, unsigned int seat, Ec
3753 * @param[in] inside @c EINA_TRUE if the pointer just entered this window. @c EINA_FALSE if it has just exited. 3776 * @param[in] inside @c EINA_TRUE if the pointer just entered this window. @c EINA_FALSE if it has just exited.
3754 * 3777 *
3755 * Set this callback using ecore_evas_callback_drop_state_changed_set. 3778 * Set this callback using ecore_evas_callback_drop_state_changed_set.
3779 *
3780 * @since 1.24
3756 */ 3781 */
3757typedef void (*Ecore_Evas_Drag_Finished_Cb)(Ecore_Evas *ee, unsigned int seat, void *data, Eina_Bool accepted); 3782typedef void (*Ecore_Evas_Drag_Finished_Cb)(Ecore_Evas *ee, unsigned int seat, void *data, Eina_Bool accepted);
3758 3783
@@ -3773,6 +3798,8 @@ typedef void (*Ecore_Evas_Drag_Finished_Cb)(Ecore_Evas *ee, unsigned int seat, v
3773 * @return @c EINA_TRUE if the drag operation has been successfully started. 3798 * @return @c EINA_TRUE if the drag operation has been successfully started.
3774 * 3799 *
3775 * This method must be called when a drag operation is initiated in order to provide the necessary information. 3800 * This method must be called when a drag operation is initiated in order to provide the necessary information.
3801 *
3802 * @since 1.24
3776 */ 3803 */
3777EAPI Eina_Bool ecore_evas_drag_start(Ecore_Evas *ee, unsigned int seat, Eina_Content *content, Ecore_Evas *drag_rep, 3804EAPI Eina_Bool ecore_evas_drag_start(Ecore_Evas *ee, unsigned int seat, Eina_Content *content, Ecore_Evas *drag_rep,
3778 const char* action, Ecore_Evas_Drag_Finished_Cb terminate_cb, void *data); 3805 const char* action, Ecore_Evas_Drag_Finished_Cb terminate_cb, void *data);
@@ -3784,6 +3811,8 @@ EAPI Eina_Bool ecore_evas_drag_start(Ecore_Evas *ee, unsigned int seat, Eina_Con
3784 * @return @c EINA_TRUE if the drag operation has been successfully cancelled. 3811 * @return @c EINA_TRUE if the drag operation has been successfully cancelled.
3785 * 3812 *
3786 * The initiator of a drag operation can call this method to abort it. 3813 * The initiator of a drag operation can call this method to abort it.
3814 *
3815 * @since 1.24
3787 */ 3816 */
3788EAPI Eina_Bool ecore_evas_drag_cancel(Ecore_Evas *ee, unsigned int seat); 3817EAPI Eina_Bool ecore_evas_drag_cancel(Ecore_Evas *ee, unsigned int seat);
3789 3818
@@ -3796,6 +3825,8 @@ EAPI Eina_Bool ecore_evas_drag_cancel(Ecore_Evas *ee, unsigned int seat);
3796 * @param[in] inside @c EINA_TRUE if the pointer just entered this window. @c EINA_FALSE if it has just exited. 3825 * @param[in] inside @c EINA_TRUE if the pointer just entered this window. @c EINA_FALSE if it has just exited.
3797 * 3826 *
3798 * Set this callback using ecore_evas_callback_drop_state_changed_set. 3827 * Set this callback using ecore_evas_callback_drop_state_changed_set.
3828 *
3829 * @since 1.24
3799 */ 3830 */
3800typedef void (*Ecore_Evas_Drag_State_Changed_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p, Eina_Bool inside); 3831typedef void (*Ecore_Evas_Drag_State_Changed_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p, Eina_Bool inside);
3801 3832
@@ -3808,6 +3839,8 @@ typedef void (*Ecore_Evas_Drag_State_Changed_Cb)(Ecore_Evas *ee, unsigned int se
3808 * 3839 *
3809 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple 3840 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple
3810 * times overwrites previous functions. Use a NULL @p cb func to stop being notified. 3841 * times overwrites previous functions. Use a NULL @p cb func to stop being notified.
3842 *
3843 * @since 1.24
3811 */ 3844 */
3812EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_Drag_State_Changed_Cb cb); 3845EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_Drag_State_Changed_Cb cb);
3813 3846
@@ -3819,6 +3852,8 @@ EAPI void ecore_evas_callback_drop_state_changed_set(Ecore_Evas *ee, Ecore_Evas_
3819 * @param[in] p Position (in window coordinates) where the event occurred. 3852 * @param[in] p Position (in window coordinates) where the event occurred.
3820 * 3853 *
3821 * Set this callback using ecore_evas_callback_drop_motion_set. 3854 * Set this callback using ecore_evas_callback_drop_motion_set.
3855 *
3856 * @since 1.24
3822 */ 3857 */
3823 3858
3824typedef void (*Ecore_Evas_Drag_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p); 3859typedef void (*Ecore_Evas_Drag_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p);
@@ -3831,6 +3866,8 @@ typedef void (*Ecore_Evas_Drag_Motion_Cb)(Ecore_Evas *ee, unsigned int seat, Ein
3831 * 3866 *
3832 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple 3867 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple
3833 * times overwrites previous functions. Use a NULL @p cb func to stop being notified. 3868 * times overwrites previous functions. Use a NULL @p cb func to stop being notified.
3869 *
3870 * @since 1.24
3834 */ 3871 */
3835EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Motion_Cb cb); 3872EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Motion_Cb cb);
3836 3873
@@ -3845,6 +3882,8 @@ EAPI void ecore_evas_callback_drop_motion_set(Ecore_Evas *ee, Ecore_Evas_Drag_Mo
3845 * ECORE_EVAS_SELECTION_BUFFER_DRAG_AND_DROP_BUFFER buffer. 3882 * ECORE_EVAS_SELECTION_BUFFER_DRAG_AND_DROP_BUFFER buffer.
3846 * 3883 *
3847 * Set this callback using ecore_evas_callback_drop_drop_set. 3884 * Set this callback using ecore_evas_callback_drop_drop_set.
3885 *
3886 * @since 1.24
3848 */ 3887 */
3849typedef void (*Ecore_Evas_Drop_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p, const char *action); 3888typedef void (*Ecore_Evas_Drop_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Position2D p, const char *action);
3850 3889
@@ -3857,6 +3896,8 @@ typedef void (*Ecore_Evas_Drop_Cb)(Ecore_Evas *ee, unsigned int seat, Eina_Posit
3857 * 3896 *
3858 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple 3897 * Only one such callback can exist for each Ecore_Evas. Calling this method multiple
3859 * times overwrites previous functions. Use a NULL @p cb func to stop being notified. 3898 * times overwrites previous functions. Use a NULL @p cb func to stop being notified.
3899 *
3900 * @since 1.24
3860 */ 3901 */
3861EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb cb); 3902EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb cb);
3862 3903
@@ -3873,6 +3914,8 @@ EAPI void ecore_evas_callback_drop_drop_set(Ecore_Evas *ee, Ecore_Evas_Drop_Cb c
3873 * This is functionally equivalent to calling ecore_evas_selection_get and examining the available types in the 3914 * This is functionally equivalent to calling ecore_evas_selection_get and examining the available types in the
3874 * returned Eina_Content, but much faster since the actual data does not have to be asynchronously requested to the 3915 * returned Eina_Content, but much faster since the actual data does not have to be asynchronously requested to the
3875 * initiator application. 3916 * initiator application.
3917 *
3918 * @since 1.24
3876 */ 3919 */
3877EAPI Eina_Accessor* ecore_evas_drop_available_types_get(Ecore_Evas *ee, unsigned int seat); 3920EAPI Eina_Accessor* ecore_evas_drop_available_types_get(Ecore_Evas *ee, unsigned int seat);
3878 3921
@@ -3880,6 +3923,10 @@ EAPI Eina_Accessor* ecore_evas_drop_available_types_get(Ecore_Evas *ee, unsigned
3880 * @} 3923 * @}
3881 */ 3924 */
3882 3925
3926/**
3927 * @}
3928 */
3929
3883#ifdef __cplusplus 3930#ifdef __cplusplus
3884} 3931}
3885#endif 3932#endif