summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@samsung.com>2020-03-13 12:17:03 -0400
committerMike Blumenkrantz <zmike@samsung.com>2020-03-13 12:17:22 -0400
commit7b29d07e420246cf1a9e14ec3949188d077370fb (patch)
treef6ff439426fd44369e3be1eadef18176a8ee0e7c
parent57d6d9bfcedfb45932d8b34a4383257cf6346fcf (diff)
efl/wl: remove old doxygen docs
Summary: these are no longer applicable Depends on D11504 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: segfaultxavi, cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D11505
-rw-r--r--src/lib/efl_canvas_wl/Efl_Canvas_Wl.h198
1 files changed, 1 insertions, 197 deletions
diff --git a/src/lib/efl_canvas_wl/Efl_Canvas_Wl.h b/src/lib/efl_canvas_wl/Efl_Canvas_Wl.h
index 0fae48a3a9..b0c0772ab8 100644
--- a/src/lib/efl_canvas_wl/Efl_Canvas_Wl.h
+++ b/src/lib/efl_canvas_wl/Efl_Canvas_Wl.h
@@ -45,211 +45,15 @@ typedef struct Efl_Canvas_Wl_Xkb_State Efl_Canvas_Wl_Xkb_State;
45#include <efl_canvas_wl_surface.eo.h> 45#include <efl_canvas_wl_surface.eo.h>
46#include <efl_canvas_wl.eo.h> 46#include <efl_canvas_wl.eo.h>
47/** 47/**
48 * @defgroup Efl_Wl_Group EFL Wayland
49 *
50 * A multiseat xdg-shell compliant Wayland compositor in an Evas object.
51 * All toplevel windows will be sized to the size of the compositor object.
52 * @since 1.20
53 * @{
54 */
55#if 0
56/**
57 * Add a compositor widget to the given canvas.
58 *
59 * The following smart callbacks will trigger on the compositor object:
60 * "toplevel_added" - A toplevel surface has been added; event info is Evas_Object *surface @since 1.24
61 * "child_added" - A toplevel surface with a parent has been added; event info is Evas_Object *surface
62 * "popup_added" - A popup surface has been added; event info is Evas_Object *surface
63 * "seat_added" - A compositor seat has been added; event info is Eo *dev
64 *
65 * @param e The canvas
66 * @return The compositor object, @c NULL on failure
67 */
68EAPI Evas_Object *efl_canvas_wl_add(Evas *e);
69
70/**
71 * Run a command in the compositor widget.
72 *
73 * @note If GL is available, the ELM_ACCEL environment variable will be
74 * set to "gl" while executing the command.
75 *
76 * @param obj The compositor widget
77 * @param cmd The command to run
78 * @return The Ecore_Exe from the executed process, @c NULL on failure
79 */
80EAPI Ecore_Exe *efl_canvas_wl_run(Evas_Object *obj, const char *cmd);
81
82/**
83 * Run a command in the compositor widget with specified flags.
84 *
85 * @note If GL is available, the ELM_ACCEL environment variable will be
86 * set to "gl" while executing the command.
87 *
88 * @param obj The compositor widget
89 * @param cmd The command to run
90 * @param flags The flags to use
91 * @return The Ecore_Exe from the executed process, @c NULL on failure
92 */
93Ecore_Exe *efl_canvas_wl_flags_run(Evas_Object *obj, const char *cmd, Ecore_Exe_Flags flags);
94
95/**
96 * Add a process to the list of allowed clients for the compositor widget
97 *
98 * @param obj The compositor widget
99 * @param pid The process to allow
100 * @since 1.21
101 */
102EAPI void efl_canvas_wl_pid_add(Evas_Object *obj, int32_t pid);
103
104/**
105 * Remove a process from the list of allowed clients for the compositor widget
106 *
107 * @param obj The compositor widget
108 * @param pid The process to deny
109 * @since 1.21
110 */
111EAPI void efl_canvas_wl_pid_del(Evas_Object *obj, int32_t pid);
112
113/**
114 * Put the bottom-most toplevel window on top and apply focus to it
115 *
116 * @param obj The compositor widget
117 * @return EINA_TRUE if the window stacking was changed
118 */
119EAPI Eina_Bool efl_canvas_wl_surface_next(Evas_Object *obj);
120
121/**
122 * Put the second top-most toplevel window on top and apply focus to it
123 *
124 * @param obj The compositor widget
125 * @return EINA_TRUE if the window stacking was changed
126 */
127EAPI Eina_Bool efl_canvas_wl_surface_prev(Evas_Object *obj);
128
129/**
130 * Set rotation and flip for the compositor's output
131 *
132 * @param obj The compositor widget
133 * @param rot The rotation to apply
134 * @param rtl If set, the output will apply a flip around the Y axis
135 * @note rtl is equivalent to WL_OUTPUT_TRANSFORM_FLIPPED and rotations are applied
136 * on top
137 */
138EAPI void efl_canvas_wl_rotate(Evas_Object *obj, Efl_Wl_Rotation rot, Eina_Bool rtl);
139
140/**
141 * Set the scale factor for the compositor's output
142 *
143 * @param obj The compositor widget
144 * @param scale The scale factor to set
145 */
146EAPI void efl_canvas_wl_scale_set(Evas_Object *obj, double scale);
147
148/**
149 * Transfer aspect hints from top-most surface onto the efl_canvas_wl object
150 *
151 * @param obj The compositor widget
152 * @param set Whether to enable aspect setting
153 * @since 1.21
154 */
155EAPI void efl_canvas_wl_aspect_set(Evas_Object *obj, Eina_Bool set);
156
157/**
158 * Transfer min/max hints from top-most surface onto the efl_canvas_wl object
159 *
160 * @param obj The compositor widget
161 * @param set Whether to enable min/max setting
162 * @since 1.21
163 */
164EAPI void efl_canvas_wl_minmax_set(Evas_Object *obj, Eina_Bool set);
165
166/**
167 * Add an externally-managed global to the compositor
168 * @note The external implementation is expected to restrict access to authorized
169 * clients
170 * @see wl_global_create() docs
171 *
172 * @param obj The compositor widget
173 * @param interface The Wayland protocol interface struct of the protocol's global
174 * @param version The version of the global to use
175 * @param data User data to use with this interface
176 * @param bind_cb The callback which should be triggered when the global is bound by a client
177 * @return The created global (struct wl_global), or NULL on failure
178 * @since 1.21
179 */
180EAPI void *efl_canvas_wl_global_add(Evas_Object *obj, const void *interface, uint32_t version, void *data, void *bind_cb);
181
182/**
183 * Extract a child surface from the compositor
184 *
185 * An extracted surface can be freely manipulated by external code.
186 * @note size hints must be respected, and the extracted object must not be externally deleted
187 *
188 * @param surface The surface to extract
189 * @return True if the surface was successfully extracted
190 * @since 1.21
191 */
192EAPI Eina_Bool efl_canvas_wl_surface_extract(Evas_Object *surface);
193
194/**
195 * Return the pid for the surface's client
196 *
197 * Get the pid of the underlying client that created the surface.
198 *
199 * @param surface The surface to extract
200 * @return The pid of the surface, or -1 on failure
201 * @since 1.24
202 */
203EAPI int32_t efl_canvas_wl_surface_pid_get(Evas_Object *surface);
204#endif
205/**
206 * Get the Evas_Object for an extracted wl_surface resource created by an efl_canvas_wl object 48 * Get the Evas_Object for an extracted wl_surface resource created by an efl_canvas_wl object
207 * 49 *
208 * @note Passing anything other than a valid wl_surface resource from an efl_canvas_wl object will guarantee a crash. 50 * @note Passing anything other than a valid wl_surface resource from an efl_canvas_wl object will guarantee a crash.
209 * 51 *
210 * @param surface_resource The wl_resource for a wl_surface 52 * @param surface_resource The wl_resource for a wl_surface
211 * @return The Evas_Object of the surface, NULL on failure 53 * @return The Evas_Object of the surface, NULL on failure
212 * @since 1.21 54 * @since 1.24
213 */ 55 */
214EAPI Evas_Object *efl_canvas_wl_extracted_surface_object_find(void *surface_resource); 56EAPI Evas_Object *efl_canvas_wl_extracted_surface_object_find(void *surface_resource);
215#if 0
216/**
217 * Get the Evas_Object for an extracted surface's parent, or NULL if the parent is not extracted
218 *
219 * @note Passing anything other than a valid, extracted surface guarantees a crash.
220 *
221 * @param surface The extracted surface for a wl_surface
222 * @return The Evas_Object of the parent surface, NULL on failure or if there is no parent
223 * @since 1.21
224 */
225EAPI Evas_Object *efl_canvas_wl_extracted_surface_extracted_parent_get(Evas_Object *surface);
226
227/**
228 * Set external xkbcommon resources to be used read-only by the compositor object
229 *
230 * Use this function if you have available the necessary xkbcommon objects which are used
231 * to handle keyboard states in a compositor. The passed objects will not be modified or copied,
232 * so this function must be called again in the case that the compositor widget outlives the
233 * lifetime of any of the passed pointers.
234 *
235 * @param obj The compositor widget
236 * @param seat The seat to set the keymap for, NULL to set the keymap for all seats
237 * @param keymap The xkb_keymap object to use
238 * @param state The xkb_state object to use
239 * @param str The string containing the keymap
240 * @param wl_key_array A pointer to the wl_array in which keys are stored
241 * @since 1.21
242 */
243EAPI void efl_canvas_wl_seat_keymap_set(Evas_Object *obj, Eo *seat, void *state, char *str, void *wl_key_array);
244
245/**
246 * Set the key repeat rate for a seat in the compositor
247 *
248 * @param obj The compositor widget
249 * @since 1.21
250 */
251EAPI void efl_canvas_wl_seat_key_repeat_set(Evas_Object *obj, Eo *seat, int repeat_rate, int repeat_delay);
252#endif
253#undef EAPI 57#undef EAPI
254#define EAPI 58#define EAPI
255#undef EAPI_WEAK 59#undef EAPI_WEAK