/**
* @def EVAS_CALLBACK_PRIORITY_BEFORE
* Slightly more prioritized than default.
- * @since 1.1.0
+ * @since 1.1
*/
#define EVAS_CALLBACK_PRIORITY_BEFORE -100
/**
* @def EVAS_CALLBACK_PRIORITY_DEFAULT
* Default callback priority level
- * @since 1.1.0
+ * @since 1.1
*/
#define EVAS_CALLBACK_PRIORITY_DEFAULT 0
/**
* @def EVAS_CALLBACK_PRIORITY_AFTER
* Slightly less prioritized than default.
- * @since 1.1.0
+ * @since 1.1
*/
#define EVAS_CALLBACK_PRIORITY_AFTER 100
* @see EVAS_CALLBACK_PRIORITY_BEFORE
* @see EVAS_CALLBACK_PRIORITY_DEFAULT
*
- * @since 1.1.0
+ * @since 1.1
*/
typedef short Evas_Callback_Priority;
* more than one interface, thus extending the behavior it gets from
* sub-classing.
*
- * @since 1.3
+ * @since 1.7
*
* @ingroup Evas_Smart_Group
*/
* A generic datatype for video specific surface information
* @see evas_object_image_video_surface_set
* @see evas_object_image_video_surface_get
- * @since 1.1.0
+ * @since 1.1
*/
typedef struct _Evas_Video_Surface Evas_Video_Surface;
/**
* @def EVAS_VIDEO_SURFACE_VERSION
* Magic version number to know what the video surf struct looks like
- * @since 1.1.0
+ * @since 1.1
*/
#define EVAS_VIDEO_SURFACE_VERSION 1
* @param w The width in output units, usually pixels.
* @param h The height in output units, usually pixels.
* @ingroup Evas_Output_Size
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_output_framespace_set(Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h);
* @param w The pointer to a width variable to be filled in
* @param h The pointer to a height variable to be filled in
* @ingroup Evas_Output_Size
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_output_framespace_get(const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
* @param data The data pointer to be passed to @p func
*
* @see evas_event_callback_add
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_event_callback_priority_add(Evas *e, Evas_Callback_Type type, Evas_Callback_Priority priority, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 4);
* @endcode
*
* @ingroup Evas_Object_Group_Basic
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_ref(Evas_Object *obj);
* @see evas_object_del()
*
* @ingroup Evas_Object_Group_Basic
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_unref(Evas_Object *obj);
* @see evas_object_del()
*
* @ingroup Evas_Object_Group_Basic
- * @since 1.2.0
+ * @since 1.2
*/
EAPI int evas_object_ref_get(const Evas_Object *obj);
* @param data The data pointer to be passed to @p func
*
* @see evas_object_event_callback_add
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_event_callback_priority_add(Evas_Object *obj, Evas_Callback_Type type, Evas_Callback_Priority priority, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 4);
* @see evas_object_pass_events_set()
* @see evas_object_repeat_events_set()
* @see evas_object_propagate_events_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_freeze_events_set(Evas_Object *obj, Eina_Bool freeze) EINA_ARG_NONNULL(1);
* @see evas_object_pass_events_get()
* @see evas_object_repeat_events_get()
* @see evas_object_propagate_events_get()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_freeze_events_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
*
* @param obj The given image object pointer
* @return The region support state
- * @since 1.2.0
+ * @since 1.2
*
* This function returns the state of the region support of given image
*/
*
* @param obj The given canvas pointer.
* @param surf The new video surface.
- * @since 1.1.0
+ * @since 1.1
*
* This function link a video surface to a given canvas image.
*
*
* @param obj The given canvas pointer.
* @return The video surface of the given canvas image.
- * @since 1.1.0
+ * @since 1.1
*
* This function returns the video surface linked to a given canvas image.
*
* @param file The file to check
* @return @c EINA_TRUE if we may be able to open it, @c EINA_FALSE if it's
* unlikely.
- * @since 1.1.0
+ * @since 1.1
*
* If file is a Eina_Stringshare, use directly @ref evas_object_image_extension_can_load_fast_get.
*
* @param file The file to check, it should be an Eina_Stringshare.
* @return @c EINA_TRUE if we may be able to open it, @c EINA_FALSE if it's
* unlikely.
- * @since 1.1.0
+ * @since 1.1
*
* This functions is threadsafe.
*/
* @see evas_object_image_animated_loop_count_get()
* @see evas_object_image_animated_frame_duration_get()
* @see evas_object_image_animated_frame_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_image_animated_get(const Evas_Object *obj);
* @see evas_object_image_animated_loop_count_get()
* @see evas_object_image_animated_frame_duration_get()
* @see evas_object_image_animated_frame_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI int evas_object_image_animated_frame_count_get(const Evas_Object *obj);
* @see evas_object_image_animated_loop_count_get()
* @see evas_object_image_animated_frame_duration_get()
* @see evas_object_image_animated_frame_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Evas_Image_Animated_Loop_Hint evas_object_image_animated_loop_type_get(const Evas_Object *obj);
* @see evas_object_image_animated_loop_count_get()
* @see evas_object_image_animated_frame_duration_get()
* @see evas_object_image_animated_frame_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI int evas_object_image_animated_loop_count_get(const Evas_Object *obj);
* @see evas_object_image_animated_loop_count_get()
* @see evas_object_image_animated_frame_duration_get()
* @see evas_object_image_animated_frame_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI double evas_object_image_animated_frame_duration_get(const Evas_Object *obj, int start_frame, int fram_num);
* @see evas_object_image_animated_loop_count_get()
* @see evas_object_image_animated_frame_duration_get()
* @see evas_object_image_animated_frame_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_image_animated_frame_set(Evas_Object *obj, int frame_num);
/**
*
* @param obj The given text object.
* @param delim A null terminated string of delimiters, e.g ",|".
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_text_bidi_delimiters_set(Evas_Object *obj, const char *delim);
*
* @param obj The given text object.
* @return A null terminated string of delimiters, e.g ",|". If empty, returns NULL.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI const char *evas_object_text_bidi_delimiters_get(const Evas_Object *obj);
* default).
* @param text The markup text (if @c NULL, return @c NULL).
* @return An allocated plain text version of the markup.
- * @since 1.2.0
+ * @since 1.2
*/
EAPI char *evas_textblock_text_markup_to_utf8(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC;
* default behaviour, i.e with no extra object information).
* @param text The markup text (if @c NULL, return @c NULL).
* @return An allocated plain text version of the markup.
- * @since 1.2.0
+ * @since 1.2
*/
EAPI char *evas_textblock_text_utf8_to_markup(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC;
* @param ts the style to set.
* @return Returns no value.
* @see evas_object_textblock_style_set
- * @since 1.2.0
+ * @since 1.2
*/
EAPI void evas_object_textblock_style_user_push(Evas_Object *obj, Evas_Textblock_Style *ts) EINA_ARG_NONNULL(1);
*
* @param obj the object to get the style from.
* @see evas_object_textblock_style_get
- * @since 1.2.0
+ * @since 1.2
*/
EAPI void evas_object_textblock_style_user_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
* @param obj the object to get the style from.
* @return the style of the object.
* @see evas_object_textblock_style_get
- * @since 1.2.0
+ * @since 1.2
*/
EAPI const Evas_Textblock_Style *evas_object_textblock_style_user_peek(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
*
* @param obj The given textblock object.
* @param align A value between @c 0.0 and @c 1.0.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_textblock_valign_set(Evas_Object *obj, double align);
*
* @param obj The given textblock object.
* @return The alignment set for the object.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI double evas_object_textblock_valign_get(const Evas_Object *obj);
*
* @param obj The given textblock object.
* @param delim A null terminated string of delimiters, e.g ",|".
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_textblock_bidi_delimiters_set(Evas_Object *obj, const char *delim);
* @param obj The given textblock object.
* @return A null terminated string of delimiters, e.g ",|". If empty, returns
* @c NULL.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI const char *evas_object_textblock_bidi_delimiters_get(const Evas_Object *obj);
*
* @param obj The given textblock object.
* @param mode @c EINA_TRUE for legacy mode, @c EINA_FALSE otherwise.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_textblock_legacy_newline_set(Evas_Object *obj, Eina_Bool mode) EINA_ARG_NONNULL(1);
*
* @param obj The given textblock object.
* @return @c EINA_TRUE if in legacy mode, @c EINA_FALSE otherwise.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_textblock_legacy_newline_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
*
* @param cur the cursor to move.
* @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
- * @since 1.2.0
+ * @since 1.2
*/
EAPI Eina_Bool evas_textblock_cursor_word_start(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1);
*
* @param cur the cursor to move.
* @return @c EINA_TRUE on success @c EINA_FALSE otherwise.
- * @since 1.2.0
+ * @since 1.2
*/
EAPI Eina_Bool evas_textblock_cursor_word_end(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1);
* @param start the start of the range.
* @param end the end of the range.
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_textblock_cursor_visible_range_get(Evas_Textblock_Cursor *start, Evas_Textblock_Cursor *end) EINA_ARG_NONNULL(1, 2);
* @param cur1 one side of the range.
* @param cur2 the other side of the range
* @return the foramt nodes in the range. You have to free it.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_List *evas_textblock_cursor_range_formats_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2);
*
* @todo put here some usage examples
*
- * @since 1.3
+ * @since 1.7
*
* @ingroup Evas_Object_Specific
*
*
* The palette to use for the forgraound and background colors.
*
- * @since 1.3
+ * @since 1.7
*/
typedef enum
{
*
* The style to give to each character of the grid.
*
- * @since 1.3
+ * @since 1.7
*/
typedef enum
{
*
* The values that describes each cell.
*
- * @since 1.3
+ * @since 1.7
*/
typedef struct _Evas_Textgrid_Cell Evas_Textgrid_Cell;
*
* The values that describes each cell.
*
- * @since 1.3
+ * @since 1.7
*/
struct _Evas_Textgrid_Cell
{
*
* This function adds a new textgrid object to the Evas @p e and returns the object.
*
- * @since 1.3
+ * @since 1.7
*/
EAPI Evas_Object *evas_object_textgrid_add(Evas *e);
* @p w or @p h are less or equal than 0, this
* functiond does nothing.
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_size_set(Evas_Object *obj, int w, int h);
* the textgrid object @p obj. @p w or @p h can be
* @c NULL. On error, their value is 0.
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_size_get(const Evas_Object *obj, int *w, int *h);
* @see evas_object_textgrid_font_set()
* @see evas_object_textgrid_font_source_get()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_font_source_set(Evas_Object *obj, const char *font_source);
* @see evas_object_textgrid_font_set()
* @see evas_object_textgrid_font_source_set()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI const char *evas_object_textgrid_font_source_get(const Evas_Object *obj);
* @see evas_object_textgrid_font_source_set()
* @see evas_object_textgrid_font_source_get()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_font_set(Evas_Object *obj, const char *font_name, Evas_Font_Size font_size);
* @see evas_object_textgrid_font_source_set()
* @see evas_object_textgrid_font_source_get()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_font_get(const Evas_Object *obj, const char **font_name, Evas_Font_Size *font_size);
* @see evas_object_textgrid_font_set()
* @see evas_object_textgrid_supported_font_styles_set()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_cell_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h);
*
* @see evas_object_textgrid_palette_get()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_palette_set(Evas_Object *obj, Evas_Textgrid_Palette pal, int idx, int r, int g, int b, int a);
*
* @see evas_object_textgrid_palette_set()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_palette_get(const Evas_Object *obj, Evas_Textgrid_Palette pal, int idx, int *r, int *g, int *b, int *a);
* @see evas_object_textgrid_size_set()
* @see evas_object_textgrid_update_add()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_cellrow_set(Evas_Object *obj, int y, const Evas_Textgrid_Cell *row);
* @see evas_object_textgrid_size_set()
* @see evas_object_textgrid_update_add()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI Evas_Textgrid_Cell *evas_object_textgrid_cellrow_get(const Evas_Object *obj, int y);
* @see evas_object_textgrid_cellrow_get()
* @see evas_object_textgrid_size_set()
*
- * @since 1.3
+ * @since 1.7
*/
EAPI void evas_object_textgrid_update_add(Evas_Object *obj, int x, int y, int w, int h);
* @}
*/
-/* @since 1.2.0 */
+/* @since 1.2 */
EAPI void evas_object_is_frame_object_set(Evas_Object *obj, Eina_Bool is_frame);
-/* @since 1.2.0 */
+/* @since 1.2 */
EAPI Eina_Bool evas_object_is_frame_object_get(Evas_Object *obj);
/**
const Evas_Smart_Class *parent; /**< this class inherits from this parent */
const Evas_Smart_Cb_Description *callbacks; /**< callbacks at this level, @c NULL terminated */
- const Evas_Smart_Interface **interfaces; /**< #Evas_Smart_Interface pointers array, @c NULL terminated. These will be the interfaces supported at this level for an object (parents may have others) @since 1.3 */
+ const Evas_Smart_Interface **interfaces; /**< #Evas_Smart_Interface pointers array, @c NULL terminated. These will be the interfaces supported at this level for an object (parents may have others) @since 1.7 */
const void *data;
};
* See also some @ref Example_Evas_Smart_Interfaces "examples" on
* smart interfaces.
*
- * @since 1.3
+ * @since 1.7
*
* @ingroup Evas_Smart_Group
*/
/**
* @def EVAS_SMART_SUBCLASS_IFACE_NEW
*
- * @since 1.3
+ * @since 1.7
*
* Convenience macro to subclass a given Evas smart class. This is the
* same as #EVAS_SMART_SUBCLASS_NEW, but now <b>declaring smart
* The returned list should be freed with @c eina_list_free() when you
* no longer need it.
*
- * @since 1.3 This function will return @c NULL when a non-smart object is passed.
+ * @since 1.7 This function will return @c NULL when a non-smart object is passed.
*
* @see evas_object_smart_member_add()
* @see evas_object_smart_member_del()
* @param data user data to be passed to the callback function
*
* @see evas_object_smart_callback_add
- * @since 1.1.0
+ * @since 1.1
* @ingroup Evas_Smart_Object_Group
*/
EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, const char *event, Evas_Callback_Priority priority, Evas_Smart_Cb func, const void *data);
* remove an exact match of a callback
*
* @see evas_object_smart_callback_add() for more details.
- * @since 1.2.0
+ * @since 1.2
* @ingroup Evas_Smart_Object_Group
*
* @note To delete all smart event callbacks which match @p type and @p func,
* same pointer used at the interface's declarion, when
* creating the smart object @a obj.
*
- * @since 1.3
+ * @since 1.7
*
* @return The interface's handle pointer, if found, @c NULL
* otherwise.
* @param obj An Evas smart object.
* @param iface The given object's interface handle.
*
- * @since 1.3
+ * @since 1.7
*
* @return The object interface's private data blob pointer, if found,
* @c NULL otherwise.
*
* @param o The table object.
* @param mirrored the mirrored mode to set
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_table_mirrored_set(Evas_Object *o, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
*
* @param o The table object.
* @return @c EINA_TRUE if it's a mirrored table, @c EINA_FALSE otherwise.
- * @since 1.1.0
+ * @since 1.1
* @see evas_object_table_mirrored_set()
*/
EAPI Eina_Bool evas_object_table_mirrored_get(const Evas_Object *o) EINA_ARG_NONNULL(1);
* @param rowspan pointer to store how many relative-vertical position to use for this child.
*
* @return 1 on success, 0 on failure.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_table_pack_get(const Evas_Object *o, Evas_Object *child, unsigned short *col, unsigned short *row, unsigned short *colspan, unsigned short *rowspan);
* children's positions inside the grid object's area.
*
* @ingroup Evas_Smart_Object_Group
- * @since 1.1.0
+ * @since 1.1
*/
/**
*
* It's set to a virtual size of 1x1 by default and add children with
* evas_object_grid_pack().
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Evas_Object *evas_object_grid_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
* Create a grid that is child of a given element @a parent.
*
* @see evas_object_grid_add()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Evas_Object *evas_object_grid_add_to(Evas_Object *parent) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
* @param o The grid object to modify
* @param w The virtual horizontal size (resolution) in integer units
* @param h The virtual vertical size (resolution) in integer units
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_grid_size_set(Evas_Object *o, int w, int h) EINA_ARG_NONNULL(1);
* @param w A pointer to an integer to store the virtual width
* @param h A pointer to an integer to store the virtual height
* @see evas_object_grid_size_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_grid_size_get(const Evas_Object *o, int *w, int *h) EINA_ARG_NONNULL(1);
*
* @param o The grid object.
* @param mirrored the mirrored mode to set
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_grid_mirrored_set(Evas_Object *o, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
* @param o The grid object.
* @return @c EINA_TRUE if it's a mirrored grid, @c EINA_FALSE otherwise.
* @see evas_object_grid_mirrored_set()
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_grid_mirrored_get(const Evas_Object *o) EINA_ARG_NONNULL(1);
* @param w The virtual width of the child
* @param h The virtual height of the child
* @return 1 on success, 0 on failure.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_grid_pack(Evas_Object *o, Evas_Object *child, int x, int y, int w, int h) EINA_ARG_NONNULL(1, 2);
* all children, use evas_object_grid_clear() instead.
*
* @return 1 on success, 0 on failure.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_grid_unpack(Evas_Object *o, Evas_Object *child) EINA_ARG_NONNULL(1, 2);
*
* @param o The given grid object.
* @param clear if true, it will delete just removed children.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI void evas_object_grid_clear(Evas_Object *o, Eina_Bool clear) EINA_ARG_NONNULL(1);
* @param w The pointer to where the width will be returned
* @param h The pointer to where the height will be returned
* @return 1 on success, 0 on failure.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Bool evas_object_grid_pack_get(const Evas_Object *o, Evas_Object *child, int *x, int *y, int *w, int *h);
* Get an iterator to walk the list of children for the grid.
*
* @note Do not remove or delete objects while walking the list.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Iterator *evas_object_grid_iterator_new(const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
* Get an accessor to get random access to the list of children for the grid.
*
* @note Do not remove or delete objects while walking the list.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_Accessor *evas_object_grid_accessor_new(const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
* It's up to the user to destroy it when it no longer needs it.
* It's possible to remove objects from the grid when walking this
* list, but these removals won't be reflected on it.
- * @since 1.1.0
+ * @since 1.1
*/
EAPI Eina_List *evas_object_grid_children_get(const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
projects / framework / uifw / evas.git / commitdiff