forked from enlightenment/efl
evas: more documentation of Evas_Common. Fix inline comments
This commit is contained in:
Nicolas Aguirre
Cedric BAIL
parent
c03569e6a7
commit
fe72de9cc0
|
|
@ -29,10 +29,10 @@
|
|||
|
||||
typedef struct _Evas_Version
|
||||
{
|
||||
int major; /** < major (binary or source incompatible changes) */
|
||||
int minor; /** < minor (new features, bugfixes, major improvements version) */
|
||||
int micro; /** < micro (bugfix, internal improvements, no new features version) */
|
||||
int revision; /** < git revision (0 if a proper release or the git revision number Evas is built from) */
|
||||
int major; /**< major (binary or source incompatible changes) */
|
||||
int minor; /**< minor (new features, bugfixes, major improvements version) */
|
||||
int micro; /**< micro (bugfix, internal improvements, no new features version) */
|
||||
int revision; /**< git revision (0 if a proper release or the git revision number Evas is built from) */
|
||||
} Evas_Version;
|
||||
|
||||
EAPI extern Evas_Version * evas_version;
|
||||
|
|
@ -219,8 +219,8 @@ typedef struct _Evas_Point Evas_Point; /**< integer point */
|
|||
typedef struct _Evas_Coord_Point Evas_Coord_Point; /**< Evas_Coord point */
|
||||
typedef struct _Evas_Coord_Precision_Point Evas_Coord_Precision_Point; /**< Evas_Coord point with sub-pixel precision */
|
||||
|
||||
typedef struct _Evas_Coord_Size Evas_Coord_Size; /** <Evas_Coord size @since 1.8 */
|
||||
typedef struct _Evas_Coord_Precision_Size Evas_Coord_Precision_Size; /** <Evas_Coord size with sub-pixel precision @since 1.8 */
|
||||
typedef struct _Evas_Coord_Size Evas_Coord_Size; /**< Evas_Coord size @since 1.8 */
|
||||
typedef struct _Evas_Coord_Precision_Size Evas_Coord_Precision_Size; /**< Evas_Coord size with sub-pixel precision @since 1.8 */
|
||||
|
||||
typedef struct _Evas_Position Evas_Position; /**< associates given point in Canvas and Output */
|
||||
typedef struct _Evas_Precision_Position Evas_Precision_Position; /**< associates given point in Canvas and Output, with sub-pixel precision */
|
||||
|
|
@ -298,6 +298,7 @@ typedef struct _Evas_Public_Data Evas_Public_Data;
|
|||
*/
|
||||
typedef Eo Evas_Object;
|
||||
|
||||
/* This define is used in H files generated by Eolian */
|
||||
#define _EVAS_OBJECT_EO_CLASS_TYPE
|
||||
|
||||
typedef void Evas_Performance; /**< An Evas Performance handle */
|
||||
|
|
@ -318,9 +319,9 @@ typedef struct _Evas_Video_Surface Evas_Video_Surface;
|
|||
|
||||
typedef unsigned long long Evas_Modifier_Mask; /**< An Evas modifier mask type */
|
||||
|
||||
typedef int Evas_Coord /**< A type for coordinates */;
|
||||
typedef int Evas_Font_Size;
|
||||
typedef int Evas_Angle;
|
||||
typedef int Evas_Coord;/**< A type for coordinates */;
|
||||
typedef int Evas_Font_Size; /**< A type for font size */
|
||||
typedef int Evas_Angle; /**< A type for angle */
|
||||
|
||||
struct _Evas_Coord_Rectangle /**< A rectangle in Evas_Coord */
|
||||
{
|
||||
|
|
@ -345,18 +346,18 @@ struct _Evas_Coord_Size /**< A size in Evas_Coord */
|
|||
|
||||
struct _Evas_Coord_Precision_Size
|
||||
{
|
||||
Evas_Coord w; /** < width */
|
||||
Evas_Coord h; /** < height */
|
||||
double wsub; /** < subpixel precision for width */
|
||||
double ysub; /** < subpixel precision for height */
|
||||
Evas_Coord w; /**< width */
|
||||
Evas_Coord h; /**< height */
|
||||
double wsub; /**< subpixel precision for width */
|
||||
double ysub; /**< subpixel precision for height */
|
||||
};
|
||||
|
||||
struct _Evas_Coord_Precision_Point
|
||||
{
|
||||
Evas_Coord x; /**< x co-ordinate */
|
||||
Evas_Coord y; /**< y co-ordinate */
|
||||
double xsub; /** < subpixel precision for x */
|
||||
double ysub; /** < subpixel precision for y */
|
||||
double xsub; /**< subpixel precision for x */
|
||||
double ysub; /**< subpixel precision for y */
|
||||
};
|
||||
|
||||
struct _Evas_Point
|
||||
|
|
@ -442,7 +443,11 @@ struct _Evas_Pixel_Import_Source
|
|||
void **rows; /**< an array of pointers (size depends on format) pointing to left edge of each scanline */
|
||||
};
|
||||
|
||||
/* magic version number to know what the native surf struct looks like */
|
||||
/**
|
||||
* @def EVAS_NATIVE_SURFACE_VERSION
|
||||
* Magic version number to know what the native surface struct looks like
|
||||
*/
|
||||
|
||||
#define EVAS_NATIVE_SURFACE_VERSION 2
|
||||
|
||||
/**
|
||||
|
|
@ -504,8 +509,9 @@ struct _Evas_Native_Surface
|
|||
*/
|
||||
#define EVAS_VIDEO_SURFACE_VERSION 1
|
||||
|
||||
typedef void (*Evas_Video_Cb)(void *data, Evas_Object *obj, const Evas_Video_Surface *surface);
|
||||
typedef void (*Evas_Video_Coord_Cb)(void *data, Evas_Object *obj, const Evas_Video_Surface *surface, Evas_Coord a, Evas_Coord b);
|
||||
|
||||
typedef void (*Evas_Video_Cb)(void *data, Evas_Object *obj, const Evas_Video_Surface *surface); /**< Evas video callback function signature */
|
||||
typedef void (*Evas_Video_Coord_Cb)(void *data, Evas_Object *obj, const Evas_Video_Surface *surface, Evas_Coord a, Evas_Coord b); /**< Evas video coordinates callback function signature */
|
||||
|
||||
struct _Evas_Video_Surface
|
||||
{
|
||||
|
|
@ -521,14 +527,20 @@ struct _Evas_Video_Surface
|
|||
void *data;
|
||||
};
|
||||
|
||||
/**
|
||||
* Enum values for the Video surface capabilities
|
||||
* @see evas_object_image_video_surface_caps_get()
|
||||
* @see evas_object_image_video_surface_caps_set()
|
||||
*/
|
||||
|
||||
typedef enum _Evas_Video_Surface_Caps
|
||||
{
|
||||
EVAS_VIDEO_SURFACE_MOVE = 1,
|
||||
EVAS_VIDEO_SURFACE_RESIZE = 2,
|
||||
EVAS_VIDEO_SURFACE_CLIP = 4,
|
||||
EVAS_VIDEO_SURFACE_BELOW = 8,
|
||||
EVAS_VIDEO_SURFACE_STACKING_CHECK = 16,
|
||||
EVAS_VIDEO_SURFACE_IGNORE_WINDOW = 32,
|
||||
EVAS_VIDEO_SURFACE_MOVE = 1, /**< Move capability */
|
||||
EVAS_VIDEO_SURFACE_RESIZE = 2, /**< Resize capability */
|
||||
EVAS_VIDEO_SURFACE_CLIP = 4, /**< Clip capability */
|
||||
EVAS_VIDEO_SURFACE_BELOW = 8, /**< Below capability */
|
||||
EVAS_VIDEO_SURFACE_STACKING_CHECK = 16, /**< Stacking capability */
|
||||
EVAS_VIDEO_SURFACE_IGNORE_WINDOW = 32, /**< Ignore window capability */
|
||||
} Evas_Video_Surface_Caps;
|
||||
|
||||
#define EVAS_LAYER_MIN -32768 /**< bottom-most layer number */
|
||||
|
|
@ -576,8 +588,8 @@ typedef enum _Evas_Border_Fill_Mode
|
|||
typedef enum _Evas_Engine_Render_Mode
|
||||
{
|
||||
EVAS_RENDER_MODE_BLOCKING = 0, /**< The rendering is blocking mode*/
|
||||
EVAS_RENDER_MODE_NONBLOCKING = 1, /** < The rendering is non blocking mode*/
|
||||
} Evas_Engine_Render_Mode;
|
||||
EVAS_RENDER_MODE_NONBLOCKING = 1, /**< The rendering is non blocking mode*/
|
||||
} Evas_Engine_Render_Mode; /**< behaviour of the renderer*/
|
||||
|
||||
typedef enum _Evas_Image_Content_Hint
|
||||
{
|
||||
|
|
@ -613,12 +625,12 @@ typedef enum _Evas_Device_Subclass
|
|||
EVAS_DEVICE_SUBCLASS_TRACKBALL, /**< A trackball style mouse @since 1.8 */
|
||||
} Evas_Device_Subclass; /**< A general class of device @since 1.8 */
|
||||
|
||||
struct _Evas_Engine_Info /** Generic engine information. Generic info is useless */
|
||||
struct _Evas_Engine_Info /**< Generic engine information. Generic info is useless */
|
||||
{
|
||||
int magic; /**< Magic number */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Mouse_Down /** Mouse button press event */
|
||||
struct _Evas_Event_Mouse_Down /**< Mouse button press event */
|
||||
{
|
||||
int button; /**< Mouse button number that went down (1 - 32) */
|
||||
|
||||
|
|
@ -636,7 +648,7 @@ struct _Evas_Event_Mouse_Down /** Mouse button press event */
|
|||
Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Mouse_Up /** Mouse button release event */
|
||||
struct _Evas_Event_Mouse_Up /**< Mouse button release event */
|
||||
{
|
||||
int button; /**< Mouse button number that was raised (1 - 32) */
|
||||
|
||||
|
|
@ -654,7 +666,7 @@ struct _Evas_Event_Mouse_Up /** Mouse button release event */
|
|||
Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Mouse_In /** Mouse enter event */
|
||||
struct _Evas_Event_Mouse_In /**< Mouse enter event */
|
||||
{
|
||||
int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */
|
||||
|
||||
|
|
@ -670,7 +682,7 @@ struct _Evas_Event_Mouse_In /** Mouse enter event */
|
|||
Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Mouse_Out /** Mouse leave event */
|
||||
struct _Evas_Event_Mouse_Out /**< Mouse leave event */
|
||||
{
|
||||
int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */
|
||||
|
||||
|
|
@ -686,7 +698,7 @@ struct _Evas_Event_Mouse_Out /** Mouse leave event */
|
|||
Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Mouse_Move /** Mouse move event */
|
||||
struct _Evas_Event_Mouse_Move /**< Mouse move event */
|
||||
{
|
||||
int buttons; /**< Button pressed mask, Bits set to 1 are buttons currently pressed (bit 0 = mouse button 1, bit 1 = mouse button 2 etc.) */
|
||||
|
||||
|
|
@ -702,7 +714,7 @@ struct _Evas_Event_Mouse_Move /** Mouse move event */
|
|||
Evas_Object *event_src; /**< The Evas Object which actually triggered the event, used in cases of proxy event propagation */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Mouse_Wheel /** Wheel event */
|
||||
struct _Evas_Event_Mouse_Wheel /**< Wheel event */
|
||||
{
|
||||
int direction; /* 0 = default up/down wheel FIXME: more wheel types */
|
||||
int z; /* ...,-2,-1 = down, 1,2,... = up */
|
||||
|
|
@ -718,7 +730,7 @@ struct _Evas_Event_Mouse_Wheel /** Wheel event */
|
|||
Evas_Device *dev;
|
||||
};
|
||||
|
||||
struct _Evas_Event_Multi_Down /** Multi button press event */
|
||||
struct _Evas_Event_Multi_Down /**< Multi button press event */
|
||||
{
|
||||
int device; /**< Multi device number that went down (1 or more for extra touches) */
|
||||
double radius, radius_x, radius_y;
|
||||
|
|
@ -737,7 +749,7 @@ struct _Evas_Event_Multi_Down /** Multi button press event */
|
|||
Evas_Device *dev;
|
||||
};
|
||||
|
||||
struct _Evas_Event_Multi_Up /** Multi button release event */
|
||||
struct _Evas_Event_Multi_Up /**< Multi button release event */
|
||||
{
|
||||
int device; /**< Multi device number that went up (1 or more for extra touches) */
|
||||
double radius, radius_x, radius_y;
|
||||
|
|
@ -756,7 +768,7 @@ struct _Evas_Event_Multi_Up /** Multi button release event */
|
|||
Evas_Device *dev;
|
||||
};
|
||||
|
||||
struct _Evas_Event_Multi_Move /** Multi button down event */
|
||||
struct _Evas_Event_Multi_Move /**< Multi button down event */
|
||||
{
|
||||
int device; /**< Multi device number that moved (1 or more for extra touches) */
|
||||
double radius, radius_x, radius_y;
|
||||
|
|
@ -772,7 +784,7 @@ struct _Evas_Event_Multi_Move /** Multi button down event */
|
|||
Evas_Device *dev;
|
||||
};
|
||||
|
||||
struct _Evas_Event_Key_Down /** Key press event */
|
||||
struct _Evas_Event_Key_Down /**< Key press event */
|
||||
{
|
||||
char *keyname; /**< the name string of the key pressed */
|
||||
void *data;
|
||||
|
|
@ -789,7 +801,7 @@ struct _Evas_Event_Key_Down /** Key press event */
|
|||
unsigned int keycode; /**< Key scan code numeric value @since 1.10 */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Key_Up /** Key release event */
|
||||
struct _Evas_Event_Key_Up /**< Key release event */
|
||||
{
|
||||
char *keyname; /**< the name string of the key released */
|
||||
void *data;
|
||||
|
|
@ -806,12 +818,12 @@ struct _Evas_Event_Key_Up /** Key release event */
|
|||
unsigned int keycode; /**< Key scan code numeric value @since 1.10 */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Render_Post /** Send when the frame rendering is done @since 1.8 */
|
||||
struct _Evas_Event_Render_Post /**< Send when the frame rendering is done @since 1.8 */
|
||||
{
|
||||
Eina_List *updated_area; /**< A list of rectangle that were updated in the canvas */
|
||||
};
|
||||
|
||||
struct _Evas_Event_Hold /** Hold change event */
|
||||
struct _Evas_Event_Hold /**< Hold change event */
|
||||
{
|
||||
int hold; /**< The hold flag */
|
||||
void *data;
|
||||
|
|
@ -845,9 +857,9 @@ typedef enum _Evas_Object_Pointer_Mode
|
|||
|
||||
typedef void (*Evas_Smart_Cb)(void *data, Evas_Object *obj, void *event_info); /**< Evas smart objects' "smart callback" function signature */
|
||||
typedef void (*Evas_Event_Cb)(void *data, Evas *e, void *event_info); /**< Evas event callback function signature */
|
||||
typedef Eina_Bool (*Evas_Object_Event_Post_Cb)(void *data, Evas *e);
|
||||
typedef Eina_Bool (*Evas_Object_Event_Post_Cb)(void *data, Evas *e); /**< Evas object event (post) callback function signature */
|
||||
typedef void (*Evas_Object_Event_Cb)(void *data, Evas *e, Evas_Object *obj, void *event_info); /**< Evas object event callback function signature */
|
||||
typedef void (*Evas_Async_Events_Put_Cb)(void *target, Evas_Callback_Type type, void *event_info);
|
||||
typedef void (*Evas_Async_Events_Put_Cb)(void *target, Evas_Callback_Type type, void *event_info); /**< Evas async callback function signature */
|
||||
|
||||
/**
|
||||
* @defgroup Evas_Main_Group Top Level Functions
|
||||
|
|
@ -2993,6 +3005,13 @@ EAPI Eina_Bool evas_object_image_extension_can_load_fast_get
|
|||
#define EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET(x, s) \
|
||||
do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_SHADOW_DIRECTION) | (s); } while (0)
|
||||
|
||||
/**
|
||||
* @typedef Evas_Text_Style_Type
|
||||
*
|
||||
* Types of styles to be applied on text objects. The @c
|
||||
* EVAS_TEXT_STYLE_SHADOW_DIRECTION_* ones are to be ORed together with others
|
||||
* imposing shadow, to change shadow's direction
|
||||
*/
|
||||
typedef enum _Evas_Text_Style_Type
|
||||
{
|
||||
EVAS_TEXT_STYLE_PLAIN, /**< plain, standard text */
|
||||
|
|
@ -3015,8 +3034,7 @@ typedef enum _Evas_Text_Style_Type
|
|||
EVAS_TEXT_STYLE_SHADOW_DIRECTION_TOP = (0x5 << 4), /**< shadow growing to the top */
|
||||
EVAS_TEXT_STYLE_SHADOW_DIRECTION_TOP_RIGHT = (0x6 << 4), /**< shadow growing to top right */
|
||||
EVAS_TEXT_STYLE_SHADOW_DIRECTION_RIGHT = (0x7 << 4) /**< shadow growing to the right */
|
||||
} Evas_Text_Style_Type; /**< Types of styles to be applied on text objects. The @c EVAS_TEXT_STYLE_SHADOW_DIRECTION_* ones are to be ORed together with others imposing shadow, to change shadow's direction */
|
||||
|
||||
} Evas_Text_Style_Type;
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
|
@ -3758,6 +3776,13 @@ EAPI int evas_textblock_cursor_line_coord_s
|
|||
* @return a list of Rectangles representing the geometry of the range.
|
||||
*/
|
||||
EAPI Eina_List *evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2);
|
||||
|
||||
/**
|
||||
* Get the geometry of ?
|
||||
*
|
||||
* @param cur one side of the range.
|
||||
* @param cur2 other side of the range.
|
||||
*/
|
||||
EAPI Eina_Bool evas_textblock_cursor_format_item_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch) EINA_ARG_NONNULL(1);
|
||||
|
||||
/**
|
||||
|
|
|
|||
Loading…
Reference in New Issue