forked from enlightenment/efl
docs: Fix typos and some wrong expressions
Covers: Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Summary: I had fixed some typos and wrong expressions, such as capital letters, singular Etc. in Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, jpeg, Jaehyun_Cho Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4680
This commit is contained in:
Myoungwoon Roy, Kim
Jean-Philippe Andre
parent
726994d175
commit
8c19d9251d
|
|
@ -218,12 +218,11 @@ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14 */
|
|||
|
||||
/**
|
||||
* @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
|
||||
|
|
@ -239,7 +238,8 @@ EAPI int ecore_drm_init(void);
|
|||
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.
|
||||
|
|
@ -248,188 +248,183 @@ EAPI int ecore_drm_shutdown(void);
|
|||
*
|
||||
* @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.
|
||||
|
|
@ -438,131 +433,130 @@ EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map);
|
|||
* @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);
|
||||
|
|
@ -574,16 +568,16 @@ EAPI void ecore_drm_output_fb_release(Ecore_Drm_Output *output, Ecore_Drm_Fb *fb
|
|||
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);
|
||||
|
||||
|
|
@ -594,43 +588,43 @@ EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, i
|
|||
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);
|
||||
|
|
@ -651,47 +645,48 @@ EAPI Ecore_Drm_Fb *ecore_drm_fb_create(Ecore_Drm_Device *dev, int width, int hei
|
|||
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);
|
||||
|
|
@ -700,117 +695,118 @@ EAPI Eina_Bool ecore_drm_launcher_connect(Ecore_Drm_Device *dev);
|
|||
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
|
||||
|
|
@ -818,51 +814,51 @@ EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level);
|
|||
* @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
|
||||
|
|
@ -870,61 +866,61 @@ EAPI const Eina_List *ecore_drm_devices_get(void);
|
|||
* @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
|
||||
*
|
||||
|
|
@ -932,47 +928,47 @@ EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output);
|
|||
*
|
||||
* @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.
|
||||
|
|
@ -982,13 +978,13 @@ EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, i
|
|||
*
|
||||
* @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
|
||||
|
|
@ -996,15 +992,15 @@ EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev,
|
|||
* @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
|
||||
*
|
||||
|
|
@ -1013,9 +1009,8 @@ EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsi
|
|||
* @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);
|
||||
|
|
@ -1029,7 +1024,8 @@ EAPI unsigned int ecore_drm_output_supported_rotations_get(Ecore_Drm_Output *out
|
|||
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
|
||||
*
|
||||
|
|
@ -1039,13 +1035,13 @@ EAPI Eina_Bool ecore_drm_output_rotation_set(Ecore_Drm_Output *output, Ecore_Drm
|
|||
* @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
|
||||
*
|
||||
|
|
@ -1058,7 +1054,6 @@ EAPI Eina_Bool ecore_drm_evdev_key_remap_enable(Ecore_Drm_Evdev *edev, Eina_Bool
|
|||
* 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 diff suppressed because it is too large
Load Diff
|
|
@ -36,7 +36,7 @@
|
|||
|
||||
/**
|
||||
* @file Ecore_File.h
|
||||
* @brief Files utility functions
|
||||
* @brief Files utility functions.
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
|
@ -115,9 +115,9 @@ typedef int (*Ecore_File_Download_Progress_Cb)(void *data,
|
|||
/* 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
|
||||
|
|
@ -130,9 +130,9 @@ typedef int (*Ecore_File_Download_Progress_Cb)(void *data,
|
|||
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
|
||||
|
|
@ -142,10 +142,10 @@ EAPI int ecore_file_init (void);
|
|||
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
|
||||
|
|
@ -154,10 +154,10 @@ EAPI int ecore_file_shutdown (void);
|
|||
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.
|
||||
|
|
@ -165,7 +165,7 @@ EAPI long long ecore_file_mod_time (const char *file);
|
|||
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.
|
||||
|
|
@ -176,7 +176,7 @@ EAPI long long ecore_file_size (const char *file);
|
|||
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
|
||||
|
|
@ -188,7 +188,7 @@ EAPI Eina_Bool ecore_file_exists (const char *file);
|
|||
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.
|
||||
|
|
@ -201,7 +201,7 @@ EAPI Eina_Bool ecore_file_is_dir (const char *file);
|
|||
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
|
||||
|
|
@ -210,17 +210,17 @@ EAPI Eina_Bool ecore_file_mkdir (const char *dir);
|
|||
* 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
|
||||
|
|
@ -231,12 +231,12 @@ EAPI int ecore_file_mkdirs (const char **dirs);
|
|||
* 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.
|
||||
|
|
@ -247,7 +247,7 @@ EAPI int ecore_file_mksubdirs (const char *base, const char **subd
|
|||
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.
|
||||
|
|
@ -259,9 +259,9 @@ EAPI Eina_Bool ecore_file_rmdir (const char *dir);
|
|||
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
|
||||
|
|
@ -272,22 +272,22 @@ EAPI Eina_Bool ecore_file_recursive_rm (const char *dir);
|
|||
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.
|
||||
|
|
@ -301,7 +301,7 @@ EAPI int ecore_file_mkpaths (const char **paths);
|
|||
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.
|
||||
|
|
@ -313,7 +313,7 @@ EAPI Eina_Bool ecore_file_cp (const char *src, const char *dst);
|
|||
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.
|
||||
|
|
@ -326,7 +326,7 @@ EAPI Eina_Bool ecore_file_mv (const char *src, const char *dst);
|
|||
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
|
||||
|
|
@ -340,7 +340,7 @@ EAPI Eina_Bool ecore_file_symlink (const char *src, const char *dest);
|
|||
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.
|
||||
|
|
@ -351,7 +351,7 @@ EAPI char *ecore_file_realpath (const char *file);
|
|||
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.
|
||||
|
|
@ -362,7 +362,7 @@ EAPI Eina_Bool ecore_file_unlink (const char *file);
|
|||
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.
|
||||
|
|
@ -373,7 +373,7 @@ EAPI Eina_Bool ecore_file_remove (const char *file);
|
|||
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.
|
||||
|
|
@ -386,7 +386,7 @@ EAPI const char *ecore_file_file_get (const char *path);
|
|||
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.
|
||||
|
|
@ -397,7 +397,7 @@ EAPI char *ecore_file_dir_get (const char *path);
|
|||
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.
|
||||
|
|
@ -408,7 +408,7 @@ EAPI Eina_Bool ecore_file_can_read (const char *file);
|
|||
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
|
||||
|
|
@ -420,7 +420,7 @@ EAPI Eina_Bool ecore_file_can_write (const char *file);
|
|||
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.
|
||||
|
|
@ -433,7 +433,7 @@ EAPI Eina_Bool ecore_file_can_exec (const char *file);
|
|||
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
|
||||
|
|
@ -452,7 +452,7 @@ EAPI char *ecore_file_readlink (const char *link);
|
|||
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
|
||||
|
|
@ -463,7 +463,7 @@ EAPI Eina_List *ecore_file_ls (const char *dir);
|
|||
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.
|
||||
|
|
@ -477,10 +477,10 @@ EAPI char *ecore_file_app_exe_get (const char *app);
|
|||
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
|
||||
|
|
@ -491,10 +491,10 @@ EAPI char *ecore_file_escape_name (const char *filename);
|
|||
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
|
||||
|
|
@ -506,7 +506,7 @@ EAPI int ecore_file_dir_is_empty (const char *dir);
|
|||
/* 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.
|
||||
|
|
@ -527,7 +527,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
|
|||
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.
|
||||
*
|
||||
|
|
@ -540,7 +540,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
|
|||
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.
|
||||
|
|
@ -555,7 +555,7 @@ EAPI const char *ecore_file_monitor_path_get(Ecore_File_Monitor *ecore_f
|
|||
/* 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.
|
||||
|
|
@ -568,7 +568,7 @@ EAPI const char *ecore_file_monitor_path_get(Ecore_File_Monitor *ecore_f
|
|||
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,
|
||||
|
|
@ -581,7 +581,7 @@ EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir);
|
|||
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.
|
||||
|
|
@ -596,7 +596,7 @@ EAPI Eina_List *ecore_file_app_list(void);
|
|||
/* 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.
|
||||
|
|
@ -632,7 +632,7 @@ EAPI Eina_Bool ecore_file_download(const char *url,
|
|||
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.
|
||||
|
|
@ -652,7 +652,7 @@ EAPI Eina_Bool ecore_file_download_full(const char *url,
|
|||
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
|
||||
|
|
@ -662,7 +662,7 @@ EAPI Eina_Bool ecore_file_download_full(const char *url,
|
|||
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.
|
||||
|
|
@ -676,7 +676,7 @@ EAPI void ecore_file_download_abort_all(void);
|
|||
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.
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -46,65 +46,65 @@ extern "C" {
|
|||
#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
|
||||
|
|
@ -131,11 +131,11 @@ EAPI void ecore_imf_evas_event_mouse_wheel_wrap(Evas_Event_Mouse_Wheel *evas_eve
|
|||
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
|
||||
|
|
|
|||
Loading…
Reference in New Issue