EAPI extern int ECORE_IPC_EVENT_SERVER_DATA;
/**
- * @brief Initialises the Ecore IPC library.
+ * @ingroup Ecore_IPC_Group
+ * @brief Initializes the Ecore IPC library.
* @return Number of times the library has been initialised without
* being shut down.
- * @ingroup Ecore_IPC_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI int ecore_ipc_init(void);
/**
+ * @ingroup Ecore_IPC_Group
* @brief Shuts down the Ecore IPC library.
* @return Number of times the library has been initialised without being
* shut down.
- * @ingroup Ecore_IPC_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
*/
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Creates an IPC server that listens for connections.
*
* For more details about the @p compl_type, @p name and @p port
* @param port Number to identify with socket used for connection.
* @param data Data to associate with the IPC server.
* @return New IPC server. If there is an error, @c NULL is returned.
- * @ingroup Ecore_IPC_Server_Group
* @todo Need to add protocol type parameter to this function.
*
* @if MOBILE @since_tizen 3.0
EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *name, int port, const void *data);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Creates an IPC server object to represent the IPC server listening
* on the given port.
*
* IPC connection.
* @param data Data to associate with the server.
* @return A new IPC server. @c NULL is returned on error.
- * @ingroup Ecore_IPC_Server_Group
* @todo Need to add protocol type parameter.
*
* @if MOBILE @since_tizen 3.0
EAPI Ecore_Ipc_Server *ecore_ipc_server_connect(Ecore_Ipc_Type type, char *name, int port, const void *data);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Closes the connection and frees the given IPC server.
* @param svr The given IPC server.
* @return The data associated with the server when it was created.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void *ecore_ipc_server_del(Ecore_Ipc_Server *svr);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Retrieves the data associated with the given IPC server.
* @param svr The given IPC server.
* @return The associated data.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void *ecore_ipc_server_data_get(Ecore_Ipc_Server *svr);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Retrieves whether the given IPC server is currently connected.
* @param svr The given IPC server.
* @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI Eina_Bool ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Retrieves the list of clients for this server.
* @param svr The given IPC server.
* @return An Eina_List with the clients.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Sends a message to the given IPC server.
*
* The content of the parameters, excluding the @p svr parameter, is up to
* @param data The data to send as part of the message.
* @param size Length of the data, in bytes, to send.
* @return Number of bytes sent. @c 0 is returned if there is an error.
- * @ingroup Ecore_IPC_Server_Group
* @todo This function needs to become an IPC message.
* @todo Fix up the documentation: Make sure what ref_to and response are.
*
EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int ref_to, int response, const void *data, int size);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Sets a limit on the number of clients that can be handled concurrently
* by the given server, and a policy on what to do if excess clients try to
* connect.
* drops. This causes the kernel to queue up to 4096
* connections (or your kernel's limit, whichever is
* lower).
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Sets the max data payload size for an Ipc message in bytes
*
* @param svr The given server.
* @param size The maximum data payload size in bytes.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *srv, int size);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Gets the max data payload size for an Ipc message in bytes
*
* @param svr The given server.
* @return The maximum data payload in bytes.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Gets the IP address of a server that has been connected to.
*
* @param svr The given server.
* the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
* This string should not be modified or trusted to stay valid after
* deletion for the @p svr object. If no IP is known NULL is returned.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI const char *ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr);
/**
+ * @ingroup Ecore_IPC_Server_Group
* @brief Flushes all pending data to the given server. Will return when done.
*
* @param svr The given server.
- * @ingroup Ecore_IPC_Server_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
*/
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Sends a message to the given IPC client.
+ *
* @param cl The given IPC client.
* @param major Major opcode of the message.
* @param minor Minor opcode of the message.
* @param size Length of the data, in bytes, to send.
* @return The number of bytes sent. @c 0 will be returned if there is
* an error.
- * @ingroup Ecore_IPC_Client_Group
* @todo This function needs to become an IPC message.
* @todo Make sure ref_to and response parameters are described correctly.
*
EAPI int ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Retrieves the IPC server that the given IPC client is connected to.
+ *
* @param cl The given IPC client.
* @return The IPC server the IPC client is connected to.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI Ecore_Ipc_Server *ecore_ipc_client_server_get(Ecore_Ipc_Client *cl);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Closes the connection and frees memory allocated to the given IPC
* client.
+ *
* @param cl The given client.
* @return Data associated with the client.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void *ecore_ipc_client_del(Ecore_Ipc_Client *cl);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Sets the IPC data associated with the given IPC client to @p data.
+ *
* @param cl The given IPC client.
* @param data The data to associate with the IPC client.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Retrieves the data that has been associated with the given IPC client.
+ *
* @param cl The given client.
* @return The data associated with the IPC client.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void *ecore_ipc_client_data_get(Ecore_Ipc_Client *cl);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Sets the max data payload size for an Ipc message in bytes
*
* @param cl The given client.
* @param size The maximum data payload size in bytes.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Gets the max data payload size for an Ipc message in bytes
*
* @param cl The given client.
* @return The maximum data payload size in bytes on success, @c -1 on failure.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Gets the IP address of a client that has been connected to.
*
* @param cl The given client.
* This string should not be modified or trusted to stay valid after
* deletion for the @p cl object. If no IP is known @c NULL is
* returned.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI const char *ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl);
/**
+ * @ingroup Ecore_IPC_Client_Group
* @brief Flushes all pending data to the given client. Will return when done.
*
* @param cl The given client.
- * @ingroup Ecore_IPC_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl);
/**
+ * @ingroup Ecore_Con_Client_Group
* @brief Returns if SSL support is available
+ *
* @return 1 if SSL is available, 0 if it is not.
- * @ingroup Ecore_Con_Client_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
/**
* @internal
*
- * @internal
- *
* @file
- * @brief Ecore functions for dealing with the Wayland window system
- *
* @defgroup Ecore_Wl_Group Ecore_Wayland - Wayland integration
* @ingroup Ecore
-
+ * @brief Ecore functions for dealing with the Wayland window system.
* Ecore_Wl provides a wrapper and convenience functions for using the
* Wayland protocol in implementing a window system. Function groups for
* this part of the library include the following:
/**
* @internal
- *
- * @internal
- *
- * Initialize the Wayland display connection to the given display.
+ * @ingroup Ecore_Wl_Init_Group
+ * @brief Initializes the Wayland display connection to the given display.
*
* @param name Display target name. if @c NULL, the default display is
* assumed.
* @return The number of times the library has been initialized without being
- * shut down. 0 is returned if an error occurs.
+ * shut down. @c 0 is returned if an error occurs.
*
- * @ingroup Ecore_Wl_Init_Group
*/
EAPI int ecore_wl_init(const char *name);
/**
* @internal
- *
- * @internal
- *
- * Shuts down the Ecore Wayland Library
- *
+ * @ingroup Ecore_Wl_Init_Group
+ * @brief Shuts down the Ecore Wayland Library.
* In shutting down the library, the Wayland display connection is terminated
* and any event handlers for it are removed.
*
* @return The number of times the library has been initialized without
* being shut down.
*
- * @ingroup Ecore_Wl_Init_Group
*/
EAPI int ecore_wl_shutdown(void);
/**
* @internal
- *
- * @internal
- *
- * Sends all Wayland commands to the Wayland Display.
- *
* @ingroup Ecore_Wl_Flush_Group
+ * @brief Sends all Wayland commands to the Wayland Display.
+ *
* @since 1.2
*/
EAPI void ecore_wl_flush(void);
/**
* @internal
- *
- * @internal
- *
- * Flushes the command buffer and waits until all requests have been
+ * @ingroup Ecore_Wl_Flush_Group
+ * @brief Flushes the command buffer and waits until all requests have been
* processed by the server.
*
- * @ingroup Ecore_Wl_Flush_Group
* @since 1.2
*/
EAPI void ecore_wl_sync(void);
/**
* @internal
- *
- * @internal
- *
- * Retrieves the Wayland Shm Interface used for the current Wayland connection.
+ * @ingroup Ecore_Wl_Display_Group
+ * @brief Retrieves the Wayland Shm Interface used for the current Wayland connection.
*
* @return The current wayland shm interface, or NULL on error
*
- * @ingroup Ecore_Wl_Display_Group
* @since 1.2
*/
EAPI struct wl_shm *ecore_wl_shm_get(void);
/**
* @internal
- *
- * @internal
- *
- * Retrieves the Wayland Display Interface used for the current Wayland connection.
+ * @ingroup Ecore_Wl_Display_Group
+ * @brief Retrieves the Wayland Display Interface used for the current Wayland connection.
*
* @return The current wayland display interface, or NULL on error
*
- * @ingroup Ecore_Wl_Display_Group
* @since 1.2
*/
EAPI struct wl_display *ecore_wl_display_get(void);
/**
- * Retrieves the Compositor interface.
+ * @brief Retrieves the Compositor interface.
*
* This interface is used by clients to request the creation of surfaces and
* regions.
/**
* @internal
+ * @ingroup Ecore_Wl_Display_Group
+ * @brief Retrieves the size of the current screen.
*
- * @internal
- *
- * Retrieves the size of the current screen.
- *
- * @param w where to return the width. May be NULL. Returns 0 on error.
- * @param h where to return the height. May be NULL. Returns 0 on error.
+ * @param w Where to return the width. May be NULL. Returns @c 0 on error.
+ * @param h Where to return the height. May be NULL. Returns @c 0 on error.
*
- * @ingroup Ecore_Wl_Display_Group
* @since 1.2
*/
EAPI void ecore_wl_screen_size_get(int *w, int *h);
/**
* @internal
+ * @ingroup Ecore_Wl_Display_Group
+ * @brief Retrieves the position of the current screen.
*
- * @internal
- *
- * Retrieves the position of the current screen.
- *
- * @param x where to return the horizontal position. May be NULL. Returns 0 on error.
- * @param y where to return the vertical position. May be NULL. Returns 0 on error.
+ * @param x Where to return the horizontal position. May be NULL. Returns @c 0 on error.
+ * @param y Where to return the vertical position. May be NULL. Returns @c 0 on error.
*
- * @ingroup Ecore_Wl_Display_Group
* @since 1.2
*/
EAPI void ecore_wl_pointer_xy_get(int *x, int *y);
/**
* @internal
- *
- * @internal
- *
- * Return the screen DPI
+ * @brief Returns the screen DPI.
*
* This is a simplistic call to get DPI. It does not account for differing
* DPI in the x and y axes nor does it account for multihead or xinerama and
/**
* @internal
- *
- * @internal
- *
- * Dispatch Wayland events
+ * @brief Dispatches Wayland events.
*
* Dispatches any events queued on the default queue. Wayland will attempt
* to read from the display fd and queue things up according to the proxy
/**
* @internal
- *
- * @internal
- *
- * Retrieves the requested cursor from the cursor theme
+ * @brief Retrieves the requested cursor from the cursor theme.
*
* @param cursor_name The desired cursor name to be looked up in the theme
* @return the cursor or NULL if the cursor cannot be found
* @defgroup Ecore_Wl_Input_Group Functions dealing with Wayland Input
* @ingroup Ecore_Wl_Group
*
- * Functions to interface with Wayland Input
+ * Functions to interface with Wayland Input.
*/
/**
* @internal
- *
- * @internal
- *
* @ingroup Ecore_Wl_Input_Group
* @since 1.8
*/
/**
* @internal
- *
- * @internal
- *
* @ingroup Ecore_Wl_Input_Group
* @since 1.12
*/
/**
* @internal
- *
- * @internal
- *
- * Retrieves the Wayland Globals Interface list used for the current Wayland connection.
+ * @ingroup Ecore_Wl_Display_Group
+ * @brief Retrieves the Wayland Globals Interface list used for the current Wayland connection.
*
* This call, if done after the ECORE_WL_EVENT_INTERFACES_BOUND event was
* received already, won't block the mainloop or trigger a dispatch. It will
*
* @return The current wayland globals interface list, or NULL on error
*
- * @ingroup Ecore_Wl_Display_Group
* @since 1.7.6
*/
EAPI Eina_Inlist *ecore_wl_globals_get(void);
/**
* @internal
- *
- * @internal
- *
- * Retrieves the Wayland Registry used for the current Wayland connection.
+ * @ingroup Ecore_Wl_Display_Group
+ * @brief Retrieves the Wayland Registry used for the current Wayland connection.
*
* @return The current wayland registry, or NULL on error
*
- * @ingroup Ecore_Wl_Display_Group
* @since 1.7.6
*/
EAPI struct wl_registry *ecore_wl_registry_get(void);
*
* @defgroup Ecore_Wl_Window_Group Wayland Window functions.
* @ingroup Ecore_Wl_Group
- *
* Functions that can be used to create a Wayland window.
*/
/**
* @internal
- *
- * @internal
- *
- * Creates a new window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Creates a new window.
*
* @param parent The parent window to use. If @p parent is @c 0, the root window
* of the default display is used.
*
* @return The new window, or NULL on failure
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, int w, int h, int buffer_type);
/**
* @internal
- *
- * @internal
- *
- * Deletes the given window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Deletes the given window.
*
* @param win The given window
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_free(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
- * Signals for Wayland to initiate a window move.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Signals for Wayland to initiate a window move.
*
* The position requested (@p x, @p y) is not honored by Wayland because
* Wayland does not allow specific window placement to be set.
* @param x X Position
* @param y Y Position
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y);
/**
* @internal
- *
- * @internal
- *
- * Signals for Wayland to initiate a window resize.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Signals for Wayland to initiate a window resize.
*
* The size requested (@p w, @p h) is not honored by Wayland because
* Wayland does not allow specific window sizes to be set.
* @param h Height
* @param location The edge of the window from where the resize should start.
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_resize(Ecore_Wl_Window *win, int w, int h, int location);
/**
* @internal
- *
- * @internal
- *
- * Shows a window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Shows a window.
*
* Synonymous to "mapping" a window in Wayland System terminology.
*
* @param win The window to show.
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_show(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
- * Hides a window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Hides a window.
*
* Synonymous to "unmapping" a window in Wayland System terminology.
*
* @param win The window to hide.
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_hide(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
- * Raises a window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Raises a window.
*
* @param win The window to raise.
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.2
*/
EAPI void ecore_wl_window_raise(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
- * Iconify a window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Iconifies a window.
*
* @param win The window to iconifiy
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.12
*/
EAPI void ecore_wl_window_iconified_set(Ecore_Wl_Window *win, Eina_Bool iconified);
/**
* @internal
- *
- * @internal
- *
- * Returns a wl_surface with no association to any wl_shell_surface.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Returns a wl_surface with no association to any wl_shell_surface.
*
* @param win The window which will use this newly created surface.
* @return wl_surface or NULL on error
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI struct wl_surface *ecore_wl_window_surface_create(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
- * Returns the Ecore_Wl_Window from a wl_surface
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Returns the Ecore_Wl_Window from a wl_surface.
*
* @param surface The surface for which to find the Ecore_Wl_Window from
* @return the Ecore_Wl_Window associated with this surface, or NULL if not found
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI Ecore_Wl_Window *ecore_wl_window_surface_find(struct wl_surface *surface);
/**
- * Set the input rect of the Ecore_Wl_Window.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Sets the input rect of the Ecore_Wl_Window.
*
* To set an empty rect, pass x and y and width and height as -1, -1, 1, 1.
*
* @param win The window
* @param input_rect The rectangle to be set as input
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_input_rect_set(Ecore_Wl_Window *win, Eina_Rectangle *input_rect);
/**
- * Add the input rect of the Ecore_Wl_Window.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Adds the input rect of the Ecore_Wl_Window.
*
* @param win The window
* @param input_rect The rectangle to be added as input
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_input_rect_add(Ecore_Wl_Window *win, Eina_Rectangle *input_rect);
/**
- * Subtract the input rect of the Ecore_Wl_Window.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Subtracts the input rect of the Ecore_Wl_Window.
*
* @param win The window
* @param input_rect The rectangle to be subtracted as input
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_input_rect_subtract(Ecore_Wl_Window *win, Eina_Rectangle *input_rect);
/**
* @internal
- *
- * @internal
- *
- * Set the input region of the Ecore_Wl_Window.
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Sets the input region of the Ecore_Wl_Window.
*
* To set an empty region, pass width and height as 0.
*
* @param w The width of the region.
* @param h The height of the region.
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h);
/**
* @internal
- *
- * @internal
- *
- * Set the opaque region of the Ecore_Wl_Window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Sets the opaque region of the Ecore_Wl_Window.
*
* @param win The window
* @param x The left point of the region.
* @param w The width of the region.
* @param h The height of the region.
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h);
/**
* @internal
- *
- * @internal
- *
- * Set the rotation of the Ecore_Wl_Window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Sets the rotation of the Ecore_Wl_Window.
*
* @param win The window
* @param rotation The degree of rotation for this window
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation);
/**
* @internal
- *
- * @internal
- *
- * Get the rotation of the Ecore_Wl_Window
+ * @ingroup Ecore_Wl_Window_Group
+ * @brief Gets the rotation of the Ecore_Wl_Window.
*
* @param win The window
* @return The degree of rotation for this window
*
- * @ingroup Ecore_Wl_Window_Group
* @since 1.8
*/
EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
* @deprecated use ecore_wl_dnd_selection_set
* @since 1.7
*/
/**
* @internal
- *
- * @internal
- *
* @deprecated use ecore_wl_dnd_selection_get
* @since 1.7
*/
/**
* @internal
- *
- * @internal
- *
* @deprecated Do Not Use
* @since 1.7
*/
/**
* @internal
- *
- * @internal
- *
* @deprecated use ecore_wl_dnd_drag_start
* @since 1.7
*/
/**
* @internal
- *
- * @internal
- *
* @deprecated use ecore_wl_dnd_selection_owner_has
* @since 1.7
*/
/**
* @internal
- *
- * @internal
- *
+ * @ingroup Ecore_Wl_Dnd_Group
* @return false on error, true otherwise
*
- * @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **types_offered);
/**
* @internal
- *
- * @internal
- *
+ * @ingroup Ecore_Wl_Dnd_Group
* @return false if type not found or on error, true otherwise
*
- * @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *type);
/**
* @internal
- *
- * @internal
- *
+ * @ingroup Ecore_Wl_Dnd_Group
* @return true if input has a selection source, false otherwise or on error
*
- * @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input);
/**
* @internal
- *
- * @internal
- *
+ * @ingroup Ecore_Wl_Dnd_Group
* @return false on error, true otherwise
*
- * @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_selection_clear(Ecore_Wl_Input *input);
/**
* @internal
- *
- * @internal
- *
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
/**
* @internal
- *
- * @internal
- *
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
/**
* @internal
- *
- * @internal
- *
+ * @ingroup Ecore_Wl_Dnd_Group
* @return false if type not found or on error, true otherwise
*
- * @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type);
/**
* @internal
- *
- * @internal
- *
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
/**
* @internal
- *
- * @internal
- *
+ * @ingroup Ecore_Wl_Dnd_Group
* @return the data types being offered for drag-and-drop, or NULL on error
*
- * @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input);
/**
* @internal
- *
- * @internal
- *
- * Enable/disable server mode.
+ * Enables/disables server mode.
*
* With this enabled, the compositor acts as a Wayland server, iterating
* the display and dispatching events. With it disabled, the process is
/**
* @internal
- *
- * @internal
- *
- * Create and return a new subsurface.
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Creates and returns a new subsurface.
*
* Create a new surface (and subsurface interface), with the parent surface
* being the one associated with the given @param win.
* @return the allocated and initialized Ecore_Wl_Subsurf object, or
* NULL on failure
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win);
/**
* @internal
- *
- * @internal
- *
- * Destroy the given subsurface, as well as the surface associated with it.
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Destroys the given subsurface, as well as the surface associated with it.
*
* @param ess the subsurface
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess);
/**
* @internal
- *
- * @internal
- *
- * Get the wl_surface for this subsurface
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Gets the wl_surface for this subsurface.
*
* @param ess the subsurface
* @return the wl_surface associated with this subsurface, or NULL on failure
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess);
/**
* @internal
- *
- * @internal
- *
- * Set the position of this subsurface, relative to its parent surface.
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Sets the position of this subsurface, relative to its parent surface.
* If ess is defined and the x, y coordinates differ from the currently
* tracked position, this also schedules a sub-surface position change.
*
* @param x coordinate in the parent surface
* @param y coordinate in the parent surface
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y);
/**
* @internal
- *
- * @internal
- *
- * Get the position of this subsurface, relative to its parent surface.
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Gets the position of this subsurface, relative to its parent surface.
* Coordinates will be returned in x and y if non-NULL.
*
* @param ess the subsurface
* @param x coordinate in the parent surface, or NULL to ignore
* @param y coordinate in the parent surface, or NULL to ignore
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
/**
* @internal
- *
- * @internal
- *
- * Place subsurface on layer above a reference surface
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Places subsurface on layer above a reference surface.
*
* Moves the @param ess subsurface to just above the reference @param
* surface, changing the z-order. The reference @param surface must
* @param ess the subsurface
* @param surface the sibling reference surface
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface *surface);
/**
* @internal
- *
- * @internal
- *
- * Place subsurface on layer below a reference surface
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Places subsurface on layer below a reference surface.
*
* See ecore_wl_subsurf_place_above.
*
* @param ess the subsurface
* @param surface the sibling reference surface
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface *surface);
/**
* @internal
- *
- * @internal
- *
- * Enables or disables sub-surface synchronization
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Enables or disables sub-surface synchronization.
*
* When synchronization is enabled, surface commits on the subsurface
* will be cached and only applied when the parent surface's state is
* @param ess the subsurface
* @param val true to enable synchronization, false to desynchronize
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val);
/**
* @internal
- *
- * @internal
- *
- * Set an opaque region for the given subsurface.
+ * @ingroup Ecore_Wl_Subsurf
+ * @brief Sets an opaque region for the given subsurface.
*
* This is an optimization hint to the compositor to allow it avoid
* redrawing content unnecessarily. Note that marking transparent
* @param w width to set as opaque
* @param h height to set as opaque
*
- * @ingroup Ecore_Wl_Subsurf
* @since 1.8
*/
EAPI void ecore_wl_subsurf_opaque_region_set(Ecore_Wl_Subsurf *ess, int x, int y, int w, int h);
/**
- * Set keygrab value of the window.
- *
* @ingroup Ecore_Wl_Window
+ * @brief Sets keygrab value of the window.
+ *
*/
EAPI Eina_Bool ecore_wl_window_keygrab_set(Ecore_Wl_Window *win, const char *key, int mod, int not_mod, int priority, Ecore_Wl_Window_Keygrab_Mode grab_mode);
/**
- * Unset keygrab value of the window.
- *
* @ingroup Ecore_Wl_Window
+ * @brief Unsets keygrab value of the window.
+ *
*/
EAPI Eina_Bool ecore_wl_window_keygrab_unset(Ecore_Wl_Window *win, const char *key, int mod, int any_mod);
/**
- * Set keygrab values of the window.
+ * @ingroup Ecore_Wl_Window
+ * @brief Sets keygrab values of the window.
*
* The returned list should be freed with @c eina_list_free() when you no
* longer need it.
*
- * @param win the window
- * @param infos the list of keys and grab modes for setting keygrab
+ * @param win The window
+ * @param infos The list of keys and grab modes for setting keygrab
*
* @return NULL, or the list of keys being failed keygrab set.
*
*
* ecore_wl_window_keygrab_list_set(win, infos);
*
- * @ingroup Ecore_Wl_Window
* @since tizen 3.0
*/
EAPI Eina_List *ecore_wl_window_keygrab_list_set(Ecore_Wl_Window *win, Eina_List *infos);
/**
- * Unset keygrab values of the window.
+ * @ingroup Ecore_Wl_Window
+ * @brief Unsets keygrab values of the window.
*
* The returned list should be freed with @c eina_list_free() when you no
* longer need it.
*
- * @param win the window
- * @param infos the list of infos for unsetting keygrab
+ * @param win The window
+ * @param infos The list of infos for unsetting keygrab
*
* @return NULL, or the list of keys being failed keygrab unset.
*
*
* ecore_wl_window_keygrab_list_unset(win, infos);
*
- * @ingroup Ecore_Wl_Window
* @since tizen 3.0
*/
EAPI Eina_List *ecore_wl_window_keygrab_list_unset(Ecore_Wl_Window *win, Eina_List *infos);
projects / platform / upstream / efl.git / commitdiff