summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-06-09 12:02:29 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-06-09 12:02:29 +0900
commitbc644f0d9b09d1156f073c22adc6919588331459 (patch)
treead928fcebca45e715b272c2d5ff9e41545b285b2 /src/lib/ecore_evas
parentf2783b4332d501fc4eece5c6d1906f4295e3d559 (diff)
ecore_evas: Document the X11 XShape input region APIs
Reviewers: cedric Subscribers: jpeg Differential Revision: https://phab.enlightenment.org/D4951
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 538abcedb2..84e0cb1ebe 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -2828,11 +2828,86 @@ EAPI Eina_List *ecore_evas_sub_ecore_evas_list_get(const Ecore_Evas *ee);
2828EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win); 2828EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win);
2829EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee); 2829EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee);
2830EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee); 2830EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee);
2831
2832/**
2833 * @brief Set the rectangular region that can "contain" the pointer, replacing
2834 * any previously set region.
2835 *
2836 * @param ee The Ecore_Evas
2837 * @param x The X coordinate for the origin of the input containment rectangle.
2838 * @param y The Y coordinate for the origin of the input containment rectangle.
2839 * @param w The width of the input containment rectangle.
2840 * @param h The height of the input containment rectangle.
2841 *
2842 * Ecore_Evas may apply (orthogonal) rotations if needed, via an internal
2843 * call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that
2844 * ecore_evas_x11_shape_input_apply() must be called to commit the changes
2845 * to the window itself.
2846 */
2831EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int x, int y, int w, int h); 2847EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int x, int y, int w, int h);
2848
2849/**
2850 * @brief Extends the pointer containment region to the union of the new
2851 * and existing input rectangle.
2852 *
2853 * @param ee The Ecore_Evas
2854 * @param x The X coordinate of the rectangular area to add.
2855 * @param y The Y coordinate of the rectangular area to add.
2856 * @param w The width of the rectangluar area to add.
2857 * @param h The height of the rectangluar area to add.
2858 *
2859 * Ecore_Evas may apply (orthogonal) rotations if needed, via an internal
2860 * call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that
2861 * ecore_evas_x11_shape_input_apply() must be called to commit the changes
2862 * to the window itself.
2863 */
2832EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int x, int y, int w, int h); 2864EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int x, int y, int w, int h);
2865
2866/**
2867 * @brief Modifies the pointer containment region to subtract a rectangular region from it.
2868 *
2869 * @param ee The Ecore_Evas
2870 * @param x The X coordinate of the subtraction rectangle.
2871 * @param y The Y coordinate of the subtraction rectangle.
2872 * @param w The width of the subtraction rectangle.
2873 * @param h The height of the subtraction rectangle.
2874 *
2875 * Ecore_Evas may apply (orthogonal) rotations if needed, via an internal
2876 * call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that
2877 * ecore_evas_x11_shape_input_apply() must be called to commit the changes
2878 * to the window itself.
2879 */
2833EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee, int x, int y, int w, int h); 2880EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee, int x, int y, int w, int h);
2881
2882/**
2883 * @brief Disables input for the window.
2884 *
2885 * @param ee The Ecore_Evas
2886 *
2887 * Sets the pointer containment region to a null rectangle, effectively
2888 * disabling input for the window. Note that
2889 * ecore_evas_x11_shape_input_apply() must be called to commit the
2890 * changes to the window itself.
2891 */
2834EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee); 2892EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee);
2893
2894/**
2895 * @brief Unsets the pointer containment for the window.
2896 *
2897 * @param ee The Ecore_Evas
2898 *
2899 * Sets the pointer containment region to a maximally wide and high
2900 * rectangle, effectively permitting all allowed input events to reach
2901 * the window. Note that ecore_evas_x11_shape_input_apply() must be
2902 * called to commit the changes to the window itself.
2903 */
2835EAPI void ecore_evas_x11_shape_input_reset(Ecore_Evas *ee); 2904EAPI void ecore_evas_x11_shape_input_reset(Ecore_Evas *ee);
2905
2906/**
2907 * @brief Applies the pointer containment region to the client window.
2908 *
2909 * @param ee The Ecore_Evas
2910 */
2836EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee); 2911EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
2837 2912
2838#ifdef EFL_BETA_API_SUPPORT 2913#ifdef EFL_BETA_API_SUPPORT