summaryrefslogtreecommitdiff
path: root/src/lib/evas/Evas_Common.h
diff options
context:
space:
mode:
authorNicolas Aguirre <aguirre.nicolas@gmail.com>2014-10-16 11:19:15 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:17:26 +0200
commit8b582dc0f5fb8da301061ac3dd972fb835356385 (patch)
treef580af0e95191e67b8112c324fbff858b0c73a32 /src/lib/evas/Evas_Common.h
parent0f6e45e2a04bdc4a6c040fa41b28339ab807aae8 (diff)
evas: add more documentation in Evas_Common.h.
Diffstat (limited to 'src/lib/evas/Evas_Common.h')
-rw-r--r--src/lib/evas/Evas_Common.h48
1 files changed, 41 insertions, 7 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index c1f78f889c..95f788652e 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -1037,6 +1037,8 @@ EAPI int evas_async_events_process(void);
1037 * @param event_info Information about the event. 1037 * @param event_info Information about the event.
1038 * @param func The callback function pointer. 1038 * @param func The callback function pointer.
1039 * 1039 *
1040 * @return EINA_FALSE if an error occured, EINA_TRUE otherwise.
1041 *
1040 * This is the way, for a routine running outside evas' main thread, 1042 * This is the way, for a routine running outside evas' main thread,
1041 * to report an asynchronous event. A callback function is informed, 1043 * to report an asynchronous event. A callback function is informed,
1042 * whose call is to happen after evas_async_events_process() is 1044 * whose call is to happen after evas_async_events_process() is
@@ -2333,6 +2335,7 @@ EAPI void evas_map_alpha_set(Evas_Map *m, Eina_Bool enabled);
2333 * This gets the alpha flag for map rendering. 2335 * This gets the alpha flag for map rendering.
2334 * 2336 *
2335 * @param m map to get the alpha from. Must not be NULL. 2337 * @param m map to get the alpha from. Must not be NULL.
2338 * @return EINA_FALSE if map is NULL EINA_TRUE otherwise.
2336 */ 2339 */
2337EAPI Eina_Bool evas_map_alpha_get(const Evas_Map *m); 2340EAPI Eina_Bool evas_map_alpha_get(const Evas_Map *m);
2338 2341
@@ -2915,7 +2918,14 @@ typedef void (*Evas_Object_Intercept_Clip_Unset_Cb)(void *data, Evas_Object *obj
2915 * @{ 2918 * @{
2916 */ 2919 */
2917 2920
2918 2921/**
2922 * Function signature for the evas object pixels get callback function
2923 * @see evas_object_image_pixels_get()
2924 *
2925 * By @a data it will be passed the private data. By @a o it will be passed the
2926 * Evas_Object image on which the pixels are requested.
2927 *
2928 */
2919typedef void (*Evas_Object_Image_Pixels_Get_Cb)(void *data, Evas_Object *o); 2929typedef void (*Evas_Object_Image_Pixels_Get_Cb)(void *data, Evas_Object *o);
2920 2930
2921/** 2931/**
@@ -3141,31 +3151,55 @@ typedef enum _Evas_Text_Style_Type
3141 * @{ 3151 * @{
3142 */ 3152 */
3143 3153
3154/**
3155 * @typedef Evas_Textblock_Style
3156 *
3157 * A textblock style object.
3158 * @see evas_textblock_style_new()
3159 * @see evas_textblock_style_get()
3160 * @see evas_textblock_style_set()
3161 */
3162
3144typedef struct _Evas_Textblock_Style Evas_Textblock_Style; 3163typedef struct _Evas_Textblock_Style Evas_Textblock_Style;
3164
3165/**
3166 * @typedef Evas_Textblock_Cursor
3167 *
3168 * A textblock cursor object, used to maipulate the cursor of an evas textblock
3169 * @see evas_object_textblock_cursor_new
3170 *
3171 */
3145typedef struct _Evas_Textblock_Cursor Evas_Textblock_Cursor; 3172typedef struct _Evas_Textblock_Cursor Evas_Textblock_Cursor;
3173
3146/** 3174/**
3147 * @typedef Evas_Object_Textblock_Node_Format 3175 * @typedef Evas_Object_Textblock_Node_Format
3148 * A format node. 3176 * A format node.
3149 */ 3177 */
3150typedef struct _Evas_Object_Textblock_Node_Format Evas_Object_Textblock_Node_Format; 3178typedef struct _Evas_Object_Textblock_Node_Format Evas_Object_Textblock_Node_Format;
3151typedef struct _Evas_Textblock_Rectangle Evas_Textblock_Rectangle;
3152 3179
3180typedef struct _Evas_Textblock_Rectangle Evas_Textblock_Rectangle;
3153struct _Evas_Textblock_Rectangle 3181struct _Evas_Textblock_Rectangle
3154{ 3182{
3155 Evas_Coord x, y, w, h; 3183 Evas_Coord x, y, w, h;
3156}; 3184};
3157 3185
3186/**
3187 * Text type for evas textblock.
3188 */
3158typedef enum _Evas_Textblock_Text_Type 3189typedef enum _Evas_Textblock_Text_Type
3159{ 3190{
3160 EVAS_TEXTBLOCK_TEXT_RAW, 3191 EVAS_TEXTBLOCK_TEXT_RAW, /**< textblock text of type raw */
3161 EVAS_TEXTBLOCK_TEXT_PLAIN, 3192 EVAS_TEXTBLOCK_TEXT_PLAIN, /**< textblock text of type plain */
3162 EVAS_TEXTBLOCK_TEXT_MARKUP 3193 EVAS_TEXTBLOCK_TEXT_MARKUP /**< textblock text of type markup */
3163} Evas_Textblock_Text_Type; 3194} Evas_Textblock_Text_Type;
3164 3195
3196/**
3197 * Cursor type for evas textblock.
3198 */
3165typedef enum _Evas_Textblock_Cursor_Type 3199typedef enum _Evas_Textblock_Cursor_Type
3166{ 3200{
3167 EVAS_TEXTBLOCK_CURSOR_UNDER, 3201 EVAS_TEXTBLOCK_CURSOR_UNDER, /**< cursor type is under */
3168 EVAS_TEXTBLOCK_CURSOR_BEFORE 3202 EVAS_TEXTBLOCK_CURSOR_BEFORE /**< cursor type is before */
3169} Evas_Textblock_Cursor_Type; 3203} Evas_Textblock_Cursor_Type;
3170 3204
3171/** 3205/**