bring some sanity back to Evas.h formatting

SVN revision: 72069
This commit is contained in:
Mike Blumenkrantz 2012-06-13 08:12:36 +00:00
parent c4d284c1fe
commit 04f2f44d6a
1 changed files with 1246 additions and 1297 deletions

View File

@ -708,7 +708,6 @@ typedef enum _Evas_Load_Error
EVAS_LOAD_ERROR_UNKNOWN_FORMAT = 6 /**< File is not a known format */
} Evas_Load_Error; /**< Evas image load error codes one can get - see evas_load_error_str() too. */
typedef enum _Evas_Alloc_Error
{
EVAS_ALLOC_ERROR_NONE = 0, /**< No allocation error */
@ -755,11 +754,13 @@ struct _Evas_Native_Surface
int version;
Evas_Native_Surface_Type type;
union {
struct {
struct
{
void *visual; /**< visual of the pixmap to use (Visual) */
unsigned long pixmap; /**< pixmap id to use (Pixmap) */
} x11;
struct {
struct
{
unsigned int texture_id; /**< opengl texture id to use from glGenTextures() */
unsigned int framebuffer_id; /**< 0 if not a FBO, FBO id otherwise from glGenFramebuffers() */
unsigned int internal_format; /**< same as 'internalFormat' for glTexImage2D() */
@ -920,7 +921,6 @@ 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.) */
Evas_Point output;
Evas_Coord_Point canvas;
@ -1156,7 +1156,6 @@ EAPI int evas_init (void);
*/
EAPI int evas_shutdown(void);
/**
* Return if any allocation errors have occurred during the prior function
* @return The allocation error flag
@ -1210,7 +1209,6 @@ EAPI int evas_shutdown (void);
*/
EAPI Evas_Alloc_Error evas_alloc_error(void);
/**
* @brief Get evas' internal asynchronous events read file descriptor.
*
@ -1376,7 +1374,6 @@ EAPI void evas_nochange_push (Evas *e);
*/
EAPI void evas_nochange_pop(Evas *e);
/**
* Attaches a specific pointer to the evas for fetching later
*
@ -1395,7 +1392,6 @@ EAPI void evas_data_attach_set (Evas *e, void *data) E
*/
EAPI void *evas_data_attach_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Add a damage rectangle.
*
@ -1737,7 +1733,6 @@ EAPI Eina_List *evas_render_method_list (void) EINA_WARN_UNUSED
*/
EAPI void evas_render_method_list_free(Eina_List *list);
/**
* Sets the output engine for the given evas.
*
@ -1764,7 +1759,6 @@ EAPI void evas_output_method_set (Evas *e, int render_me
*/
EAPI int evas_output_method_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Retrieves the current render engine info struct from the given evas.
*
@ -2714,7 +2708,6 @@ EAPI void evas_event_feed_hold (Evas *e, int hold, uns
*/
EAPI void evas_event_refeed_event(Evas *e, void *event_copy, Evas_Callback_Type event_type) EINA_ARG_NONNULL(1);
/**
* @}
*/
@ -2837,7 +2830,6 @@ EAPI Evas_Font_Hinting_Flags evas_font_hinting_get (const Evas *e) EINA_
*/
EAPI Eina_Bool evas_font_hinting_can_hint(const Evas *e, Evas_Font_Hinting_Flags hinting) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Force the given evas and associated engine to flush its font cache.
*
@ -2866,7 +2858,6 @@ EAPI void evas_font_cache_set (Evas *e, int size) E
*/
EAPI int evas_font_cache_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* List of available font descriptions known or found by this evas.
*
@ -3120,7 +3111,6 @@ EAPI void evas_object_clip_unset (Evas_Object *obj);
*/
EAPI const Eina_List *evas_object_clipees_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets or unsets a given object as the currently focused one on its
* canvas.
@ -3172,7 +3162,6 @@ EAPI void evas_object_focus_set (Evas_Object *obj, Eina
*/
EAPI Eina_Bool evas_object_focus_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets the layer of its canvas that the given object will be part of.
*
@ -3207,7 +3196,6 @@ EAPI void evas_object_layer_set (Evas_Object *obj, shor
*/
EAPI short evas_object_layer_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets the name of the given Evas object to the given name.
*
@ -3242,7 +3230,6 @@ EAPI void evas_object_name_set (Evas_Object *obj, cons
*/
EAPI const char *evas_object_name_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Increments object reference count to defer its deletion.
*
@ -3320,7 +3307,6 @@ EAPI void evas_object_unref (Evas_Object *obj);
*/
EAPI int evas_object_ref_get(const Evas_Object *obj);
/**
* Marks the given Evas object for deletion (when Evas will free its
* memory).
@ -3435,7 +3421,6 @@ EAPI void evas_object_resize (Evas_Object *obj, Evas
*/
EAPI void evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
/**
* Makes the given Evas object visible.
*
@ -3504,7 +3489,6 @@ EAPI void evas_object_hide (Evas_Object *obj) EINA
*/
EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets the general/main color of the given Evas object to the given
* one.
@ -3563,7 +3547,6 @@ EAPI void evas_object_color_set (Evas_Object *obj, int
*/
EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a) EINA_ARG_NONNULL(1);
/**
* Retrieves the Evas canvas that the given object lives on.
*
@ -4025,7 +4008,6 @@ EAPI void *evas_object_event_callback_del (Evas_Object *obj, Eva
*/
EAPI void *evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3);
/**
* Set whether an Evas object is to pass (ignore) events.
*
@ -4615,7 +4597,6 @@ EAPI void evas_object_map_set (Evas_Object *obj, cons
*/
EAPI const Evas_Map *evas_object_map_get(const Evas_Object *obj);
/**
* Populate source and destination map points to match exactly object.
*
@ -4848,7 +4829,6 @@ EAPI void evas_map_util_3d_perspective (Evas_Map *
*/
EAPI Eina_Bool evas_map_util_clockwise_get(Evas_Map *m);
/**
* Create map of transformation points to be later used with an Evas object.
*
@ -5579,7 +5559,6 @@ EAPI void *evas_object_data_get (const Evas_Obje
*/
EAPI void *evas_object_data_del(Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
/**
* Set pointer behavior.
*
@ -5611,7 +5590,6 @@ EAPI void evas_object_pointer_mode_set (Evas_Object *ob
*/
EAPI Evas_Object_Pointer_Mode evas_object_pointer_mode_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets whether or not the given Evas object is to be drawn anti-aliased.
*
@ -5629,7 +5607,6 @@ EAPI void evas_object_anti_alias_set (Evas_Object *ob
*/
EAPI Eina_Bool evas_object_anti_alias_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets the scaling factor for an Evas object. Does not affect all
* objects.
@ -5663,7 +5640,6 @@ EAPI void evas_object_scale_set (Evas_Object *ob
*/
EAPI double evas_object_scale_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets the render_op to be used for rendering the Evas object.
* @param obj The given Evas object.
@ -6504,7 +6480,6 @@ EAPI Evas_Object *evas_object_rectangle_add (Evas *e) EINA_WARN_UNU
typedef void (*Evas_Object_Image_Pixels_Get_Cb)(void *data, Evas_Object *o);
/**
* Creates a new image object on the given Evas @p e canvas.
*
@ -6549,7 +6524,6 @@ EAPI Evas_Object *evas_object_image_add (Evas *e)
*/
EAPI Evas_Object *evas_object_image_filled_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
/**
* Sets the data for an image from memory to be loaded
*
@ -7436,7 +7410,6 @@ EAPI void evas_object_image_content_hint_set (Evas_Obj
*/
EAPI Evas_Image_Content_Hint evas_object_image_content_hint_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Enable an image to be used as an alpha mask.
*
@ -8297,7 +8270,6 @@ EAPI Evas_BiDi_Direction evas_object_text_direction_get (const Evas_Object *obj
EVAS_TEXTBLOCK_CURSOR_BEFORE
} Evas_Textblock_Cursor_Type;
/**
* Adds a textblock to the given evas.
* @param e The given evas.
@ -8305,7 +8277,6 @@ EAPI Evas_BiDi_Direction evas_object_text_direction_get (const Evas_Object *obj
*/
EAPI Evas_Object *evas_object_textblock_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
/**
* Returns the unescaped version of escape.
* @param escape the string to be escaped
@ -8388,7 +8359,6 @@ EAPI void evas_textblock_style_set(Evas_Textblock_Style
*/
EAPI const char *evas_textblock_style_get(const Evas_Textblock_Style *ts) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Set the objects style to ts.
* @param obj the Evas object to set the style to.
@ -8525,7 +8495,6 @@ EAPI void evas_object_textblock_legacy_newline_set(Evas_
*/
EAPI Eina_Bool evas_object_textblock_legacy_newline_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Sets the tetxblock's text to the markup text.
*
@ -8556,7 +8525,6 @@ EAPI void evas_object_textblock_text_markup_prepend(Evas
*/
EAPI const char *evas_object_textblock_text_markup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
* Return the object's main cursor.
*
@ -8577,7 +8545,6 @@ EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_get(const Evas_Object *
*/
EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_new(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
/**
* Free the cursor and unassociate it from the object.
* @note do not use it to free unassociated cursors.
@ -8587,7 +8554,6 @@ EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_new(const Evas_Ob
*/
EAPI void evas_textblock_cursor_free(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1);
/**
* Sets the cursor to the start of the first text node.
*
@ -8854,7 +8820,6 @@ EAPI int evas_textblock_cursor_compare(const Evas_Textb
*/
EAPI void evas_textblock_cursor_copy(const Evas_Textblock_Cursor *cur, Evas_Textblock_Cursor *cur_dest) EINA_ARG_NONNULL(1, 2);
/**
* Adds text to the current cursor position and set the cursor to *before*
* the start of the text just added.
@ -8877,7 +8842,6 @@ EAPI int evas_textblock_cursor_text_append(Evas_Textblo
*/
EAPI int evas_textblock_cursor_text_prepend(Evas_Textblock_Cursor *cur, const char *text) EINA_ARG_NONNULL(1, 2);
/**
* Adds format to the current cursor position. If the format being added is a
* visible format, add it *before* the cursor position, otherwise, add it after.
@ -8938,7 +8902,6 @@ EAPI void evas_textblock_cursor_char_delete(Evas_Textblo
*/
EAPI void evas_textblock_cursor_range_delete(Evas_Textblock_Cursor *cur1, Evas_Textblock_Cursor *cur2) EINA_ARG_NONNULL(1, 2);
/**
* Return the text of the paragraph cur points to - returns the text in markup.
*
@ -8996,7 +8959,6 @@ EAPI char *evas_textblock_cursor_range_text_get(const Eva
*/
EAPI char *evas_textblock_cursor_content_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
/**
* Returns the geometry of the cursor. Depends on the type of cursor requested.
* This should be used instead of char_geometry_get because there are weird
@ -9086,7 +9048,6 @@ EAPI int evas_textblock_cursor_line_coord_set(Evas_Text
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);
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);
/**
* Checks if the cursor points to the end of the line.
*
@ -9095,7 +9056,6 @@ EAPI Eina_List *evas_textblock_cursor_range_geometry_get(const
*/
EAPI Eina_Bool evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Get the geometry of a line number.
*
@ -9560,7 +9520,6 @@ struct _Evas_Smart_Cb_Description
evas_object_smart_data_set(o, priv); \
}
/**
* Free an #Evas_Smart struct
*
@ -9604,7 +9563,6 @@ EAPI Evas_Smart *evas_smart_class_new (const
*/
EAPI const Evas_Smart_Class *evas_smart_class_get(const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* @brief Get the data pointer set on an #Evas_Smart struct
*
@ -9653,7 +9611,6 @@ EAPI void *evas_smart_data_get (const
*/
EAPI const Evas_Smart_Cb_Description **evas_smart_callbacks_descriptions_get(const Evas_Smart *s, unsigned int *count) EINA_ARG_NONNULL(1, 1);
/**
* Find a callback description for the callback named @a name.
*
@ -9669,7 +9626,6 @@ EAPI const Evas_Smart_Cb_Description **evas_smart_callbacks_descriptions_get(con
*/
EAPI const Evas_Smart_Cb_Description *evas_smart_callback_description_find(const Evas_Smart *s, const char *name) EINA_ARG_NONNULL(1, 2);
/**
* Sets one class to inherit from the other.
*
@ -10062,7 +10018,6 @@ EAPI void *evas_object_smart_callback_del_full(Evas_Object *obj, con
*/
EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char *event, void *event_info) EINA_ARG_NONNULL(1, 2);
/**
* Set an smart object @b instance's smart callbacks descriptions.
*
@ -10150,7 +10105,6 @@ EAPI void evas_object_smart_callbacks_descriptions_get(const Evas_O
*/
EAPI void evas_object_smart_callback_description_find(const Evas_Object *obj, const char *name, const Evas_Smart_Cb_Description **class_description, const Evas_Smart_Cb_Description **instance_description) EINA_ARG_NONNULL(1, 2);
/**
* Mark smart object as changed, dirty.
*
@ -10321,7 +10275,6 @@ EAPI void evas_object_smart_move_children_relative(Evas_Objec
Evas *evas;
};
/**
* Get the clipper object for the given clipped smart object.
*
@ -10607,14 +10560,17 @@ EAPI const Evas_Smart_Class *evas_object_smart_clipped_class_get (void) EINA
{
Evas_Object_Smart_Clipped_Data base;
const Evas_Object_Box_Api *api;
struct {
struct
{
double h, v;
} align;
struct {
struct
{
Evas_Coord h, v;
} pad;
Eina_List *children;
struct {
struct
{
Evas_Object_Box_Layout cb;
void *data;
void (*free_data)(void *data);
@ -11765,7 +11721,8 @@ EAPI Eina_List *evas_object_grid_children_get (const
*/
struct _Evas_Cserve_Image_Cache
{
struct {
struct
{
int mem_total;
int count;
} active, cached;
@ -11806,7 +11763,6 @@ EAPI Eina_List *evas_object_grid_children_get (const
int cache_item_timeout_check;
};
/**
* Retrieves if the system wants to share bitmaps using the server.
* @return @c EINA_TRUE if it wants, @c EINA_FALSE otherwise.
@ -11991,7 +11947,6 @@ EAPI void evas_color_argb_premul (int a, int *r, int *g,
**/
EAPI void evas_color_argb_unpremul(int a, int *r, int *g, int *b);
/**
* Pre-multiplies data by an alpha factor.
*
@ -12146,7 +12101,6 @@ EAPI const Evas_Modifier *evas_key_modifier_get (const Evas *e) EINA_WA
*/
EAPI const Evas_Lock *evas_key_lock_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
/**
* Checks the state of a given modifier key, at the time of the
* call. If the modifier is set, such as shift being pressed, this
@ -12167,7 +12121,6 @@ EAPI const Evas_Lock *evas_key_lock_get (const Evas *e) EINA_WA
*/
EAPI Eina_Bool evas_key_modifier_is_set(const Evas_Modifier *m, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2);
/**
* Checks the state of a given lock key, at the time of the call. If
* the lock is set, such as caps lock, this function returns @c
@ -12187,7 +12140,6 @@ EAPI Eina_Bool evas_key_modifier_is_set (const Evas_Modifier *m
*/
EAPI Eina_Bool evas_key_lock_is_set(const Evas_Lock *l, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2);
/**
* Adds the @p keyname key to the current list of modifier keys.
*
@ -12279,7 +12231,6 @@ EAPI void evas_key_lock_add (Evas *e, const char *k
*/
EAPI void evas_key_lock_del(Evas *e, const char *keyname) EINA_ARG_NONNULL(1, 2);
/**
* Enables or turns on programmatically the modifier key with name @p
* keyname.
@ -12345,7 +12296,6 @@ EAPI void evas_key_lock_on (Evas *e, const char *k
*/
EAPI void evas_key_lock_off(Evas *e, const char *keyname) EINA_ARG_NONNULL(1, 2);
/**
* Creates a bit mask from the @p keyname @b modifier key. Values
* returned from different calls to it may be ORed together,
@ -12371,7 +12321,6 @@ EAPI void evas_key_lock_off (Evas *e, const char *k
*/
EAPI Evas_Modifier_Mask evas_key_modifier_mask_get(const Evas *e, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2);
/**
* Requests @p keyname key events be directed to @p obj.
*