/**
* @file
- * @brief Ecore functions for dealing with drm, virtual terminals
- *
* @defgroup Ecore_Drm_Group Ecore_Drm - Drm Integration
* @ingroup Ecore
+ * @brief Ecore functions for dealing with drm, virtual terminals.
*
- * Ecore_Drm provides a wrapper and functions for using libdrm
+ * Ecore_Drm provides a wrapper and functions for using libdrm.
*
* @li @ref Ecore_Drm_Init_Group
* @li @ref Ecore_Drm_Device_Group
EAPI int ecore_drm_shutdown(void);
/**
- * Find a drm device in the system.
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Finds a drm device in the system.
*
* @param name The name of the device to find. If NULL, this function will
* search for the default drm device.
*
* @return An opaque Ecore_Drm_Device structure representing the card.
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat);
/**
- * Free an Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Frees an Ecore_Drm_Device.
*
* This function will cleanup and free any previously allocated Ecore_Drm_Device.
*
* @param dev The Ecore_Drm_Device to free
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev);
/**
- * Open an Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Opens an Ecore_Drm_Device.
*
* This function will open an existing Ecore_Drm_Device for use.
*
* @param dev The Ecore_Drm_Device to try and open
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev);
/**
- * Close an Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Closes an Ecore_Drm_Device.
*
* This function will close a previously opened Ecore_Drm_Device
*
* @param dev The Ecore_Drm_Device to free
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev);
/**
- * Get if a given Ecore_Drm_Device is master
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Gets if a given Ecore_Drm_Device is master.
*
* This function will check if the given drm device is set to master
*
* @param dev The Ecore_Drm_Device to check
*
- * @return EINA_TRUE if device is master, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if device is master, @c EINA_FALSE otherwise
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev);
/**
- * Set a given Ecore_Drm_Device to master
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Sets a given Ecore_Drm_Device to master.
*
* This function will attempt to set a given drm device to be master
*
* @param dev The Ecore_Drm_Device to set
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev);
/**
- * Tell a given Ecore_Drm_Device to stop being master
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Tells a given Ecore_Drm_Device to stop being master.
*
* This function will attempt to ask a drm device to stop being master
*
* @param dev The Ecore_Drm_Device to set
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Device_Group
*/
EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev);
/**
- * Get the file descriptor of Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Gets the file descriptor of Ecore_Drm_Devices.
*
* This function will get the file descriptor of drm device
*
* @param dev The Ecore_Drm_Device to get
*
- * @return fd value on success, -1 on failure
- *
- * @ingroup Ecore_Drm_Device_Group
+ * @return fd Value on success, @c -1 on failure
*
*/
EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev);
/**
- * Set the window of Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Sets the window of Ecore_Drm_Devices.
*
- * This function will set the window for given drm device
+ * This function will set the window for given drm devices.
*
* @param dev The Ecore_Drm_Device for which window is set
* @param window The window to set
*
- * @ingroup Ecore_Drm_Device_Group
- *
* @since 1.10
*/
EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window);
/**
- * Get the name of the Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Gets the name of the Ecore_Drm_Device.
*
- * This function will return the name of Ecore_Drm_Device
+ * This function will return the name of Ecore_Drm_Device.
*
* @param dev The Ecore_Drm_Device to get name
*
* @return device name on success, NULL on failure
*
- * @ingroup Ecore_Drm_Device_Group
*
* @since 1.10
*/
EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev);
/**
- * Setup an Ecore_Drm_Device for software rendering
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Sets up an Ecore_Drm_Device for software rendering.
*
* This function will setup an Ecore_Drm_Device for software rendering
- * which includes creating dumb buffers to render into
+ * which includes creating dumb buffers to render into.
*
* @param dev The Ecore_Drm_Device to setup for software rendering
*
* @return EINA_TRUE on success, EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.14
*/
EAPI Eina_Bool ecore_drm_device_software_setup(Ecore_Drm_Device *dev);
/**
- * Set a left handed mode at the given Ecore_Drm_Device
- *
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Sets a left handed mode at the given Ecore_Drm_Device.
* This function will loop all the registered inputs in Ecore_Drm_Device and
* set/unset left handed mode.
*
* @param dev The Ecore_Drm_Device to set left handed mode
* @param left_handed The flag of enable/disable left handed mode
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.17
*/
EAPI Eina_Bool ecore_drm_device_pointer_left_handed_set(Ecore_Drm_Device *dev, Eina_Bool left_handed);
/**
- * Setup a cached context to use same context for each devices
- *
- * This function will setup a cached context to use same context for each devices
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Sets up a cached context to use same context for each devices.
+ * This function will setup a cached context to use same context for each devices.
* This function will be called before initialize Ecore_Drm.
*
* @param ctx struct xkb_context used in libxkbcommon
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.17
*/
EAPI void ecore_drm_device_keyboard_cached_context_set(struct xkb_context *ctx);
/**
- * Setup a cached keymap to use same keymap for each devices
- *
- * This function will setup a cached keymap to use same keymap for each devices
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Sets up a cached keymap to use same keymap for each devices
+ * This function will setup a cached keymap to use same keymap for each devices.
* This function will be called before initialize Ecore_Drm.
*
* @param map struct xkb_keymap used in libxkbcommon
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.17
*/
EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map);
/**
- * Find an Ecore_Drm_Output at the given coordinates
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Finds an Ecore_Drm_Output at the given coordinates.
*
* This function will loop all the existing outputs in Ecore_Drm_Device and
* return an output if one exists that encapsulates the given coordinates.
* @param x The x coordinate
* @param y The y coordinate
*
- * @return An Ecore_Drm_Output if one exists at these coordinates or NULL
+ * @return An Ecore_Drm_Output if one exists at these coordinates, or NULL
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.14
*/
EAPI Ecore_Drm_Output *ecore_drm_device_output_find(Ecore_Drm_Device *dev, int x, int y);
/**
- * Open a tty for use
+ * @ingroup Ecore_Drm_Tty_Group
+ * @brief Opens a tty for use.
*
* @param dev The Ecore_Drm_Device that this tty will belong to.
* @param name The name of the tty to try and open.
* If NULL, /dev/tty0 will be used.
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Tty_Group
*/
EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name);
/**
- * Close an already opened tty
+ * @ingroup Ecore_Drm_Tty_Group
+ * @brief Closes an already opened tty.
*
* @param dev The Ecore_Drm_Device which owns this tty.
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Tty_Group
*/
EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev);
/**
- * Release a virtual terminal
+ * @ingroup Ecore_Drm_Tty_Group
+ * @brief Releases a virtual terminal.
*
* @param dev The Ecore_Drm_Device which owns this tty.
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Tty_Group
*/
EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev);
/**
- * Acquire a virtual terminal
+ * @ingroup Ecore_Drm_Tty_Group
+ * @brief Acquires a virtual terminal.
*
* @param dev The Ecore_Drm_Device which owns this tty.
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Tty_Group
*/
EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev);
/**
- * Get the opened virtual terminal file descriptor
- *
+ * @ingroup Ecore_Drm_Tty_Group
+ * @brief Gets the opened virtual terminal file descriptor.
+ *
* @param dev The Ecore_Drm_Device which owns this tty.
*
* @return The tty fd opened from previous call to ecore_drm_tty_open
*
- * @ingroup Ecore_Drm_Tty_Group
*
* @since 1.10
*/
EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev);
/**
- * Create outputs for a drm device
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Creates outputs for a drm device.
*
- * This function will create outputs for Ecore_Drm_Device
+ * This function will create outputs for Ecore_Drm_Device.
*
* @param dev The Ecore_Drm_Device device for which outputs
* needs to be created
*
* @return EINA_TRUE on success, EINA_FALSE on failure.
*
- * @ingroup Ecore_Drm_Output_Group
*/
EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev);
/**
- * Free an Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Frees an Ecore_Drm_Output.
*
- * This function will cleanup and free any previously allocated Ecore_Drm_Output
+ * This function will cleanup and free any previously allocated Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to free
*
- * @ingroup Ecore_Drm_Output_Group
*/
EAPI void ecore_drm_output_free(Ecore_Drm_Output *output);
/**
- * Set the cursor size for Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Sets the cursor size for Ecore_Drm_Output.
*
- * This function will set the cursor size of Ecore_Drm_Output
+ * This function will set the cursor size of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to set
* @param handle The Drm handle
* @param w The width of cursor
* @param h The height of cursor
*
- * @ingroup Ecore_Drm_Output_Group
*/
EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h);
/**
- * Enable a Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Enables a Ecore_Drm_Output.
*
* This function will enable an Ecore_Drm_Output
*
* @param output The Ecore_Drm_Output to enable
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output);
/**
- * Disable a Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Disables a Ecore_Drm_Output.
*
* This function will disable an Ecore_Drm_Output
*
* @param output The Ecore_Drm_Output to disable
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI void ecore_drm_output_disable(Ecore_Drm_Output *output);
EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output);
/**
- * Get the output size of Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the output size of Ecore_Drm_Device.
*
- * This function will give the output size of Ecore_Drm_Device
+ * This function will give the output size of Ecore_Drm_Device.
*
* @param dev The Ecore_Drm_Device to get output size
- * @param output The output id whose information needs to be retrived
+ * @param output The output id whose information needs to be retrieved
* @param *w The parameter in which output width is stored
* @param *h The parameter in which output height is stored
*
- * @ingroup Ecore_Drm_Output_Group
*/
EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h);
EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h);
/**
- * Get the crtc id of an output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the crtc id of an output.
*
- * This function will return the default crtc id for an output
+ * This function will return the default crtc id for an output.
*
* @param output The Ecore_Drm_Output to get the default crtc of
*
* @return The id of the default crtc for this output
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI unsigned int ecore_drm_output_crtc_id_get(Ecore_Drm_Output *output);
/**
- * Get the crtc buffer of an output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the crtc buffer of an output.
*
- * This function will return the default buffer id for an output
+ * This function will return the default buffer id for an output.
*
* @param output The Ecore_Drm_Output to get the default buffer of
*
* @return The id of the default buffer for this output
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI unsigned int ecore_drm_output_crtc_buffer_get(Ecore_Drm_Output *output);
/**
- * Get the connector id of an output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the connector id of an output.
*
- * This function will return the default connector id for an output
+ * This function will return the default connector id for an output.
*
* @param output The Ecore_Drm_Output to get the default connector of
*
* @return The id of the default connector id for this output
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI unsigned int ecore_drm_output_connector_id_get(Ecore_Drm_Output *output);
EAPI void ecore_drm_fb_destroy(Ecore_Drm_Fb *fb);
/**
- * Mark an Ecore_Drm_Fb as dirty
+ * @ingroup Ecore_Drm_Fb_Group
+ * @brief Marks an Ecore_Drm_Fb as dirty.
*
- * This function mark an Ecore_Drm_Fb as being dirty
+ * This function mark an Ecore_Drm_Fb as being dirty.
*
* @param fb The Ecore_Drm_Fb to mark as dirty
* @param rects The regions of the Ecore_Drm_Fb which are dirty
* @param count The number of regions
*
- * @ingroup Ecore_Drm_Fb_Group
* @since 1.14
*/
EAPI void ecore_drm_fb_dirty(Ecore_Drm_Fb *fb, Eina_Rectangle *rects, unsigned int count);
/**
- * Set an Ecore_Drm_Fb as the current framebuffer
+ * @ingroup Ecore_Drm_Fb_Group
+ * @brief Sets an Ecore_Drm_Fb as the current framebuffer.
*
* This function will set the given Ecore_Drm_Fb as the framebuffer used
- * across all outputs
+ * across all outputs.
*
* @param dev The Ecore_Drm_Device to use
* @param fb The Ecore_Drm_Fb to make the current framebuffer
*
* @deprecated just call ecore_drm_fb_send() instead.
*
- * @ingroup Ecore_Drm_Fb_Group
* @since 1.14
*/
EINA_DEPRECATED EAPI void ecore_drm_fb_set(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb);
/**
- * Send an Ecore_Drm_Fb to the Ecore_Drm_Device
+ * @internal
+ * @ingroup Ecore_Drm_Fb_Group
+ * @brief Sends an Ecore_Drm_Fb to the Ecore_Drm_Device.
*
* This function will call drmModePageFlip for the given device using the
- * given Ecore_Drm_Fb as the framebuffer
+ * given Ecore_Drm_Fb as the framebuffer.
*
* @param dev The Ecore_Drm_Device to use
* @param fb The Ecore_Drm_Fb to send
* @param cb The function to call when the page flip has completed
* @param data The data to pass to the callback function
*
- * @ingroup Ecore_Drm_Fb_Group
* @since 1.14
*/
EAPI void ecore_drm_fb_send(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb, Ecore_Drm_Pageflip_Cb func, void *data);
EAPI void ecore_drm_launcher_disconnect(Ecore_Drm_Device *dev);
/**
- * Get the output position of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the output position of Ecore_Drm_Output.
*
- * This function will give the output position of Ecore_Drm_Output
+ * This function will give the output position of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get position for
* @param *x The parameter in which output x co-ordinate is stored
* @param *y The parameter in which output y co-ordinate is stored
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI void ecore_drm_output_position_get(Ecore_Drm_Output *output, int *x, int *y);
/**
- * Get the current resolution of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the current resolution of Ecore_Drm_Output.
*
- * This function will give the current resolution of Ecore_Drm_Output
+ * This function will give the current resolution of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get resolution for
* @param *w The parameter in which output width is stored
* @param *h The parameter in which output height is stored
* @param *refresh The parameter in which output refresh rate is stored
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI void ecore_drm_output_current_resolution_get(Ecore_Drm_Output *output, int *w, int *h, unsigned int *refresh);
/**
- * Get the physical size of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the physical size of Ecore_Drm_Output.
*
- * This function will give the physical size (in mm) of Ecore_Drm_Output
+ * This function will give the physical size (in mm) of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get physical size for
* @param *w The parameter in which output physical width is stored
* @param *h The parameter in which output physical height is stored
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI void ecore_drm_output_physical_size_get(Ecore_Drm_Output *output, int *w, int *h);
/**
- * Get the subpixel order of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the subpixel order of Ecore_Drm_Output.
*
- * This function will give the subpixel order of Ecore_Drm_Output
+ * This function will give the subpixel order of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get subpixel order for
* @return The output subpixel order
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI unsigned int ecore_drm_output_subpixel_order_get(Ecore_Drm_Output *output);
/**
- * Get the model of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the model of Ecore_Drm_Output.
*
- * This function will give the model of Ecore_Drm_Output
+ * This function will give the model of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get model for
* @return The model (do NOT eina_stringshare_del this return!)
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI Eina_Stringshare *ecore_drm_output_model_get(Ecore_Drm_Output *output);
/**
- * Get the make of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the make of Ecore_Drm_Output.
*
- * This function will give the make of Ecore_Drm_Output
+ * This function will give the make of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get model for
* @return The make (do NOT eina_stringshare_del this return!)
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI Eina_Stringshare *ecore_drm_output_make_get(Ecore_Drm_Output *output);
/**
- * Get the name of Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the name of Ecore_Drm_Output.
*
- * This function will give the name of Ecore_Drm_Output
+ * This function will give the name of Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get name for
* @return The name. Caller should free this return.
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI char *ecore_drm_output_name_get(Ecore_Drm_Output *output);
/**
- * Set the dpms level of an Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Sets the dpms level of an Ecore_Drm_Output.
*
- * This function will set the DPMS level of an Ecore_Drm_Output
+ * This function will set the DPMS level of an Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to set the dpms level on
* @param level The level to set
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level);
/**
- * Set the gamma level of an Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Sets the gamma level of an Ecore_Drm_Output.
*
- * This function will set the gamma of an Ecore_Drm_Output
+ * This function will set the gamma of an Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to set the gamma level on
* @param size The gamma table size to set
* @param g The amount to scale the green channel
* @param b The amount to scale the blue channel
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.14
*/
EAPI void ecore_drm_output_gamma_set(Ecore_Drm_Output *output, uint16_t size, uint16_t *r, uint16_t *g, uint16_t *b);
/**
- * Get the pointer position of Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Gets the pointer position of Ecore_Drm_Device.
*
- * This function will give the pointer position of Ecore_Drm_Device
+ * This function will give the pointer position of Ecore_Drm_Device.
*
* @param dev The Ecore_Drm_Device to get pointer position for
* @param *x The parameter in which output x co-ordinate is stored
* @param *y The parameter in which output y co-ordinate is stored
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.14
*/
EAPI void ecore_drm_device_pointer_xy_get(Ecore_Drm_Device *dev, int *x, int *y);
/**
- * Warp the pointer position of Ecore_Drm_Device
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Warps the pointer position of Ecore_Drm_Device.
*
- * This function will set the pointer position of Ecore_Drm_Device
+ * This function will set the pointer position of Ecore_Drm_Device.
*
* @param dev The Ecore_Drm_Device to set pointer position for
* @param x The new x co-ordinate
* @param y The new y co-ordinate
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.18
*/
EAPI void ecore_drm_device_pointer_warp(Ecore_Drm_Device *dev, int x, int y);
/**
- * Get the list of drm devices which are allocated.
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Gets the list of drm devices which are allocated.
*
* @return Eina_List of drm devices, NULL otherwise
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.14
*/
EAPI const Eina_List *ecore_drm_devices_get(void);
/**
- * Get the minimum and maximum screen size range
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Gets the minimum and maximum screen size range.
*
* @param dev The Ecore_Drm_Device to get screen size range from
* @param *minw The parameter in which smallest width is stored
* @param *maxw The parameter in which largest width is stored
* @param *maxh The parameter in which largest height is stored
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.15
*/
EAPI void ecore_drm_screen_size_range_get(Ecore_Drm_Device *dev, int *minw, int *minh, int *maxw, int *maxh);
/**
- * Get if a given output is connected
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets if a given output is connected.
*
* @param output The Ecore_Drm_Output to get the connected status of
*
* @return EINA_TRUE if output is connected, EINA_FALSE otherwise
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI Eina_Bool ecore_drm_output_connected_get(Ecore_Drm_Output *output);
/**
- * Get the connector type of a given Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the connector type of a given Ecore_Drm_Output.
*
* @param output The Ecore_Drm_Output to get the connector type of
*
* @return An unsigned integer representing the type of connector for this output
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI unsigned int ecore_drm_output_connector_type_get(Ecore_Drm_Output *output);
/**
- * Get if a given output has a backlight
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets if a given output has a backlight.
*
* @param output The Ecore_Drm_Output to get the backlight of
*
* @return EINA_TRUE if this output has a backlight, EINA_FALSE otherwise
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI Eina_Bool ecore_drm_output_backlight_get(Ecore_Drm_Output *output);
/**
- * Get the edid of a given output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the edid of a given output.
*
* @param output The Ecore_Drm_Output to get the edid of
*
* @return A string representing the edid
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output);
/**
- * Get a list of the modes supported on a given output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets a list of the modes supported on a given output.
*
* @param output The Ecore_Drm_Output to get the modes for
*
*
* @note The returned list should not be freed
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI Eina_List *ecore_drm_output_modes_get(Ecore_Drm_Output *output);
/**
- * Get the output which is marked as primary
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the output which is marked as primary.
*
* @param dev The Ecore_Drm_Device to get the primary output from
*
* @return The primary Ecore_Drm_Output or NULL if no primary output is set
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI Ecore_Drm_Output *ecore_drm_output_primary_get(Ecore_Drm_Device *dev);
/**
- * Set a given output as primary
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Sets a given output as primary.
*
* @param output The Ecore_Drm_Output to set as primary
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI void ecore_drm_output_primary_set(Ecore_Drm_Output *output);
/**
- * Get the size of the crtc for a given output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets the size of the crtc for a given output.
*
* @param output The Ecore_Drm_Output to get the crtc size of
* @param *width The parameter in which width is stored
* @param *height The parameter in which height is stored
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, int *height);
/**
- * Find an Ecore_Drm_Output which has the given name
+ * @ingroup Ecore_Drm_Device_Group
+ * @brief Finds an Ecore_Drm_Output which has the given name.
*
* This function will loop all the existing outputs in Ecore_Drm_Device and
* return an output if one exists that matches the given name.
*
* @return An Ecore_Drm_Output if one exists at these coordinates or NULL
*
- * @ingroup Ecore_Drm_Device_Group
* @since 1.15
*/
EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev, const char *name);
/**
- * Get if an Ecore_Drm_Output can be used on a given crtc
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Gets if an Ecore_Drm_Output can be used on a given crtc.
*
* This function will loop the possible crtcs of an encoder to determine if
* a given output can be assigned to a given crtc
* @param output The Ecore_Drm_Output to test if can be used on crtc
* @param crtc The crtc to test an Ecore_Drm_Output against
*
- * @return EINA_TRUE if the output can be assigned to given crtc, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if the output can be assigned to given crtc, @c EINA_FALSE otherwise
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsigned int crtc);
/**
- * Set a given mode to be used on an Ecore_Drm_Output
+ * @ingroup Ecore_Drm_Output_Group
+ * @brief Sets a given mode to be used on an Ecore_Drm_Output.
*
* This function will set the given mode to be used on a given Ecore_Drm_Output
*
* @param X The X position to set this output to
* @param Y The Y position to set this output to
*
- * @return EINA_TRUE on success, EINA_FALSE on failure
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
*
- * @ingroup Ecore_Drm_Output_Group
* @since 1.15
*/
EAPI Eina_Bool ecore_drm_output_mode_set(Ecore_Drm_Output *output, Ecore_Drm_Output_Mode *mode, int x, int y);
EAPI Eina_Bool ecore_drm_output_rotation_set(Ecore_Drm_Output *output, Ecore_Drm_Plane_Type type, unsigned int rotation);
/**
- * Enable key remap functionality on a Ecore_Drm_Evdev
+ * @ingroup Ecore_Drm_Input_Group
+ * @brief Enables key remap functionality on a Ecore_Drm_Evdev
*
* This function will enable the key remap functionality to the given Ecore_Drm_Evdev
*
* @return EINA_FALSE is returned if the Ecore_Drm_Evdev is not valid, or if no libinput device has been
* assigned to it yet. EINA_TRUE will be returned if enabling key remap for this device succeeded.
*
- * @ingroup Ecore_Drm_Input_Group
* @since 1.17
*/
EAPI Eina_Bool ecore_drm_evdev_key_remap_enable(Ecore_Drm_Evdev *edev, Eina_Bool enable);
/**
- * Set a given set of keys as remapped keys on a Ecore_Drm_Evdev
+ * @ingroup Ecore_Drm_Input_Group
+ * @brief Sets a given set of keys as remapped keys on a Ecore_Drm_Evdev
*
* This function will create a hash table of remapping keys as a member of the given Ecore_Drm_Evdev
*
* assigned to it yet, if key remap is not enabled yet, or the some of the given parameters such as
* from_keys, to_keys, num are not valid. EINA_TRUE will be returned if setting key remap for this device succeeded.
*
- * @ingroup Ecore_Drm_Input_Group
* @since 1.17
*/
EAPI Eina_Bool ecore_drm_evdev_key_remap_set(Ecore_Drm_Evdev *edev, int *from_keys, int *to_keys, int num);
/**
* @file Ecore_Evas.h
- * @brief Evas wrapper functions
+ * @brief Evas wrapper functions.
*
* The following is a list of example that partially exemplify Ecore_Evas's API:
* @li @ref ecore_evas_callbacks_example_c
* @{
*/
-/* these are dummy and just tell u what API levels ecore_evas supports - not if
+/* these are dummy and just tell you what API levels ecore_evas supports - not if
* the actual support is compiled in. You need to query for that separately.
*/
#define HAVE_ECORE_EVAS_X 1
EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine);
/**
- * @brief Init the Ecore_Evas system.
+ * @brief Inits the Ecore_Evas system.
*
- * @return How many times the lib has been initialized, 0 indicates failure.
+ * @return How many times the lib has been initialized, @c 0 indicates failure.
*
* Set up the Evas wrapper system. Init Evas and Ecore libraries.
*
*/
EAPI int ecore_evas_init(void);
/**
- * @brief Shut down the Ecore_Evas system.
+ * @brief Shuts down the Ecore_Evas system.
*
- * @return 0 if ecore evas is fully shut down, or > 0 if it still being used.
+ * @return @c 0 if ecore evas is fully shut down, or > @c 0 if it still being used.
*
* This closes the Evas wrapper system down. Shut down Evas and Ecore libraries.
*
EAPI Eina_Bool ecore_evas_app_comp_sync_get(void);
/**
- * @brief Return a list of supported engines names.
+ * @brief Returns a list of supported engines names.
*
* @return Newly allocated list with engines names. Engines names
* strings are internal and should be considered constants, do not
/**
* @brief Free list returned by ecore_evas_engines_get()
*
- * @param engines list with engines names
+ * @param engines List with engines names
*/
EAPI void ecore_evas_engines_free(Eina_List *engines);
/**
- * @brief Create a new Ecore_Evas based on engine name and common parameters.
+ * @brief Creates a new Ecore_Evas based on engine name and common parameters.
*
- * @param engine_name engine name as returned by
+ * @param engine_name Engine name as returned by
* ecore_evas_engines_get() or @c NULL to use environment variable
* ECORE_EVAS_ENGINE, that can be undefined and in this case
* this call will try to find the first working engine.
- * @param x horizontal position of window (not supported in all engines)
- * @param y vertical position of window (not supported in all engines)
- * @param w width of window
- * @param h height of window
- * @param extra_options string with extra parameter, dependent on engines
+ * @param x Horizontal position of window (not supported in all engines)
+ * @param y Vertical position of window (not supported in all engines)
+ * @param w Width of window
+ * @param h Height of window
+ * @param extra_options String with extra parameter, dependent on engines
* or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
* Pay attention that when getting that from shell commands, most
* consider ';' as the command terminator, so you need to escape
*/
EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
/**
- * @brief Set whether an Ecore_Evas has an alpha channel or not.
+ * @brief Sets whether an Ecore_Evas has an alpha channel or not.
*
* @param ee The Ecore_Evas to shape
* @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
*/
EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
/**
- * @brief Query whether an Ecore_Evas has an alpha channel.
+ * @brief Queries whether an Ecore_Evas has an alpha channel.
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
* not.
*/
EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
/**
- * @brief Set whether an Ecore_Evas has an transparent window or not.
+ * @brief Sets whether an Ecore_Evas has an transparent window or not.
*
* @param ee The Ecore_Evas to shape
* @param transparent @c EINA_TRUE to enable the transparent window,
*/
EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent);
/**
- * @brief Query whether an Ecore_Evas is transparent.
+ * @brief Queries whether an Ecore_Evas is transparent.
*
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
*/
EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
/**
- * @brief Get the geometry of an Ecore_Evas.
+ * @brief Gets the geometry of an Ecore_Evas.
*
* @param ee The Ecore_Evas whose geometry y
* @param x A pointer to an int to place the x coordinate in
*/
EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
- * @brief Get the geometry which an Ecore_Evas was latest recently requested.
+ * @brief Gets the geometry which an Ecore_Evas was latest recently requested.
*
* @param ee The Ecore_Evas whose geometry y
* @param x A pointer to an int to place the x coordinate in
*/
EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
- * @brief Set the Ecore_Evas window focus for the default seat.
+ * @brief Sets the Ecore_Evas window focus for the default seat.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
*/
EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Query whether the default seat has the Ecore_Evas focus.
+ * @brief Queries whether the default seat has the Ecore_Evas focus.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
/**
- * @brief Set the Ecore_Evas windows focus for a given seat.
+ * @brief Sets the Ecore_Evas windows focus for a given seat.
*
* @param ee The Ecore_Evas
* @param seat An Efl_Input_Device that represents the seat or @c NULL for the default seat.
EAPI void ecore_evas_focus_device_set(Ecore_Evas *ee, Eo *seat,
Eina_Bool on);
/**
- * @brief Query whether an Ecore_Evas' window is focused or not.
+ * @brief Queries whether an Ecore_Evas' window is focused or not.
*
* @param ee The Ecore_Evas to set
* @param seat An Efl_Input_Device that represents the seat or @c NULL for the default seat.
*/
EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat);
/**
- * @brief Iconify or uniconify an Ecore_Evas' window.
+ * @brief Iconifies or uniconifies an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
*/
EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Query whether an Ecore_Evas' window is iconified or not.
+ * @brief Queries whether an Ecore_Evas' window is iconified or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
/**
- * @brief Set whether an Ecore_Evas' window is borderless or not.
+ * @brief Sets whether an Ecore_Evas' window is borderless or not.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
*/
EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Query whether an Ecore_Evas' window is borderless or not.
+ * @brief Queries whether an Ecore_Evas' window is borderless or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
/**
- * @brief Set whether or not an Ecore_Evas' window is fullscreen.
+ * @brief Sets whether or not an Ecore_Evas' window is fullscreen.
*
* @param ee The Ecore_Evas
* @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
*/
EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Query whether an Ecore_Evas' window is fullscreen or not.
+ * @brief Queries whether an Ecore_Evas' window is fullscreen or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
/**
- * @brief Set another window that this window is a group member of
+ * @brief Sets another window that this window is a group member of.
*
* @param ee The Ecore_Evas
* @param ee_group The other group member
*/
EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group);
/**
- * @brief Get the canvas group set.
+ * @brief Gets the canvas group set.
*
* This returns the handle set by ecore_evas_window_group_set().
*
*/
EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee);
/**
- * @brief Set the aspect ratio of a canvas window
+ * @brief Sets the aspect ratio of a canvas window.
*
* @param ee The Ecore_Evas
* @param aspect The aspect ratio (width divided by height), or 0 to disable
*/
EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect);
/**
- * @brief Get the aspect ratio of a canvas window
+ * @brief Gets the aspect ratio of a canvas window.
*
* This returns the value set by ecore_evas_aspect_set().
*
*/
EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee);
/**
- * @brief Set The urgent hint flag
+ * @brief Sets The urgent hint flag.
*
* @param ee The Ecore_Evas
* @param urgent The urgent state flag
*/
EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent);
/**
- * @brief Get the urgent state on the cavas window
+ * @brief Gets the urgent state on the canvas window.
*
* This returns the value set by ecore_evas_urgent_set()
*
*/
EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee);
/**
- * @brief Set the modal state flag on the canvas window
+ * @brief Sets the modal state flag on the canvas window.
*
* @param ee The Ecore_Evas
* @param modal The modal hint flag
*/
EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal);
/**
- * @brief Get The modal flag
+ * @brief Gets The modal flag.
*
* This returns the value set by ecore_evas_modal_set().
*
*/
EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee);
/**
- * @brief Set the "i demand attention" flag on a canvas window
+ * @brief Sets the "i demand attention" flag on a canvas window.
*
* @param ee The Ecore_Evas
* @param demand The flag state to set
*/
EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand);
/**
- * @brief Get the "i demand attention" flag
+ * @brief Gets the "i demand attention" flag.
*
* This returns the value set by ecore_evas_demand_attention_set().
*
* @param ee The Ecore_Evas to set
- * @return The "i demand attention" flag.
+ * @return The "i demand attention" flag
*
* @see ecore_evas_demand_attention_set()
* @since 1.2
*/
EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee);
/**
- * @brief Set the "focus skip" flag
+ * @brief Sets the "focus skip" flag.
*
* @param ee The Ecore_Evas
* @param skip The "focus skip" state to set.
*/
EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip);
/**
- * @brief Get the "focus skip" flag
+ * @brief Gets the "focus skip" flag.
*
* This returns the value set by ecore_evas_focus_skip_set().
*
* @param ee The Ecore_Evas to set
- * @return The "focus skip" flag.
+ * @return The "focus skip" flag
*
* @see ecore_evas_focus_skip_set()
* @since 1.2
EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee);
/**
- * @brief Set if this evas should ignore @b all events.
+ * @brief Sets if this evas should ignore @b all events.
*
* @param ee The Ecore_Evas whose window's to ignore events.
* @param ignore The Ecore_Evas new ignore state.
*/
EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
/**
- * @brief Return the ignore state of an Ecore_Evas' window.
+ * @brief Returns the ignore state of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose window's ignore events state is returned.
* @return The Ecore_Evas window's ignore state.
*/
EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee);
/**
- * @brief Query whether an Ecore_Evas' window is visible or not.
+ * @brief Queries whether an Ecore_Evas' window is visible or not.
*
* @param ee The Ecore_Evas to query.
- * @return 1 if visible, 0 if not.
+ * @return @c 1 if visible, @c 0 if not.
*
- * This function queries @p ee and returns 1 if it is visible, and 0 if not.
+ * This function queries @p ee and returns @c 1 if it is visible, and @c 0 if not.
*
* @see ecore_evas_show()
* @see ecore_evas_hide()
*/
EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee);
/**
- * @brief Set the layer of an Ecore_Evas' window.
+ * @brief Sets the layer of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
* @param layer The layer to put @p ee on.
*/
EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer);
/**
- * @brief Get the layer of an Ecore_Evas' window.
+ * @brief Gets the layer of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to set
- * @return the layer @p ee's window is on.
+ * @return The layer @p ee's window is on
*
* @see ecore_evas_layer_set()
* @see ecore_evas_lower()
*/
EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
/**
- * @brief Maximize (or unmaximize) an Ecore_Evas' window.
+ * @brief Maximizes (or unmaximizes) an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
- * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize.
+ * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize
*
* This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
* if @p on is @c EINA_FALSE.
*/
EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Query whether an Ecore_Evas' window is maximized or not.
+ * @brief Queries whether an Ecore_Evas' window is maximized or not.
*
* @param ee The Ecore_Evas to set
* @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee);
/**
- * @brief Query if the underlying windowing system supports the window profile.
+ * @brief Queries if the underlying windowing system supports the window profile.
*
* @param ee The Ecore_Evas
* @return @c EINA_TRUE if the window profile is supported, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee);
/**
- * @brief Set the window profile
+ * @brief Sets the window profile.
*
* @param ee The Ecore_Evas to set
* @param profile The string value of the window profile
*/
EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile);
/**
- * @brief Get the window profile
+ * @brief Gets the window profile.
*
* @param ee The Ecore_Evas to get the window profile from.
* @return The string value of the window profile, or NULL if none exists
*/
EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee);
/**
- * @brief Set the array of available window profiles
+ * @brief Sets the array of available window profiles.
*
* @param ee The Ecore_Evas to set
- * @param profiles The string array of available window profiels
+ * @param profiles The string array of available window profiles
* @param count The number of members in profiles
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count);
/**
- * @brief Get the array of available window profiles
+ * @brief Gets the array of available window profiles.
*
* @param ee The Ecore_Evas to get available window profiles from.
* @param profiles Where to return the string array of available window profiles
* @param count Where to return the number of members in profiles
- * @return EINA_TRUE if available window profiles exist, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if available window profiles exist, @c EINA_FALSE otherwise
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.8.0
*/
EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count);
/**
- * @brief Query if the underlying windowing system supports the window manager rotation.
+ * @brief Queries if the underlying windowing system supports the window manager rotation.
*
* @param ee The Ecore_Evas
* @return @c EINA_TRUE if the window manager rotation is supported, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee);
/**
- * @brief Set the preferred rotation hint.
+ * @brief Sets the preferred rotation hint.
*
* @param ee The Ecore_Evas to set
* @param rotation Value to set the preferred rotation hint
*/
EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation);
/**
- * @brief Get the preferred rotation hint.
+ * @brief Gets the preferred rotation hint.
*
* @param ee The Ecore_Evas to get the preferred rotation hint from.
- * @return The preferred rotation hint, -1 on failure.
+ * @return The preferred rotation hint, @c -1 on failure.
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.9.0
*/
EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee);
/**
- * @brief Set the array of available window rotations.
+ * @brief Sets the array of available window rotations.
*
* @param ee The Ecore_Evas to set
* @param rotations The integer array of available window rotations
*/
EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count);
/**
- * @brief Get the array of available window rotations.
+ * @brief Gets the array of available window rotations.
*
* @param ee The Ecore_Evas to get available window rotations from.
* @param rotations Where to return the integer array of available window rotations
* @param count Where to return the number of members in rotations
- * @return EINA_TRUE if available window rotations exist, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if available window rotations exist, @c EINA_FALSE otherwise
*
* @warning Support for this depends on the underlying windowing system.
* @since 1.9.0
*/
EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count);
/**
- * @brief Set manual rotation done mode of Ecore_Evas's window
+ * @brief Sets manual rotation done mode of Ecore_Evas's window.
*
* @param ee The Ecore_Evas
* @param set If true, the window manager will not rotate the Ecore_Evas's window until
*/
EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set);
/**
- * @brief Get manual rotation done mode of Ecore_Evas's window
+ * @brief Gets manual rotation done mode of Ecore_Evas's window.
*
* @param ee The Ecore_Evas
* @return If true, the manual rotation done mode is enabled
*/
EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee);
/**
- * @brief Set rotation finish manually
+ * @brief Sets rotation finish manually.
*
* @param ee The Ecore_Evas
*
*/
EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee);
/**
- * @brief Get the list of supported auxiliary hint strings.
+ * @brief Gets the list of supported auxiliary hint strings.
*
* @param ee The Ecore_Evas
* @return List of supported auxiliary hint strings.
*/
EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee);
/**
- * @brief Get the list of allowed auxiliary hint ID.
+ * @brief Gets the list of allowed auxiliary hint ID.
*
* @param ee The Ecore_Evas
* @return List of allowed auxiliary hint ID.
*/
EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee);
/**
- * @brief Create an auxiliary hint of the Ecore_Evas.
+ * @brief Creates an auxiliary hint of the Ecore_Evas.
*
* @param ee The Ecore_Evas
* @param hint The auxiliary hint string.
* @param val The value string.
- * @return The ID of created auxiliary hint, or -1 on failure.
+ * @return The ID of created auxiliary hint, or @c -1 on failure.
* @warning Support for this depends on the underlying windowing system.
*
* @since 1.10.0
*/
EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, const char *val);
/**
- * @brief Delete an auxiliary hint of the Ecore_Evas.
+ * @brief Deletes an auxiliary hint of the Ecore_Evas.
*
* @param ee The Ecore_Evas
* @param id The ID of the auxiliary hint.
- * @return EINA_TRUE if no error occurred, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
* @warning Support for this depends on the underlying windowing system.
*
* @since 1.10.0
*/
EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id);
/**
- * @brief Change a value of the auxiliary hint.
+ * @brief Changes a value of the auxiliary hint.
*
* @param ee The Ecore_Evas
* @param id The auxiliary hint ID.
* @param val The value string to be set.
- * @return EINA_TRUE if no error occurred, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
* @warning Support for this depends on the underlying windowing system.
*
* @since 1.10.0
*/
EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, const char *val);
/**
- * @brief Get a value of the auxiliary hint.
+ * @brief Gets a value of the auxiliary hint.
*
* @param ee The Ecore_Evas
* @param id The auxiliary hint ID.
*/
EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id);
/**
- * @brief Get a ID of the auxiliary hint string.
+ * @brief Gets a ID of the auxiliary hint string.
*
* @param ee The Ecore_Evas
* @param hint The auxiliary hint string.
- * @return The ID of the auxiliary hint string, or -1 if none exists
+ * @return The ID of the auxiliary hint string, or @c -1 if none exists
* @warning Support for this depends on the underlying windowing system.
*
* @since 1.15
EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const char *hint);
/**
- * @brief Send message to parent ecore
+ * @brief Sends message to parent ecore.
*
* @param ee The Ecore_Evas to set
* @param msg_domain The domain of message
*/
EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size);
/**
- * @brief Send message to child ecore
+ * @brief Sends message to child ecore.
*
* @param ee The Ecore_Evas to set
* @param msg_domain The domain of message
*/
EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size);
/**
- * @brief Set a callback for parent Ecore_Evas message.
+ * @brief Sets a callback for parent Ecore_Evas message.
*
* @param ee The Ecore_Evas to set callbacks on
* @param func_parent_handle The handle to be called when message arive.
*/
EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_parent_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size));
/**
- * @brief Set a callback for child Ecore_Evas message.
+ * @brief Sets a callback for child Ecore_Evas message.
*
* @param ee The Ecore_Evas to set callbacks on
* @param func_handle The handle to be called when message arive
EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size));
/**
- * @brief Move an Ecore_Evas.
+ * @brief Moves an Ecore_Evas.
*
* @param ee The Ecore_Evas to move
* @param x The x coordinate to move to
*/
EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y);
/**
- * @brief Resize an Ecore_Evas.
+ * @brief Resizes an Ecore_Evas.
*
* @param ee The Ecore_Evas to move
* @param w The w coordinate to resize to
*/
EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
/**
- * @brief Move and resize an Ecore_Evas
+ * @brief Moves and resizes an Ecore_Evas.
*
* @param ee The Ecore_Evas to move and resize
* @param x The x coordinate to move to
* @param w The w coordinate to resize to
* @param h The h coordinate to resize to
*
- * This moves @p ee to the screen coordinates (@p x, @p y) and resizes
+ * This moves @p ee to the screen coordinates (@p x, @p y) and resizes
* it to @p w x @p h.
*
* @warning Support for this depends on the underlying windowing system.
*/
EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
/**
- * @brief Set the rotation of an Ecore_Evas' window.
+ * @brief Sets the rotation of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
- * @param rot the angle (in degrees) of rotation.
+ * @param rot The angle (in degrees) of rotation
*
* The allowed values of @p rot depend on the engine being used. Most only
* allow multiples of 90.
*/
EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
/**
- * @brief Set the rotation of an Ecore_Evas' window
+ * @brief Sets the rotation of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas
- * @param rot the angle (in degrees) of rotation.
+ * @param rot The angle (in degrees) of rotation.
*
* Like ecore_evas_rotation_set(), but it also resizes the window's contents so
* that they fit inside the current window geometry.
*/
EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot);
/**
- * @brief Get the rotation of an Ecore_Evas' window
+ * @brief Gets the rotation of an Ecore_Evas' window
*
* @param ee The Ecore_Evas
- * @return the angle (in degrees) of rotation.
+ * @return The angle (in degrees) of rotation
*
* @see ecore_evas_rotation_set()
* @see ecore_evas_rotation_with_resize_set()
*/
EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee);
/**
- * @brief Raise an Ecore_Evas' window.
+ * @brief Raises an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to raise.
*
*/
EAPI void ecore_evas_raise(Ecore_Evas *ee);
/**
- * @brief Lower an Ecore_Evas' window.
+ * @brief Lowers an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to raise.
*
*/
EAPI void ecore_evas_lower(Ecore_Evas *ee);
/**
- * @brief Set the title of an Ecore_Evas' window.
+ * @brief Sets the title of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose title you wish to set.
* @param t The title
*/
EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t);
/**
- * @brief Get the title of an Ecore_Evas' window.
+ * @brief Gets the title of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose title you wish to get.
* @return The title of @p ee.
*/
EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
/**
- * @brief Set the name and class of an Ecore_Evas' window.
+ * @brief Sets the name and class of an Ecore_Evas' window.
*
* @param ee the Ecore_Evas
- * @param n the name
- * @param c the class
+ * @param n The name
+ * @param c The class
*
* This function sets the name of @p ee to @p n, and its class to @p c. The
* meaning of @p name and @p class depends on the underlying windowing system.
*/
EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
/**
- * @brief Get the name and class of an Ecore_Evas' window
+ * @brief Gets the name and class of an Ecore_Evas' window.
*
* This function gets the name of @p ee into @p n, and its class into
* @p c.
*/
EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
/**
- * @brief Return a pointer to the underlying window.
+ * @brief Returns a pointer to the underlying window.
*
* @param ee The Ecore_Evas whose window is desired.
* @return A pointer to the underlying window.
/* engine/target specific init calls */
/**
- * @brief Create Ecore_Evas using software x11.
+ * @brief Creates Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
* @param disp_name The name of the Ecore_Evas to be created.
* @param parent The parent of the Ecore_Evas to be created.
EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
/**
- * @brief Get the window from Ecore_Evas using software x11.
+ * @brief Gets the window from Ecore_Evas using software x11.
* @note If ecore is not compiled with support for x11 or if @p ee was not
* created with ecore_evas_software_x11_new() then nothing is done and
* 0 is returned.
EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
/**
- * @brief Set the direct_resize of Ecore_Evas using software x11.
+ * @brief Sets the direct_resize of Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas in which to set direct resize.
- * @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.
+ * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE.
*/
EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Get if the Ecore_Evas is being directly resized using software x11.
+ * @brief Gets if the Ecore_Evas is being directly resized using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned.
* @param ee The Ecore_Evas from which to get direct resize.
- * @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.
+ * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE.
*/
EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
/**
- * @brief Add extra window on Ecore_Evas using software x11.
+ * @brief Adds extra window on Ecore_Evas using software x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas on which to add the window.
* @param win The window to be added at the Ecore_Evas.
EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
/**
- * @brief Create a new Ecore_Evas which does not contain an XWindow. It will
+ * @brief Creates a new Ecore_Evas which does not contain an XWindow. It will
* only contain an XPixmap to render to
*
* @warning The XPixmap ID can change with every frame after it is rendered,
EAPI Ecore_Evas *ecore_evas_software_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
/**
- * @brief Return the underlying Ecore_X_Pixmap used in the Ecore_Evas
+ * @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.
*
* @param ee The Ecore_Evas whose pixmap is desired.
* @return The underlying Ecore_X_Pixmap
#define ECORE_EVAS_GL_X11_SWAP_MODE_TRIPLE 4
/**
- * @brief Create Ecore_Evas using opengl x11.
+ * @brief Creates Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
* @param disp_name The name of the display of the Ecore_Evas to be created.
* @param parent The parent of the Ecore_Evas to be created.
EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt);
/**
- * @brief Get the window from Ecore_Evas using opengl x11.
+ * @brief Gets the window from Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support for x11 or if @p ee was not
* created with ecore_evas_gl_x11_new() then nothing is done and
* 0 is returned.
EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
/**
- * @brief Set direct_resize for Ecore_Evas using opengl x11.
+ * @brief Sets direct_resize for Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas in which to set direct resize.
- * @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE.
+ * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE.
*/
EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Get if the Ecore_Evas is being directly resized using opengl x11.
+ * @brief Gets if the Ecore_Evas is being directly resized using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned.
* @param ee The Ecore_Evas from which to get direct resize.
- * @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE.
+ * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE.
*/
EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
/**
- * @brief Add extra window on Ecore_Evas using opengl x11.
+ * @brief Adds extra window on Ecore_Evas using opengl x11.
* @note If ecore is not compiled with support to x11 then nothing is done.
* @param ee The Ecore_Evas for which to add the window.
* @param win The window to be added at the Ecore_Evas.
EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
/**
- * @brief Set the functions to be used before and after the swap callback.
+ * @brief Sets the functions to be used before and after the swap callback.
* @note If ecore is not compiled with support to x11 then nothing is done and the function is returned.
* @param ee The Ecore_Evas for which to set the swap callback.
* @param data The data for which to set the swap callback.
EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee, void *data, void (*pre_cb) (void *data, Evas *e), void (*post_cb) (void *data, Evas *e));
/**
- * @brief Create a new Ecore_Evas which does not contain an XWindow. It will
- * only contain an XPixmap to render to
+ * @brief Creates a new Ecore_Evas which does not contain an XWindow. It will
+ * only contain an XPixmap to render to.
*
* @warning The XPixmap ID can change with every frame after it is rendered,
* so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you
EAPI Ecore_Evas *ecore_evas_gl_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
/**
- * @brief Return the underlying Ecore_X_Pixmap used in the Ecore_Evas
+ * @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.
*
* @param ee The Ecore_Evas whose pixmap is desired.
* @return The underlying Ecore_X_Pixmap
EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED;
/**
- * @brief Create Ecore_Evas using fb backend.
+ * @brief Creates Ecore_Evas using fb backend.
* @param disp_name The name of the display to be used.
* @param rotation The rotation to be used.
* @param w The width of the Ecore_Evas to be created.
EAPI Ecore_Evas *ecore_evas_gl_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); /** @since 1.12 */
/**
- * @brief Create a new @c Ecore_Evas canvas bound to the Evas
+ * @brief Creates a new @c Ecore_Evas canvas bound to the Evas.
* @b buffer engine
*
* @param w The width of the canvas, in pixels
EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h);
/**
- * @brief Create a new @c Ecore_Evas canvas bound to the Evas
+ * @brief Creates a new @c Ecore_Evas canvas bound to the Evas.
* @b buffer engine, giving custom allocation and freeing functions for
* the canvas memory region
*
EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc_func) (void *data, int size), void (*free_func) (void *data, void *pix), const void *data);
/**
- * @brief Grab a pointer to the actual pixels array of a given
+ * @brief Grabs a pointer to the actual pixels array of a given
* @c Ecore_Evas @b buffer canvas/window.
*
* @param ee An @c Ecore_Evas handle
EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
/**
- * @brief Return a pointer to the Ecore_Evas parent of the given Ecore_Evas.
+ * @brief Returns a pointer to the Ecore_Evas parent of the given Ecore_Evas.
*
* @param ee An @c Ecore_Evas handle
* @return A pointer to the Ecore_Evas parent.
EAPI Ecore_Evas *ecore_evas_buffer_ecore_evas_parent_get(Ecore_Evas *ee);
/**
- * @brief Create a new @c Ecore_Evas canvas bound to the Evas
+ * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
* @b ews (Ecore + Evas Single Process Windowing System) engine
*
* EWS is a simple single process windowing system. The backing store
* ecore_evas_new("ews"...)) will all be software buffer windows
* automatic rendered to the backing store.
*
- * @param x horizontal position of window, in pixels
- * @param y vertical position of window, in pixels
+ * @param x Horizontal position of window, in pixels
+ * @param y Vertical position of window, in pixels
* @param w The width of the canvas, in pixels
* @param h The height of the canvas, in pixels
* @return A new @c Ecore_Evas instance or @c NULL, on failure
/**
- * @brief Return the backing store image object that represents the given
+ * @brief Returns the backing store image object that represents the given
* window in EWS.
* @return The evas object of EWS backing store.
*
EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
/**
- * @brief Call the window to be deleted (freed), but can let user decide to
- * forbid it by using ecore_evas_callback_delete_request_set()
+ * @brief Calls the window to be deleted (freed), but can let user decide to
+ * forbid it by using ecore_evas_callback_delete_request_set().
*
* @param ee The Ecore_Evas for which window will be deleted.
* @since 1.1
EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
/**
- * @brief Create an Evas image object with image data <b>bound to an
+ * @brief Creates an Evas image object with image data <b>bound to an
* own, internal @c Ecore_Evas canvas wrapper</b>
*
* @param ee_target @c Ecore_Evas to have the canvas receiving the new
EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target);
/**
- * @brief Retrieve the internal @c Ecore_Evas handle of an image
- * object created via ecore_evas_object_image_new()
+ * @brief Retrieves the internal @c Ecore_Evas handle of an image
+ * object created via ecore_evas_object_image_new().
*
* @param obj A handle to an image object created via
* ecore_evas_object_image_new()
/* generic manipulation calls */
/**
- * @brief Get the engine name used by this Ecore_Evas(window).
+ * @brief Gets the engine name used by this Ecore_Evas(window).
*
- * @param ee Ecore_Evas whose engine's name is desired.
+ * @param ee Ecore_Evas whose engine's name is desired
* @return A string that can(usually) be used in ecore_evas_new()
*
* @see ecore_evas_free()
*/
EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
/**
- * @brief Return the Ecore_Evas for this Evas
+ * @brief Returns the Ecore_Evas for this Evas.
*
* @param e The Evas to get the Ecore_Evas from
* @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
*/
EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
/**
- * @brief Free an Ecore_Evas
+ * @brief Frees an Ecore_Evas.
*
* @param ee The Ecore_Evas to free
*
*/
EAPI void ecore_evas_free(Ecore_Evas *ee);
/**
- * @brief Retrieve user data associated with an Ecore_Evas.
+ * @brief Retrieves user data associated with an Ecore_Evas.
*
* @param ee The Ecore_Evas to retrieve the user data from.
* @param key The key which the user data to be retrieved is associated with.
* This function retrieves user specific data that has been stored within an
* Ecore_Evas structure with ecore_evas_data_set().
*
- * @returns @c NULL on error or no data found, A pointer to the user data on
+ * @return @c NULL on error or no data found, A pointer to the user data on
* success.
*
* @see ecore_evas_data_set()
*/
EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
/**
- * @brief Store user data in an Ecore_Evas structure.
+ * @brief Stores user data in an Ecore_Evas structure.
*
* @param ee The Ecore_Evas to store the user data in.
* @param key A unique string to associate the user data against. Cannot
*/
EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
/**
- * @brief Set a callback for Ecore_Evas resize events.
+ * @brief Sets a callback for Ecore_Evas resize events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas move events.
+ * @brief Sets a callback for Ecore_Evas move events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas show events.
+ * @brief Sets a callback for Ecore_Evas show events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas hide events.
+ * @brief Sets a callback for Ecore_Evas hide events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas delete request events.
+ * @brief Sets a callback for Ecore_Evas delete request events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas destroy events.
+ * @brief Sets a callback for Ecore_Evas destroy events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas focus in events.
+ * @brief Sets a callback for Ecore_Evas focus in events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas focus out events.
+ * @brief Sets a callback for Ecore_Evas focus out events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas focus in events.
+ * @brief Sets a callback for Ecore_Evas focus in events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas focus out events.
+ * @brief Sets a callback for Ecore_Evas focus out events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas sticky events.
+ * @brief Sets a callback for Ecore_Evas sticky events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas un-sticky events.
+ * @brief Sets a callback for Ecore_Evas un-sticky events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas mouse in events.
+ * @brief Sets a callback for Ecore_Evas mouse in events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func);
/**
- * @brief Set a callback for Ecore_Evas mouse out events.
+ * @brief Sets a callback for Ecore_Evas mouse out events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_device_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func);
/**
- * @brief Set a callback for Ecore_Evas mouse in events.
+ * @brief Sets a callback for Ecore_Evas mouse in events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas mouse out events.
+ * @brief Sets a callback for Ecore_Evas mouse out events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas pre render events.
+ * @brief Sets a callback for Ecore_Evas pre render events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas mouse post render events.
+ * @brief Sets a callback for Ecore_Evas mouse post render events.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*/
EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas pre-free event.
+ * @brief Sets a callback for Ecore_Evas pre-free event.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
*
*/
EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Set a callback for Ecore_Evas state changes.
+ * @brief Sets a callback for Ecore_Evas state changes.
* @param ee The Ecore_Evas to set callbacks on
* @param func The function to call
EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
/**
- * @brief Get an Ecore_Evas's Evas
+ * @brief Gets an Ecore_Evas's Evas.
* @param ee The Ecore_Evas whose Evas you wish to get
* @return The Evas wrapped by @p ee
*
EAPI Evas *ecore_evas_get(const Ecore_Evas *ee);
/**
- * @brief Provide Managed move co-ordinates for an Ecore_Evas
+ * @brief Provides Managed move co-ordinates for an Ecore_Evas.
* @param ee The Ecore_Evas to move
* @param x The x coordinate to set as the managed location
* @param y The y coordinate to set as the managed location
EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
/**
- * @brief Set whether an Ecore_Evas is shaped or not.
+ * @brief Sets whether an Ecore_Evas is shaped or not.
*
* @param ee The Ecore_Evas to shape.
* @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
/**
- * @brief Query whether an Ecore_Evas is shaped or not.
+ * @brief Queries whether an Ecore_Evas is shaped or not.
*
* @param ee The Ecore_Evas to query.
* @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
*/
EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee);
/**
- * @brief Show an Ecore_Evas' window
+ * @brief Shows an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to show.
*
*/
EAPI void ecore_evas_show(Ecore_Evas *ee);
/**
- * @brief Hide an Ecore_Evas' window
+ * @brief Hides an Ecore_Evas' window.
*
* @param ee The Ecore_Evas to hide.
*
EAPI void ecore_evas_hide(Ecore_Evas *ee);
/**
- * @brief Activate (set focus to, via the window manager) an Ecore_Evas' window.
+ * @brief Activates (set focus to, via the window manager) an Ecore_Evas' window.
* @param ee The Ecore_Evas to activate.
*
* This functions activates the Ecore_Evas.
/**
- * @brief Set the minimum size of a given @c Ecore_Evas window
+ * @brief Sets the minimum size of a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w The minimum width
EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
/**
- * @brief Get the minimum size set for a given @c Ecore_Evas window
+ * @brief Gets the minimum size set for a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the minimum width in.
EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
/**
- * @brief Set the maximum size of a given @c Ecore_Evas window
+ * @brief Sets the maximum size of a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w The maximum width
EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
/**
- * @brief Get the maximum size set for a given @c Ecore_Evas window
+ * @brief Gets the maximum size set for a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the maximum width in.
EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
/**
- * @brief Set the base size for a given @c Ecore_Evas window
+ * @brief Sets the base size for a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w The base width
EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
/**
- * @brief Get the base size set for a given @c Ecore_Evas window
+ * @brief Gets the base size set for a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the base width in.
EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
/**
- * @brief Set the "size step" for a given @c Ecore_Evas window
+ * @brief Sets the "size step" for a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w The step width
EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
/**
- * @brief Get the "size step" set for a given @c Ecore_Evas window
+ * @brief Gets the "size step" set for a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas window's handle
* @param w A pointer to an int to place the step width in.
EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
/**
- * @brief Set the cursor for the default pointer device.
+ * @brief Sets the cursor for the default pointer device.
*
* @param ee The Ecore_Evas
* @param file The path to an image file for the cursor.
*/
EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
/**
- * @brief Get information about an Ecore_Evas' default pointer device.
+ * @brief Gets information about an Ecore_Evas' default pointer device.
*
* @param ee The Ecore_Evas to get
* @param obj A pointer to an Evas_Object to place the cursor Evas_Object.
EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
/**
- * @brief Set the cursor for the default pointer device.
+ * @brief Sets the cursor for the default pointer device.
*
* @param ee The Ecore_Evas
* @param obj The Evas_Object which will be the cursor.
EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
/**
- * @brief Unset the cursor of the default pointer device.
+ * @brief Unsets the cursor of the default pointer device.
*
* @param ee The Ecore_Evas to unset the cursor.
*
EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee);
/**
- * @brief Set the cursor of an Ecore_Evas specified pointer device.
+ * @brief Sets the cursor of an Ecore_Evas specified pointer device.
*
* @param ee The Ecore_Evas
* @param pointer A pointer device to set the cursor. Use @c NULL for the default.
Evas_Object *obj, int layer,
int hot_x, int hot_y);
/**
- * @brief Get information about an Ecore_Evas' specified pointer device.
+ * @brief Gets information about an Ecore_Evas' specified pointer device.
*
* @param ee The Ecore_Evas
* @param pointer A pointer device to set the cursor. Use @c NULL for the default.
int *hot_x, int *hot_y);
/**
- * @brief Tell the WM whether or not to ignore an Ecore_Evas' window
+ * @brief Tells the WM whether or not to ignore an Ecore_Evas' window.
*
* @param ee The Ecore_Evas.
* @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
/**
- * @brief Query whether an Ecore_Evas' window is overridden or not
+ * @brief Queries whether an Ecore_Evas' window is overridden or not.
*
* @param ee The Ecore_Evas to set.
* @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee);
/**
- * @brief Set whether or not an Ecore_Evas' window should avoid damage
+ * @brief Sets whether or not an Ecore_Evas' window should avoid damage.
*
* @param ee The Ecore_Evas
* @param on The type of the damage management
EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
/**
- * @brief Query whether an Ecore_Evas' window avoids damage or not
+ * @brief Queries whether an Ecore_Evas' window avoids damage or not.
* @param ee The Ecore_Evas to set
* @return The type of the damage management
*
EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
/**
- * @brief Set the withdrawn state of an Ecore_Evas' window.
+ * @brief Sets the withdrawn state of an Ecore_Evas' window.
* @param ee The Ecore_Evas whose window's withdrawn state is set.
* @param withdrawn The Ecore_Evas window's new withdrawn state.
*
EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
/**
- * @brief Return the withdrawn state of an Ecore_Evas' window.
+ * @brief Returns the withdrawn state of an Ecore_Evas' window.
* @param ee The Ecore_Evas whose window's withdrawn state is returned.
* @return The Ecore_Evas window's withdrawn state.
*
EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee);
/**
- * @brief Set the sticky state of an Ecore_Evas window.
+ * @brief Sets the sticky state of an Ecore_Evas window.
*
* @param ee The Ecore_Evas whose window's sticky state is set.
* @param sticky The Ecore_Evas window's new sticky state.
EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
/**
- * @brief Return the sticky state of an Ecore_Evas' window.
+ * @brief Returns the sticky state of an Ecore_Evas' window.
*
* @param ee The Ecore_Evas whose window's sticky state is returned.
* @return The Ecore_Evas window's sticky state.
EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee);
/**
- * @brief Enable/disable manual render
+ * @brief Enables/disables manual render.
*
* @param ee An @c Ecore_Evas handle
* @param manual_render Enable/disable manual render. @c EINA_TRUE to enable
EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render);
/**
- * @brief Get enable/disable status of manual render
+ * @brief Gets enable/disable status of manual render.
*
* @param ee An @c Ecore_Evas handle
* @return @c EINA_TRUE if manual render is enabled, @c EINA_FALSE if manual
EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee);
/**
- * @brief Register an @c Ecore_Evas to receive events through ecore_input_evas.
+ * @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas.
*
* @param ee The @c Ecore_Evas handle.
*
*/
EAPI void ecore_evas_input_event_register(Ecore_Evas *ee);
/**
- * @brief Unregister an @c Ecore_Evas receiving events through ecore_input_evas.
+ * @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas.
*
* @param ee The @c Ecore_Evas handle.
*
EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee);
/**
- * @brief Force immediate rendering on a given @c Ecore_Evas window
+ * @brief Forces immediate rendering on a given @c Ecore_Evas window.
*
* @param ee An @c Ecore_Evas handle
*
EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
/**
- * @brief Get geometry of screen associated with this Ecore_Evas.
+ * @brief Gets geometry of screen associated with this Ecore_Evas.
*
* @param ee The Ecore_Evas whose window's to query container screen geometry.
- * @param x where to return the horizontal offset value. May be @c NULL.
- * @param y where to return the vertical offset value. May be @c NULL.
- * @param w where to return the width value. May be @c NULL.
- * @param h where to return the height value. May be @c NULL.
+ * @param x Where to return the horizontal offset value. May be @c NULL.
+ * @param y Where to return the vertical offset value. May be @c NULL.
+ * @param w Where to return the width value. May be @c NULL.
+ * @param h Where to return the height value. May be @c NULL.
*
* @since 1.1
*/
EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
- * @brief Get the dpi of the screen the Ecore_Evas is primarily on.
+ * @brief Gets the dpi of the screen the Ecore_Evas is primarily on.
*
* @param ee The Ecore_Evas whose window's to query.
* @param xdpi Pointer to integer to store horizontal DPI. May be @c NULL.
EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee) EINA_DEPRECATED;
/**
- * @brief Set shadow geometry for client-side decorations
+ * @brief Sets shadow geometry for client-side decorations.
*
* Note that the framespace contains both a shadow or glow around the window,
* and the window borders (title bar, etc...).
EAPI void ecore_evas_shadow_geometry_set(Ecore_Evas *ee, int x, int y, int w, int h);
/**
- * @brief Get shadow geometry for client-side decorations
+ * @brief Gets shadow geometry for client-side decorations.
*
* Note that the framespace contains both a shadow or glow around the window,
* and the window borders (title bar, etc...).
EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
/**
- * @brief Associate the given object to this ecore evas.
+ * @brief Associates the given object to this ecore evas.
*
* @param ee The Ecore_Evas to associate to @a obj
* @param obj The object to associate to @a ee
*/
EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
/**
- * @brief Cancel the association set with ecore_evas_object_associate().
+ * @brief Cancels the association set with ecore_evas_object_associate().
*
* @param ee The Ecore_Evas to dissociate from @a obj
* @param obj The object to dissociate from @a ee
*/
EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
/**
- * @brief Get the object associated with @p ee
+ * @brief Gets the object associated with @p ee.
*
* @param ee The Ecore_Evas to get the object from.
* @return The associated object, or @c NULL if there is no associated object.
EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage);
/**
- * @brief Get a list of all the ecore_evases.
+ * @brief Gets a list of all the ecore_evases.
*
* @return A list of ecore_evases.
*
*/
EAPI Eina_List *ecore_evas_ecore_evas_list_get(void);
/**
- * @brief Get a list of all the sub ecore_evases.
+ * @brief Gets a list of all the sub ecore_evases.
*
* @param ee Ecore_Evas to get the list from.
* @return A list of sub ecore_evases, or @c NULL if there is no sub ecore_evases.
Ecore_Evas_Vnc_Client_Disconnected_Cb disc_cb, void *data);
/**
- * @brief Stop a running VNC server
+ * @brief Stops a running VNC server
*
* @param ee Ecore_Evas to stop the VNC server
* @return @c EINA_TRUE if the VNC server was stopped, @c EINA_FALSE otherwise.
*/
/**
- * @brief Set the engine to be used by the backing store engine.
+ * @brief Sets the engine to be used by the backing store engine.
*
* @param engine The engine to be set.
* @param options The options of the engine to be set.
EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
/**
- * @brief Reconfigure the backing store used.
+ * @brief Reconfigures the backing store used.
*
* @param x The X coordinate to be used.
* @param y The Y coordinate to be used.
EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
/**
- * @brief Return the internal backing store in use.
+ * @brief Returns the internal backing store in use.
*
* @return The internal backing store in use.
* @note this will forced it to be created, making future calls to
EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
/**
- * @brief Return the internal backing store in use.
+ * @brief Returns the internal backing store in use.
*
* @return The internal backing store in use.
* @note this will forced it to be created, making future calls to
EAPI Evas *ecore_evas_ews_evas_get(void);
/**
- * @brief Get the current background.
+ * @brief Gets the current background.
*/
EAPI Evas_Object *ecore_evas_ews_background_get(void);
/**
- * @brief Set the current background, must be created at evas ecore_evas_ews_evas_get()
+ * @brief Sets the current background, must be created at evas ecore_evas_ews_evas_get().
*
* It will be kept at lowest layer (EVAS_LAYER_MIN) and below
* everything else. You can set any object, default is a black
EAPI void ecore_evas_ews_background_set(Evas_Object *o);
/**
- * @brief Return all Ecore_Evas* created by EWS.
+ * @brief Returns all Ecore_Evas* created by EWS.
*
* @return An eina list of Ecore_evases.
- e @note Do not change the returned list or its contents.
+ * @note Do not change the returned list or its contents.
* @since 1.1
*/
EAPI const Eina_List *ecore_evas_ews_children_get(void);
/**
- * @brief Set the identifier of the manager taking care of internal windows.
+ * @brief Sets the identifier of the manager taking care of internal windows.
*
* The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider
* handling it to know if you should stop handling events yourself
EAPI void ecore_evas_ews_manager_set(const void *manager);
/**
- * @brief Get the identifier of the manager taking care of internal windows.
+ * @brief Gets the identifier of the manager taking care of internal windows.
*
* @return the value set by ecore_evas_ews_manager_set()
* @since 1.1
EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */
/**
- * @brief Create a new Ecore_Evas canvas for the new external ecore evas socket
+ * @brief Creates a new Ecore_Evas canvas for the new external ecore evas socket
*
* @param w The width of the canvas, in pixels
* @param h The height of the canvas, in pixels
- * @return A new @c Ecore_Evas instance or @c NULL, on failure
+ * @return A new @c Ecore_Evas instance, or @c NULL on failure
*
* This creates a new extn_socket canvas wrapper, with image data array
* @b bound to the ARGB format, 8 bits per pixel.
* Note that events come in later after the event happened. You may want to be
* careful as data structures you had associated with the image object
* may have been freed after deleting, but the object may still be around
- * awating cleanup and thus still be valid.You can change the size with something like:
+ * awaiting cleanup and thus still be valid.You can change the size with something like:
*
* @see ecore_evas_extn_socket_listen()
* @see ecore_evas_extn_plug_new()
EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
/**
- * @brief Create a socket to provide the service for external ecore evas
+ * @brief Creates a socket to provide the service for external ecore evas
* socket.
*
* @param ee The Ecore_Evas.
EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys);
/**
- * @brief Set the blocking about mouse events to Ecore Evas.
+ * @brief Sets the blocking about mouse events to Ecore Evas.
*
* @param ee The Ecore_Evas.
* @param events_block The blocking about mouse events.
EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool events_block);
/**
- * @brief Get the blocking about mouse events to Ecore Evas.
+ * @brief Gets the blocking about mouse events to Ecore Evas.
*
* @param ee The Ecore_Evas.
EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee);
/**
- * @brief Lock the pixel data so the socket cannot change it
+ * @brief Locks the pixel data so the socket cannot change it.
*
* @param obj The image object returned by ecore_evas_extn_plug_new() to lock
*
EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj);
/**
- * @brief Unlock the pixel data so the socket can change it again.
+ * @brief Unlocks the pixel data so the socket can change it again.
*
* @param obj The image object returned by ecore_evas_extn_plug_new() to unlock
*
EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
/**
- * @brief Create a new external ecore evas plug
+ * @brief Creates a new external ecore evas plug.
*
* @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
* @return An evas image object that will contain the image output of a socket.
EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
/**
- * @brief Connect an external ecore evas plug to service provided by external
+ * @brief Connects an external ecore evas plug to service provided by external
* ecore evas socket.
*
* @param obj The Ecore_Evas containing the canvas in which the new image
EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
/**
- * @brief Retrieve the coordinates of the default mouse pointer
+ * @brief Retrieves the coordinates of the default mouse pointer.
*
* @param ee The Ecore_Evas containing the pointer
* @param x Pointer to integer to store horizontal coordinate. May be @c NULL.
EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Coord *y);
/**
- * @brief Set the coordinates of the mouse pointer
+ * @brief Sets the coordinates of the mouse pointer.
*
* @param ee The Ecore_Evas containing the pointer
* @param x The horizontal coordinate to move the pointer to
EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y);
/**
- * @brief Retrieve the coordinates of the mouse pointer
+ * @brief Retrieves the coordinates of the mouse pointer.
*
* @param ee The Ecore_Evas containing the pointer
* @param pointer The pointer device, use @c NULL for the default pointer.
EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input_Device *pointer, Evas_Coord *x, Evas_Coord *y);
/**
- * @brief Retrieve the Visual used for pixmap creation
+ * @brief Retrieves the Visual used for pixmap creation.
*
* @param ee The Ecore_Evas containing the pixmap
*
EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee);
/**
- * @brief Retrieve the Colormap used for pixmap creation
+ * @brief Retrieves the Colormap used for pixmap creation.
*
* @param ee The Ecore_Evas containing the pixmap
*
EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee);
/**
- * @brief Retrieve the depth used for pixmap creation
+ * @brief Retrieves the depth used for pixmap creation.
*
* @param ee The Ecore_Evas containing the pixmap
*
/**
* @file Ecore_File.h
- * @brief Files utility functions
+ * @brief Files utility functions.
*/
#ifdef __cplusplus
/* File operations */
/**
- * @brief Initialize the Ecore_File library.
+ * @brief Initializes the Ecore_File library.
*
- * @return 1 or greater on success, 0 on error.
+ * @return @c 1 or greater on success, otherwise @c 0 on error.
*
* This function sets up Ecore_File and the services it will use
* (monitoring, downloading, PATH related feature). It returns 0 on
EAPI int ecore_file_init (void);
/**
- * @brief Shut down the Ecore_File library.
+ * @brief Shuts down the Ecore_File library.
*
- * @return 0 when the library is completely shut down, 1 or
+ * @return @c 0 when the library is completely shut down, @c 1 or
* greater otherwise.
*
* This function shuts down the Ecore_File library. It returns 0 when it has
EAPI int ecore_file_shutdown (void);
/**
- * @brief Get the time of the last modification to the given file.
+ * @brief Gets the time of the last modification to the given file.
*
* @param file The name of the file.
- * @return Return the time of the last data modification, or 0 on
+ * @return Return the time of the last data modification, or @c 0 on
* failure.
*
* This function returns the time of the last modification of
EAPI long long ecore_file_mod_time (const char *file);
/**
- * @brief Get the size of the given file.
+ * @brief Gets the size of the given file.
*
* @param file The name of the file.
- * @return Return the size of the file in bytes, or 0 on failure.
+ * @return Return the size of the file in bytes, or @c 0 on failure.
*
* This function returns the size of @p file in bytes. On failure, it
* returns 0.
EAPI long long ecore_file_size (const char *file);
/**
- * @brief Check if the given file exists.
+ * @brief Checks if the given file exists.
*
* @param file The name of the file.
* @return @c EINA_TRUE if the @p file exists, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_exists (const char *file);
/**
- * @brief Check if the given file is a directory.
+ * @brief Checks if the given file is a directory.
*
* @param file The name of the file.
* @return @c EINA_TRUE if the file exists and is a directory, @c EINA_FALSE
EAPI Eina_Bool ecore_file_is_dir (const char *file);
/**
- * @brief Create a new directory.
+ * @brief Creates a new directory.
*
* @param dir The name of the directory to create
* @return @c EINA_TRUE on successful creation, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_mkdir (const char *dir);
/**
- * @brief Create complete directory in a batch.
+ * @brief Creates complete directory in a batch.
*
* @param dirs The list of directories, null terminated.
* @return The number of successful directories created, -1 if dirs is
* This function creates all the directories that are in the null
* terminated array @p dirs. The function loops over the directories
* and call ecore_file_mkdir(). This function returns -1 if @p dirs is
- * @c NULL, otherwise if returns the number of suceesfully created
+ * @c NULL, otherwise if returns the number of successfully created
* directories.
*/
EAPI int ecore_file_mkdirs (const char **dirs);
/**
- * @brief Create complete list of sub-directories in a batch (optimized).
+ * @brief Creates complete list of sub-directories in a batch (optimized).
*
* @param base The base directory to act on.
* @param subdirs The list of directories, null terminated.
- * @return number of successful directories created, -1 on failure.
+ * @return The number of successful directories created, @c -1 on failure.
*
* This function creates all the directories that are in the null
* terminated array @p subdirs in the @p base directory. If @p base does
* returns -1 if @p subdirs or @p base are @c NULL, or if @p base is
* empty ("\0"). It returns 0 is @p base is not a directory or
* invalid, or if it can't be created. Otherwise if returns the number
- * of suceesfully created directories.
+ * of successfully created directories.
*/
EAPI int ecore_file_mksubdirs (const char *base, const char **subdirs);
/**
- * @brief Delete the given empty directory.
+ * @brief Deletes the given empty directory.
*
* @param dir The name of the directory to delete.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_rmdir (const char *dir);
/**
- * @brief Delete the given directory and all its contents.
+ * @brief Deletes the given directory and all its contents.
*
* @param dir The name of the directory to delete.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_recursive_rm (const char *dir);
/**
- * @brief Create a complete path.
+ * @brief Creates a complete path.
*
- * @param path The path to create
+ * @param path The path to create
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*
* This function creates @p path and all the subdirectories it
EAPI Eina_Bool ecore_file_mkpath (const char *path);
/**
- * @brief Create complete paths in a batch.
+ * @brief Creates complete paths in a batch.
*
* @param paths list of paths, null terminated.
- * @return number of successful paths created, -1 if paths is NULL.
+ * @return The number of successful paths created, @c -1 if paths is NULL.
*
* This function creates all the directories that are in the null
* terminated array @p paths. The function loops over the directories
* and call ecore_file_mkpath(), hence on Windows, '\' must be
* replaced by '/' before calling that function. This function
* returns -1 if @p paths is @c NULL. Otherwise if returns the number
- * of suceesfully created directories.
+ * of successfully created directories.
*/
EAPI int ecore_file_mkpaths (const char **paths);
/**
- * @brief Copy the given file to the given destination.
+ * @brief Copies the given file to the given destination.
*
* @param src The name of the source file.
* @param dst The name of the destination file.
EAPI Eina_Bool ecore_file_cp (const char *src, const char *dst);
/**
- * @brief Move the given file to the given destination.
+ * @brief Moves the given file to the given destination.
*
* @param src The name of the source file.
* @param dst The name of the destination file.
EAPI Eina_Bool ecore_file_mv (const char *src, const char *dst);
/**
- * @brief Create a symbolic link.
+ * @brief Creates a symbolic link.
*
* @param src The name of the file to link.
* @param dest The name of link.
EAPI Eina_Bool ecore_file_symlink (const char *src, const char *dest);
/**
- * @brief Get the canonicalized absolute path name.
+ * @brief Gets the canonicalized absolute path name.
*
* @param file The file path.
* @return The canonicalized absolute pathname or an empty string on
EAPI char *ecore_file_realpath (const char *file);
/**
- * @brief Delete the given file.
+ * @brief Deletes the given file.
*
* @param file The name of the file to delete.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_unlink (const char *file);
/**
- * @brief Remove the given file or directory.
+ * @brief Removes the given file or directory.
*
* @param file The name of the file or directory to delete.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_remove (const char *file);
/**
- * Get the filename from a given path.
+ * @brief Gets the filename from a given path.
*
* @param path The complete path.
* @return The file name.
EAPI const char *ecore_file_file_get (const char *path);
/**
- * @brief Get the directory where the given file resides.
+ * @brief Gets the directory where the given file resides.
*
* @param file The name of the file.
* @return The directory name.
EAPI char *ecore_file_dir_get (const char *path);
/**
- * @brief Check if the given file can be read.
+ * @brief Checks if the given file can be read.
*
* @param file The name of the file.
* @return @c EINA_TRUE if the @p file is readable, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_can_read (const char *file);
/**
- * @brief Check if the given file can be written.
+ * @brief Checks if the given file can be written.
*
* @param file The name of the file.
* @return @c EINA_TRUE if the @p file is writable, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_can_write (const char *file);
/**
- * @brief Check if the given file can be executed.
+ * @brief Checks if the given file can be executed.
*
* @param file The name of the file.
* @return @c EINA_TRUE if the @p file can be executed, @c EINA_FALSE
EAPI Eina_Bool ecore_file_can_exec (const char *file);
/**
- * @brief Get the path pointed by the given link.
+ * @brief Gets the path pointed by the given link.
*
* @param lnk The name of the link.
* @return The path pointed by link or NULL.
EAPI char *ecore_file_readlink (const char *link);
/**
- * @brief Get the list of the files and directories in the given
+ * @brief Gets the list of the files and directories in the given
* directory.
*
* @param dir The name of the directory to list
EAPI Eina_List *ecore_file_ls (const char *dir);
/**
- * @brief Return the executable from the given command.
+ * @brief Returns the executable from the given command.
*
* @param app The application command, with parameters.
* @return The executable from @p app as a newly allocated string. Arguments
EAPI char *ecore_file_app_exe_get (const char *app);
/**
- * @brief Add the escape sequence ('\\') to the given file name.
+ * @brief Adds the escape sequence ('\\') to the given file name.
*
* @param filename The file name.
* @return The file name with special characters escaped.
EAPI char *ecore_file_escape_name (const char *filename);
/**
- * @brief Remove the extension from the given file name.
+ * @brief Removes the extension from the given file name.
*
* @param path The name of the file.
- * @return A newly allocated string with the extension stripped out or
+ * @return A newly allocated string with the extension stripped out, or
* @c NULL on errors.
*
* This function removes the extension from @p path and returns the
EAPI char *ecore_file_strip_ext (const char *file);
/**
- * @brief Check if the given directory is empty.
+ * @brief Checks if the given directory is empty.
*
* @param dir The name of the directory to check.
- * @return @c 1 if directory is empty, @c 0 if it has at least one file or
+ * @return @c 1 if directory is empty, @c 0 if it has at least one file, or
* @c -1 in case of errors.
*
* This functions checks if @p dir is empty. The '.' and '..' files
/* Monitoring */
/**
- * @brief Monitor the given path using inotify, Windows notification, or polling.
+ * @brief Monitors the given path using inotify, Windows notification, or polling.
*
* @param path The path to monitor.
* @param func The function to call on changes.
void *data);
/**
- * @brief Stop the monitoring of the given path.
+ * @brief Stops the monitoring of the given path.
*
* @param em The Ecore_File_Monitor to stop.
*
EAPI void ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_monitor);
/**
- * @brief Get the monitored path.
+ * @brief Gets the monitored path.
*
* @param em The Ecore_File_Monitor to query.
* @return The path that is monitored by @p em.
/* Path */
/**
- * @brief Check if the given directory is in PATH.
+ * @brief Checks if the given directory is in PATH.
*
* @param in_dir The name of the directory to search in PATH.
* @return @c EINA_TRUE if the directory exist in PATH, @c EINA_FALSE otherwise.
EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir);
/**
- * @brief Check if the given application is installed.
+ * @brief Checks if the given application is installed.
*
* @param exe The name of the application
* @return @c EINA_TRUE if the @p exe is in PATH and is executable,
EAPI Eina_Bool ecore_file_app_installed(const char *exe);
/**
- * @brief Get a list of all the applications installed on the system.
+ * @brief Gets a list of all the applications installed on the system.
*
* @return An Eina_List containing all the executable files in the
* system.
/* Download */
/**
- * @brief Download the given url to the given destination.
+ * @brief Downloads the given url to the given destination.
*
* @param url The complete url to download.
* @param dst The local file to save the downloaded to.
Ecore_File_Download_Job **job_ret);
/**
- * @brief Download the given url to the given destination with additional headers.
+ * @brief Downloads the given url to the given destination with additional headers.
*
* @param url The complete url to download.
* @param dst The local file to save the downloaded to.
Eina_Hash *headers);
/**
- * @brief Abort all downloads.
+ * @brief Aborts all downloads.
*
* This function aborts all the downloads that have been started by
* ecore_file_download(). It loops over the started downloads and call
EAPI void ecore_file_download_abort_all(void);
/**
- * @brief Abort the given download job and call the completion_cb
+ * @brief Aborts the given download job and call the completion_cb
* callbck with a status of 1 (error).
*
* @param job The download job to abort.
EAPI void ecore_file_download_abort(Ecore_File_Download_Job *job);
/**
- * @brief Check if the given protocol is available.
+ * @brief Checks if the given protocol is available.
*
* @param protocol The protocol to check.
* @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise.
/**
* @example ecore_imf_example.c
- * Show how to write simple editor using the Ecore_IMF library
+ * Shows how to write simple editor using the Ecore_IMF library.
*/
/* ecore_imf_context_input_panel_event_callback_add() flag */
} Ecore_IMF_Event_Type;
/**
* @typedef Ecore_IMF_Keyboard_Modifiers
- * Type for Ecore_IMF keyboard modifiers
+ * Types for Ecore_IMF keyboard modifiers
*/
typedef enum
{
/**
* @typedef Ecore_IMF_Keyboard_Locks
- * Type for Ecore_IMF keyboard locks
+ * Types for Ecore_IMF keyboard locks
*/
typedef enum
{
/**
* @typedef Ecore_IMF_Mouse_Flags
- * Type for Ecore_IMF mouse flags
+ * Types for Ecore_IMF mouse flags
*/
typedef enum
{
/**
* @typedef Ecore_IMF_Input_Mode
- * Type for Ecore_IMF input mode
+ * Types for Ecore_IMF input mode
*/
typedef enum
{
/**
* @typedef Ecore_IMF_Input_Hints
- * @brief Enumeration that defines the types of Ecore_IMF Input Hints.
+ * @brief Enumeration for defining the types of Ecore_IMF Input Hints.
* @since 1.12
*/
typedef enum
/**
* @typedef Ecore_IMF_BiDi_Direction
- * @brief Enumeration that defines the types of Ecore_IMF bidirectionality
+ * @brief Enumeration for defining the types of Ecore_IMF bidirectionality.
* @since 1.12
*/
typedef enum
*/
/**
- * Initialises the Ecore_IMF library.
+ * @ingroup Ecore_IMF_Lib_Group
+ * @brief Initialises the Ecore_IMF library.
* @return Number of times the library has been initialised without being
* shut down.
- * @ingroup Ecore_IMF_Lib_Group
*/
EAPI int ecore_imf_init(void);
/**
- * Shuts down the Ecore_IMF library.
+ * @ingroup Ecore_IMF_Lib_Group
+ * @brief Shuts down the Ecore_IMF library.
* @return Number of times the library has been initialised without being
* shut down.
- * @ingroup Ecore_IMF_Lib_Group
*/
EAPI int ecore_imf_shutdown(void);
/**
- * Register an Ecore_IMF module.
+ * @ingroup Ecore_IMF_Lib_Group
+ * @brief Registers an Ecore_IMF module.
*
* @param info An Ecore_IMF_Context_Info structure
* @param imf_module_create A function to call at the creation
* @param imf_module_exit A function to call when exiting
*
- * @ingroup Ecore_IMF_Lib_Group
*/
EAPI void ecore_imf_module_register(const Ecore_IMF_Context_Info *info, Ecore_IMF_Context *(*imf_module_create)(void), Ecore_IMF_Context *(*imf_module_exit)(void));
/**
- * Hide the input panel.
+ * @ingroup Ecore_IMF_Lib_Group
+ * @brief Hides the input panel.
* @return EINA_TRUE if the input panel will be hidden
EINA_FALSE if the input panel is already in hidden state
- * @ingroup Ecore_IMF_Lib_Group
* @since 1.8.0
*/
EAPI Eina_Bool ecore_imf_input_panel_hide(void);
/**
- * Get the list of the available Input Method Context ids.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the list of the available Input Method Context ids.
*
* Note that the caller is responsible for freeing the Eina_List
* when finished with it. There is no need to finish the list strings.
*
* @return Return an Eina_List of strings;
* on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI Eina_List *ecore_imf_context_available_ids_get(void);
/**
- * Get the list of the available Input Method Context ids by canvas type.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the list of the available Input Method Context ids by canvas type.
*
* Note that the caller is responsible for freeing the Eina_List
* when finished with it. There is no need to finish the list strings.
* @param canvas_type A string containing the canvas type.
* @return Return an Eina_List of strings;
* on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI Eina_List *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type);
/**
- * Get the id of the default Input Method Context.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the id of the default Input Method Context.
* The id may to used to create a new instance of an Input Method
* Context object.
*
* @return Return a string containing the id of the default Input
* Method Context; on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI const char *ecore_imf_context_default_id_get(void);
/**
- * Get the id of the default Input Method Context corresponding to a canvas
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the id of the default Input Method Context corresponding to a canvas
* type.
* The id may be used to create a new instance of an Input Method
* Context object.
* @param canvas_type A string containing the canvas type.
* @return Return a string containing the id of the default Input
* Method Context; on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI const char *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type);
/**
- * Retrieve the info for the Input Method Context with @p id.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Retrieves the info for the Input Method Context with @p id.
*
* @param id The Input Method Context id to query for.
* @return Return a #Ecore_IMF_Context_Info for the Input Method Context with @p id;
* on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*
* Example
* @code
EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id);
/**
- * Create a new Input Method Context defined by the given id.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Creates a new Input Method Context defined by the given id.
*
* @param id The Input Method Context id.
* @return A newly allocated Input Method Context;
* on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI Ecore_IMF_Context *ecore_imf_context_add(const char *id);
/**
- * Retrieve the info for the given Input Method Context.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Retrieves the info for the given Input Method Context.
*
* @param ctx An #Ecore_IMF_Context.
* @return Return a #Ecore_IMF_Context_Info for the given Input Method Context;
* on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx);
/**
- * Delete the given Input Method Context and free its memory.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Deletes the given Input Method Context and free its memory.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx);
/**
- * Set the client window for the Input Method Context; this is the
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the client window for the Input Method Context; this is the
* Ecore_X_Window when using X11, Ecore_Win32_Window when using Win32, etc.
* This window is used in order to correctly position status windows, and may
* also be used for purposes internal to the Input Method Context.
* @param ctx An #Ecore_IMF_Context.
* @param window The client window. This may be @c NULL to indicate
* that the previous client window no longer exists.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window);
/**
- * Get the client window of the Input Method Context
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the client window of the Input Method Context.
*
* See @ref ecore_imf_context_client_window_set for more details.
*
* @param ctx An #Ecore_IMF_Context.
* @return Return the client window.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx);
/**
- * Set the client canvas for the Input Method Context; this is the
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the client canvas for the Input Method Context; this is the
* canvas in which the input appears.
* The canvas type can be determined by using the context canvas type.
* Actually only canvas with type "evas" (Evas *) is supported.
* @param ctx An #Ecore_IMF_Context.
* @param canvas The client canvas. This may be @c NULL to indicate
* that the previous client canvas no longer exists.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas);
/**
- * Get the client canvas of the Input Method Context.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the client canvas of the Input Method Context.
*
* See @ref ecore_imf_context_client_canvas_set for more details.
*
* @param ctx An #Ecore_IMF_Context.
* @return Return the client canvas.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx);
/**
- * Ask the Input Method Context to show itself.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Asks the Input Method Context to show itself.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_show(Ecore_IMF_Context *ctx);
/**
- * Ask the Input Method Context to hide itself.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Asks the Input Method Context to hide itself.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx);
/**
- * Retrieve the current preedit string and cursor position
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Retrieves the current preedit string and cursor position
* for the Input Method Context.
*
* @param ctx An #Ecore_IMF_Context.
* string retrieved must be freed with free().
* @param cursor_pos Location to store position of cursor (in characters)
* within the preedit string.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
/**
- * Retrieve the current preedit string, attributes and
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Retrieves the current preedit string, attributes and
* cursor position for the Input Method Context.
*
* @param ctx An #Ecore_IMF_Context.
* @param str Location to store the retrieved string. The
* string retrieved must be freed with free().
- * @param attrs an Eina_List of attributes
+ * @param attrs An Eina_List of attributes
* @param cursor_pos Location to store position of cursor (in characters)
* within the preedit string.
- * @ingroup Ecore_IMF_Context_Group
*
* Example
* @code
EAPI void ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
/**
- * Notify the Input Method Context that the widget to which its
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Notifies the Input Method Context that the widget to which its
* correspond has gained focus.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
*
* Example
* @code
EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context *ctx);
/**
- * Notify the Input Method Context that the widget to which its
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Notifies the Input Method Context that the widget to which its
* correspond has lost focus.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
*
* Example
* @code
EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context *ctx);
/**
- * Notify the Input Method Context that a change such as a
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Notifies the Input Method Context that a change such as a
* change in cursor position has been made. This will typically
* cause the Input Method Context to clear the preedit state or commit the preedit string.
*
* In addition, it should be called before inserting some text.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
*
* Example
* @code
EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ctx);
/**
- * Notify the Input Method Context that a change in the cursor
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Notifies the Input Method Context that a change in the cursor
* position has been made.
*
* This function should be called when cursor position is changed or mouse up event is generated.
*
* @param ctx An #Ecore_IMF_Context.
* @param cursor_pos New cursor position in characters.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos);
/**
- * Notify the Input Method Context that a change in the cursor
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Notifies the Input Method Context that a change in the cursor
* location has been made. The location is relative to the canvas.
* The cursor location can be used to determine the position of
* candidate word window in the immodule.
* @param y cursor y position.
* @param w cursor width.
* @param h cursor height.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h);
/**
- * Set whether the IM context should use the preedit string
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets whether the IM context should use the preedit string
* to display feedback. If @c use_preedit is @c EINA_FALSE (default
* is @c EINA_TRUE), then the IM context may use some other method to display
* feedback, such as displaying it in a child of the root window.
*
* @param ctx An #Ecore_IMF_Context.
* @param use_preedit Whether the IM context should use the preedit string.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
/**
- * Set the callback to be used on surrounding_get request.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the callback to be used on surrounding_get request.
*
* This callback will be called when the Input Method Context
* module requests the surrounding context.
* @param ctx An #Ecore_IMF_Context.
* @param func The callback to be called.
* @param data The data pointer to be passed to @p func
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_retrieve_surrounding_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text, int *cursor_pos), const void *data);
/**
- * Set the callback to be used on selection_get request.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the callback to be used on selection_get request.
*
* This callback will be called when the Input Method Context
* module requests the selection context.
* @param ctx An #Ecore_IMF_Context.
* @param func The callback to be called.
* @param data The data pointer to be passed to @p func
- * @ingroup Ecore_IMF_Context_Group
* @since 1.9.0
*/
EAPI void ecore_imf_context_retrieve_selection_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text), const void *data);
/**
- * Set the input mode used by the Ecore Input Context.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the input mode used by the Ecore Input Context.
*
* The input mode can be one of the input modes defined in
* Ecore_IMF_Input_Mode. The default input mode is
*
* @param ctx An #Ecore_IMF_Context.
* @param input_mode The input mode to be used by @p ctx.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI void ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
/**
- * Get the input mode being used by the Ecore Input Context.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the input mode being used by the Ecore Input Context.
*
* See @ref ecore_imf_context_input_mode_set for more details.
*
* @param ctx An #Ecore_IMF_Context.
* @return The input mode being used by @p ctx.
- * @ingroup Ecore_IMF_Context_Group
*/
EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx);
/**
- * Allow an Ecore Input Context to internally handle an event.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Allows an Ecore Input Context to internally handle an event.
* If this function returns @c EINA_TRUE, then no further processing
* should be done for this event.
*
* @param type The type of event defined by #Ecore_IMF_Event_Type.
* @param event The event itself.
* @return @c EINA_TRUE if the event was handled; otherwise @c EINA_FALSE.
- * @ingroup Ecore_IMF_Context_Group
*
* Example
* @code
*/
/**
- * Creates a new Input Method Context with klass specified by @p ctxc.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Creates a new Input Method Context with klass specified by @p ctxc.
*
* This method should be used by modules implementing the Input
* Method Context interface.
*
* @param ctxc An #Ecore_IMF_Context_Class.
* @return A new #Ecore_IMF_Context; on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc);
/**
- * Set the Input Method Context specific data.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * Sets the Input Method Context specific data.
*
* Note that this method should be used by modules to set
* the Input Method Context specific data and it's not meant to
* @param ctx An #Ecore_IMF_Context.
* @param data The Input Method Context specific data.
* @return A new #Ecore_IMF_Context; on failure it returns NULL.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data);
/**
- * Get the Input Method Context specific data.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Gets the Input Method Context specific data.
*
* See @ref ecore_imf_context_data_set for more details.
*
* @param ctx An #Ecore_IMF_Context.
* @return The Input Method Context specific data.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx);
/**
- * Retrieve context around insertion point.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Retrieves context around insertion point.
* Input methods typically want context in order to constrain input text based on existing text;
* this is important for languages such as Thai where only some sequences of characters are allowed.
* In addition, the text around the insertion point can be used for supporting autocapital feature.
* the insertion cursor within @p text.
* @return @c EINA_TRUE if surrounding text was provided; otherwise
* @c EINA_FALSE.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos);
/**
- * Retrieve the selected text.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Retrieves the selected text.
*
* This function is implemented by calling the
* Ecore_IMF_Context::retrieve_selection_func (
* the result stored in this location with free().
* @return @c EINA_TRUE if selected text was provided; otherwise
* @c EINA_FALSE.
- * @ingroup Ecore_IMF_Context_Module_Group
* @since 1.9.0
*/
EAPI Eina_Bool ecore_imf_context_selection_get(Ecore_IMF_Context *ctx, char **text);
/**
- * Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue.
*
* ECORE_IMF_EVENT_PREEDIT_START should be added when a new preedit sequence starts.
* It's asynchronous method to put event to the event queue.
* ecore_imf_context_event_callback_call() can be used as synchronous method.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx);
/**
- * Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue.
*
* ECORE_IMF_EVENT_PREEDIT_END should be added when a new preedit sequence has been completed or canceled.
* It's asynchronous method to put event to the event queue.
* ecore_imf_context_event_callback_call() can be used as synchronous method.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx);
/**
- * Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue.
*
* It's asynchronous method to put event to the event queue.
* ecore_imf_context_event_callback_call() can be used as synchronous method.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx);
/**
- * Adds ECORE_IMF_EVENT_COMMIT to the event queue.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Adds ECORE_IMF_EVENT_COMMIT to the event queue.
*
* It's asynchronous method to put event to the event queue.
* ecore_imf_context_event_callback_call() can be used as synchronous method.
*
* @param ctx An #Ecore_IMF_Context.
* @param str The committed string.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str);
/**
- * Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
*
* Asks the widget that the input context is attached to to delete characters around the cursor position
* by adding the ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
* @param ctx An #Ecore_IMF_Context.
* @param offset The start offset of surrounding to be deleted.
* @param n_chars The number of characters to be deleted.
- * @ingroup Ecore_IMF_Context_Module_Group
*/
EAPI void ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars);
/**
- * Add (register) a callback function to a given context event.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Adds (registers) a callback function to a given context event.
*
* This function adds a function callback to the context @p ctx when the
* event of type @p type occurs on it. The function pointer is @p
* @param func The (callback) function to be called when the event is
* triggered
* @param data The data pointer to be passed to @p func
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*
* Example
EAPI void ecore_imf_context_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func, const void *data);
/**
- * Delete (unregister) a callback function registered to a given
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Deletes (unregisters) a callback function registered to a given
* context event.
*
* This function removes a function callback from the context @p ctx when the
* @param type The type of event that was triggering the callback
* @param func The (callback) function that was to be called when the event was triggered
* @return the data pointer
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI void *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func);
/**
- * Call a given callback on the context @p ctx.
+ * @ingroup Ecore_IMF_Context_Module_Group
+ * @brief Calls a given callback on the context @p ctx.
*
* ecore_imf_context_preedit_start_event_add(), ecore_imf_context_preedit_end_event_add(),
* ecore_imf_context_preedit_changed_event_add(), ecore_imf_context_commit_event_add() and
* @param type The type of event that will trigger the callback
* @param event_info The pointer to event specific struct or information to
* pass to the callback functions registered on this event
- * @ingroup Ecore_IMF_Context_Module_Group
* @since 1.2.0
*/
EAPI void ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info);
/**
- * Set whether the IM context should allow to use the text prediction.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets whether the IM context should allow to use the text prediction.
* If @p prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM
* context will not display the text prediction window.
*
* @param ctx An #Ecore_IMF_Context.
* @param prediction Whether the IM context should allow to use the text prediction.
* @note Default value is EINA_TRUE.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction);
/**
- * Get whether the IM context should allow to use the text prediction.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets whether the IM context should allow to use the text prediction.
*
* @param ctx An #Ecore_IMF_Context.
* @return @c EINA_TRUE if it allows to use the text prediction, otherwise
* @c EINA_FALSE.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI Eina_Bool ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx);
/**
- * Set the autocapitalization type on the immodule.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the autocapitalization type on the immodule.
*
* @param ctx An #Ecore_IMF_Context.
* @param autocapital_type the autocapitalization type.
* @note Default type is ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
/**
- * Get the autocapitalization type.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the autocapitalization type.
*
* @param ctx An #Ecore_IMF_Context.
* @return The autocapital type being used by @p ctx.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI Ecore_IMF_Autocapital_Type ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx);
/**
+ * @ingroup Ecore_IMF_Context_Group
* @brief Sets the input hint which allows input methods to fine-tune their behavior.
*
* @param ctx An #Ecore_IMF_Context
- * @param hints input hint
+ * @param hints Input hint
* @note The default input hint is @c ECORE_IMF_INPUT_HINT_AUTO_COMPLETE.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.12
*/
EAPI void ecore_imf_context_input_hint_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Hints hints);
/**
+ * @ingroup Ecore_IMF_Context_Group
* @brief Gets the value of input hint.
*
* @param ctx An #Ecore_IMF_Context
* @return The value of input hint
- * @ingroup Ecore_IMF_Context_Group
* @since 1.12
*/
EAPI Ecore_IMF_Input_Hints ecore_imf_context_input_hint_get(Ecore_IMF_Context *ctx);
/**
- * Ask the Input Method Context to show the control panel of using Input Method.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Asks the Input Method Context to show the control panel of using Input Method.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx);
/**
- * Ask the Input Method Context to hide the control panel of using Input Method.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Asks the Input Method Context to hide the control panel of using Input Method.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx);
/**
- * Ask the Input Method Context to show the input panel (virtual keyboard).
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Asks the Input Method Context to show the input panel (virtual keyboard).
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx);
/**
- * Ask the Input Method Context to hide the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Asks the Input Method Context to hide the input panel.
*
* @param ctx An #Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx);
/**
- * Set the layout of the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the layout of the input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param layout see #Ecore_IMF_Input_Panel_Layout
* @note Default layout type is ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
/**
- * Get the layout of the current active input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the layout of the current active input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @return layout see #Ecore_IMF_Input_Panel_Layout
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI Ecore_IMF_Input_Panel_Layout ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx);
/**
- * Set the layout variation of the current active input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the layout variation of the current active input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param variation the layout variation
* @note Default layout variation type is NORMAL.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.8.0
*/
EAPI void ecore_imf_context_input_panel_layout_variation_set(Ecore_IMF_Context *ctx, int variation);
/**
- * Get the layout variation of the current active input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the layout variation of the current active input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @return the layout variation
- * @ingroup Ecore_IMF_Context_Group
* @since 1.8.0
*/
EAPI int ecore_imf_context_input_panel_layout_variation_get(Ecore_IMF_Context *ctx);
/**
- * Set the language of the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the language of the input panel.
* This API can be used when you want to show the English keyboard.
*
* @param ctx An #Ecore_IMF_Context.
* @param lang the language to be set to the input panel.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
/**
- * Get the language of the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the language of the input panel.
*
* See @ref ecore_imf_context_input_panel_language_set for more details.
*
* @param ctx An #Ecore_IMF_Context.
* @return Ecore_IMF_Input_Panel_Lang
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI Ecore_IMF_Input_Panel_Lang ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx);
/**
- * Set whether the Input Method Context should request to show the input panel automatically
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets whether the Input Method Context should request to show the input panel automatically
* when the widget has focus.
*
* @param ctx An #Ecore_IMF_Context.
* @param enabled If true, the input panel will be shown when the widget is clicked or has focus.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI void ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enabled);
/**
- * Get whether the Input Method Context requests to show the input panel automatically.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets whether the Input Method Context requests to show the input panel automatically.
*
* @param ctx An #Ecore_IMF_Context.
* @return Return the attribute to show the input panel automatically
- * @ingroup Ecore_IMF_Context_Group
* @since 1.1.0
*/
EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx);
/**
- * Set the input panel-specific data to deliver to the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the input panel-specific data to deliver to the input panel.
* This API is used by applications to deliver specific data to the input panel.
* The data format MUST be negotiated by both application and the input panel.
* The size and format of data are defined by the input panel.
* @param ctx An #Ecore_IMF_Context.
* @param data The specific data to be set to the input panel.
* @param len the length of data, in bytes, to send to the input panel
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI void ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len);
/**
- * Get the specific data of the current active input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the specific data of the current active input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param data The specific data to be got from the input panel
* @param len The length of data
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI void ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len);
/**
- * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
*
* An input panel displays the string or icon associated with this type.@n
* Regardless of return key type, return key event will be generated when pressing return key.
* @param ctx An #Ecore_IMF_Context.
* @param return_key_type The type of "return" key on the input panel
* @note Default type is ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI void ecore_imf_context_input_panel_return_key_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
/**
- * Get the "return" key type.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the "return" key type.
*
* @see ecore_imf_context_input_panel_return_key_type_set() for more details
*
* @param ctx An #Ecore_IMF_Context.
* @return The type of "return" key on the input panel
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx);
/**
- * Set the return key on the input panel to be disabled.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the return key on the input panel to be disabled.
*
* @param ctx An #Ecore_IMF_Context.
* @param disabled The state
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI void ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled);
/**
- * Get whether the return key on the input panel should be disabled or not.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets whether the return key on the input panel should be disabled or not.
*
* @param ctx An #Ecore_IMF_Context.
* @return @c EINA_TRUE if it should be disabled.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI Eina_Bool ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx);
/**
- * Set the caps lock mode on the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets the caps lock mode on the input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param mode Turn on caps lock on the input panel if @c EINA_TRUE.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI void ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode);
/**
- * Get the caps lock mode on the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the caps lock mode on the input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @return @c EINA_TRUE if the caps lock is turned on.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.2.0
*/
EAPI Eina_Bool ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx);
/**
- * Get the position of the current active input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the position of the current active input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param x top-left x co-ordinate of the input panel
* @param y top-left y co-ordinate of the input panel
* @param w width of the input panel
* @param h height of the input panel
- * @ingroup Ecore_IMF_Context_Group
* @since 1.3
*/
EAPI void ecore_imf_context_input_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
/**
- * Get state of current active input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets state of current active input panel.
*
* @param ctx An #Ecore_IMF_Context.
* @return The state of input panel.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.3
*/
EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore_IMF_Context *ctx);
/**
- * Register a callback function which will be called if there is change in input panel state,language,mode etc.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Registers a callback function which will be called if there is change in input panel state,language,mode etc.
* In order to deregister the callback function
* Use @ref ecore_imf_context_input_panel_event_callback_del.
*
* @param type event type
* @param func the callback function
* @param data application-input panel specific data.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.3
*/
EAPI void ecore_imf_context_input_panel_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value), const void *data);
/**
- * Unregister a callback function which will be called if there is change in input panel state, language, mode etc.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Unregisters a callback function which will be called if there is change in input panel state, language, mode etc.
*
* @param ctx An #Ecore_IMF_Context.
* @param type An #Ecore_IMF_Input_Panel_Event.
* @param func the callback function
- * @ingroup Ecore_IMF_Context_Group
* @since 1.3
*/
EAPI void ecore_imf_context_input_panel_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value));
/**
- * Call a given input panel callback on the context @p ctx.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Calls a given input panel callback on the context @p ctx.
*
* @param ctx Ecore_IMF_Context.
* @param type The type of event that will trigger the callback
* @param value the event value
- * @ingroup Ecore_IMF_Context_Group
* @since 1.8.0
*/
EAPI void ecore_imf_context_input_panel_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, int value);
/**
- * Delete all input panel callback on the context @p ctx.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Deletes all input panel callback on the context @p ctx.
*
- * Delete all input panel callback to be registered by ecore_imf_context_input_panel_event_callback_add()
+ * Deletes all input panel callback to be registered by ecore_imf_context_input_panel_event_callback_add()
*
* @param ctx Ecore_IMF_Context.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.8.0
*/
EAPI void ecore_imf_context_input_panel_event_callback_clear(Ecore_IMF_Context *ctx);
/**
- * Get the current language locale of the input panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the current language locale of the input panel.
*
* ex) fr_FR
*
* @param ctx An #Ecore_IMF_Context.
* @param lang Location to store the retrieved language string. The
* string retrieved must be freed with free().
- * @ingroup Ecore_IMF_Context_Group
* @since 1.3
*/
EAPI void ecore_imf_context_input_panel_language_locale_get(Ecore_IMF_Context *ctx, char **lang);
/**
- * Get the geometry information of the candidate panel.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets the geometry information of the candidate panel.
*
* @param ctx An #Ecore_IMF_Context.
* @param x top-left x co-ordinate of the candidate panel
* @param y top-left y co-ordinate of the candidate panel
* @param w width of the candidate panel
* @param h height of the candidate panel
- * @ingroup Ecore_IMF_Context_Group
* @since 1.3
*/
EAPI void ecore_imf_context_candidate_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
/**
- * Set whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Sets whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event.
* It doesn't request to show the input panel even though the Input Method Context has focus.
*
* @param ctx An #Ecore_IMF_Context.
* @param ondemand If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)
- * @ingroup Ecore_IMF_Context_Group
* @since 1.8.0
*/
EAPI void ecore_imf_context_input_panel_show_on_demand_set(Ecore_IMF_Context *ctx, Eina_Bool ondemand);
/**
- * Get whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event.
+ * @ingroup Ecore_IMF_Context_Group
+ * @brief Gets whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event.
*
* @param ctx An #Ecore_IMF_Context.
* @return @c EINA_TRUE if the input panel will be shown in case of only Mouse up event.
- * @ingroup Ecore_IMF_Context_Group
* @since 1.8.0
*/
EAPI Eina_Bool ecore_imf_context_input_panel_show_on_demand_get(Ecore_IMF_Context *ctx);
/**
+ * @ingroup Ecore_IMF_Context_Group
* @brief Sets the bidirectionality at the current cursor position.
*
- * @ingroup Ecore_IMF_Context_Group
* @since 1.12.0
*
* @param[in] ctx An #Ecore_IMF_Context
- * @param[in] direction the direction mode
+ * @param[in] direction The direction mode
*/
EAPI void ecore_imf_context_bidi_direction_set(Ecore_IMF_Context *ctx, Ecore_IMF_BiDi_Direction direction);
/**
+ * @ingroup Ecore_IMF_Context_Group
* @brief Gets the bidirectionality at the current cursor position.
*
- * @ingroup Ecore_IMF_Context_Group
* @since 1.12.0
*
* @param[in] ctx An #Ecore_IMF_Context
- * @return the direction mode
+ * @return The direction mode
*/
EAPI Ecore_IMF_BiDi_Direction ecore_imf_context_bidi_direction_get(Ecore_IMF_Context *ctx);
#endif
/**
- * Converts a "mouse_in" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "mouse_in" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*/
EAPI void ecore_imf_evas_event_mouse_in_wrap(Evas_Event_Mouse_In *evas_event, Ecore_IMF_Event_Mouse_In *imf_event);
/**
- * Converts a "mouse_out" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "mouse_out" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*/
EAPI void ecore_imf_evas_event_mouse_out_wrap(Evas_Event_Mouse_Out *evas_event, Ecore_IMF_Event_Mouse_Out *imf_event);
/**
- * Converts a "mouse_move" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "mouse_move" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*/
EAPI void ecore_imf_evas_event_mouse_move_wrap(Evas_Event_Mouse_Move *evas_event, Ecore_IMF_Event_Mouse_Move *imf_event);
/**
- * Converts a "mouse_down" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "mouse_down" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*/
EAPI void ecore_imf_evas_event_mouse_down_wrap(Evas_Event_Mouse_Down *evas_event, Ecore_IMF_Event_Mouse_Down *imf_event);
/**
- * Converts a "mouse_up" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "mouse_up" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*/
EAPI void ecore_imf_evas_event_mouse_up_wrap(Evas_Event_Mouse_Up *evas_event, Ecore_IMF_Event_Mouse_Up *imf_event);
/**
- * Converts a "mouse_wheel" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "mouse_wheel" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*/
EAPI void ecore_imf_evas_event_mouse_wheel_wrap(Evas_Event_Mouse_Wheel *evas_event, Ecore_IMF_Event_Mouse_Wheel *imf_event);
/**
- * Converts a "key_down" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "key_down" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*
* Example
* @code
EAPI void ecore_imf_evas_event_key_down_wrap(Evas_Event_Key_Down *evas_event, Ecore_IMF_Event_Key_Down *imf_event);
/**
- * Converts a "key_up" event from Evas to the corresponding event of Ecore_IMF.
+ * @ingroup Ecore_IMF_Evas_Group
+ * @brief Converts a "key_up" event from Evas to the corresponding event of Ecore_IMF.
*
* @param evas_event The received Evas event.
* @param imf_event The location to store the converted Ecore_IMF event.
- * @ingroup Ecore_IMF_Evas_Group
*
* Example
* @code
projects / platform / upstream / efl.git / commitdiff