* Add a Texblock doxy category and put all the textblock_* functions to apper under it

SVN revision: 37381
This commit is contained in:
Davide Andreoli 2008-11-01 19:40:07 +00:00
parent 478e8c1e4c
commit 92dfd49fdb
1 changed files with 122 additions and 43 deletions

View File

@ -197,7 +197,13 @@ static const Evas_Object_Func object_func =
return (x); \
MAGIC_CHECK_END();
/**
* @defgroup Evas_Object_Textblock Textblock Object Functions
*
* Functions used to create and manipulate textblock objects.
*
* Note: put here some usage examples
*/
/* styles */
static void
@ -2311,7 +2317,7 @@ _find_layout_line_num(const Evas_Object *obj, int line)
* Adds a textblock to the given evas.
* @param e The given evas.
* @return The new textblock object.
* @todo Find a documentation group to put this under.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Object *
evas_object_textblock_add(Evas *e)
@ -2330,6 +2336,7 @@ evas_object_textblock_add(Evas *e)
/**
* Creates a new textblock style.
* @return The new textblock style.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Textblock_Style *
evas_textblock_style_new(void)
@ -2344,6 +2351,7 @@ evas_textblock_style_new(void)
* Destroys a textblock style.
* @param The textblock style to free.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_style_free(Evas_Textblock_Style *ts)
@ -2363,6 +2371,7 @@ evas_textblock_style_free(Evas_Textblock_Style *ts)
* @param ts to be documented.
* @param text to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_style_set(Evas_Textblock_Style *ts, const char *text)
@ -2495,6 +2504,7 @@ evas_textblock_style_set(Evas_Textblock_Style *ts, const char *text)
* to be documented.
* @param ts to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_textblock_style_get(const Evas_Textblock_Style *ts)
@ -2509,6 +2519,7 @@ evas_textblock_style_get(const Evas_Textblock_Style *ts)
* @param obj to be documented.
* @param ts to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_style_set(Evas_Object *obj, Evas_Textblock_Style *ts)
@ -2548,6 +2559,7 @@ evas_object_textblock_style_set(Evas_Object *obj, Evas_Textblock_Style *ts)
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const Evas_Textblock_Style *
evas_object_textblock_style_get(const Evas_Object *obj)
@ -2556,6 +2568,12 @@ evas_object_textblock_style_get(const Evas_Object *obj)
return o->style;
}
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_replace_char_set(Evas_Object *obj, const char *ch)
{
@ -2574,6 +2592,12 @@ evas_object_textblock_replace_char_set(Evas_Object *obj, const char *ch)
evas_object_change(obj);
}
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_object_textblock_replace_char_get(Evas_Object *obj)
{
@ -2661,6 +2685,12 @@ _escaped_char_get(const char *s, const char *s_end)
return NULL;
}
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_textblock_escape_string_get(const char *escape)
{
@ -2668,6 +2698,12 @@ evas_textblock_escape_string_get(const char *escape)
return _escaped_char_get(escape, escape + strlen(escape));
}
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_textblock_string_escape_get(const char *string, int *len_ret)
{
@ -2702,6 +2738,7 @@ _prepend_escaped_char(Evas_Textblock_Cursor *cur, const char *s,
* @param ts to be documented.
* @param text to be documented.
* @return Return no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_text_markup_set(Evas_Object *obj, const char *text)
@ -2844,6 +2881,7 @@ evas_object_textblock_text_markup_set(Evas_Object *obj, const char *text)
* @param ts to be documented.
* @param text to be documented.
* @return Return no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_text_markup_prepend(Evas_Textblock_Cursor *cur, const char *text)
@ -2968,10 +3006,11 @@ evas_object_textblock_text_markup_prepend(Evas_Textblock_Cursor *cur, const char
}
}
/*
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_object_textblock_text_markup_get(const Evas_Object *obj)
@ -3042,10 +3081,11 @@ evas_object_textblock_text_markup_get(const Evas_Object *obj)
}
/* cursors */
/*
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const Evas_Textblock_Cursor *
evas_object_textblock_cursor_get(const Evas_Object *obj)
@ -3054,10 +3094,11 @@ evas_object_textblock_cursor_get(const Evas_Object *obj)
return o->cursor;
}
/*
/**
* to be documented.
* @param obj to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Textblock_Cursor *
evas_object_textblock_cursor_new(Evas_Object *obj)
@ -3073,10 +3114,11 @@ evas_object_textblock_cursor_new(Evas_Object *obj)
return cur;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_free(Evas_Textblock_Cursor *cur)
@ -3090,10 +3132,11 @@ evas_textblock_cursor_free(Evas_Textblock_Cursor *cur)
free(cur);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_node_first(Evas_Textblock_Cursor *cur)
@ -3106,10 +3149,11 @@ evas_textblock_cursor_node_first(Evas_Textblock_Cursor *cur)
cur->pos = 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_node_last(Evas_Textblock_Cursor *cur)
@ -3131,10 +3175,11 @@ evas_textblock_cursor_node_last(Evas_Textblock_Cursor *cur)
}
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_node_next(Evas_Textblock_Cursor *cur)
@ -3153,10 +3198,11 @@ evas_textblock_cursor_node_next(Evas_Textblock_Cursor *cur)
return 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_node_prev(Evas_Textblock_Cursor *cur)
@ -3175,10 +3221,11 @@ evas_textblock_cursor_node_prev(Evas_Textblock_Cursor *cur)
return 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_char_next(Evas_Textblock_Cursor *cur)
@ -3200,10 +3247,11 @@ evas_textblock_cursor_char_next(Evas_Textblock_Cursor *cur)
return 1;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_char_prev(Evas_Textblock_Cursor *cur)
@ -3224,10 +3272,11 @@ evas_textblock_cursor_char_prev(Evas_Textblock_Cursor *cur)
return 1;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_char_first(Evas_Textblock_Cursor *cur)
@ -3236,10 +3285,11 @@ evas_textblock_cursor_char_first(Evas_Textblock_Cursor *cur)
cur->pos = 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_char_last(Evas_Textblock_Cursor *cur)
@ -3258,10 +3308,11 @@ evas_textblock_cursor_char_last(Evas_Textblock_Cursor *cur)
cur->pos = index;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_line_first(Evas_Textblock_Cursor *cur)
@ -3299,10 +3350,11 @@ evas_textblock_cursor_line_first(Evas_Textblock_Cursor *cur)
}
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_line_last(Evas_Textblock_Cursor *cur)
@ -3350,10 +3402,11 @@ evas_textblock_cursor_line_last(Evas_Textblock_Cursor *cur)
}
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI int
evas_textblock_cursor_pos_get(const Evas_Textblock_Cursor *cur)
@ -3362,11 +3415,12 @@ evas_textblock_cursor_pos_get(const Evas_Textblock_Cursor *cur)
return cur->pos;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param int to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int pos)
@ -3379,11 +3433,12 @@ evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int pos)
cur->pos = pos;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param int to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_line_set(Evas_Textblock_Cursor *cur, int line)
@ -3419,11 +3474,12 @@ evas_textblock_cursor_line_set(Evas_Textblock_Cursor *cur, int line)
return 1;
}
/*
/**
* to be documented.
* @param cur1 to be documented.
* @param cur2 to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI int
evas_textblock_cursor_compare(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2)
@ -3453,11 +3509,12 @@ evas_textblock_cursor_compare(const Evas_Textblock_Cursor *cur1, const Evas_Text
return 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param cur_dest to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_copy(const Evas_Textblock_Cursor *cur, Evas_Textblock_Cursor *cur_dest)
@ -3471,11 +3528,12 @@ evas_textblock_cursor_copy(const Evas_Textblock_Cursor *cur, Evas_Textblock_Curs
/* text controls */
/*
/**
* to be documented.
* @param cur to be documented.
* @param text to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_text_append(Evas_Textblock_Cursor *cur, const char *text)
@ -3548,11 +3606,12 @@ evas_textblock_cursor_text_append(Evas_Textblock_Cursor *cur, const char *text)
evas_object_change(cur->obj);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param text to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_text_prepend(Evas_Textblock_Cursor *cur, const char *text)
@ -3623,11 +3682,12 @@ evas_textblock_cursor_text_prepend(Evas_Textblock_Cursor *cur, const char *text)
evas_object_change(cur->obj);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param format to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_format_append(Evas_Textblock_Cursor *cur, const char *format)
@ -3701,11 +3761,12 @@ evas_textblock_cursor_format_append(Evas_Textblock_Cursor *cur, const char *form
evas_object_change(cur->obj);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param format to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_format_prepend(Evas_Textblock_Cursor *cur, const char *format)
@ -3785,10 +3846,11 @@ evas_textblock_cursor_format_prepend(Evas_Textblock_Cursor *cur, const char *for
evas_object_change(cur->obj);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_node_delete(Evas_Textblock_Cursor *cur)
@ -3857,10 +3919,11 @@ evas_textblock_cursor_node_delete(Evas_Textblock_Cursor *cur)
evas_object_change(cur->obj);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_char_delete(Evas_Textblock_Cursor *cur)
@ -3938,11 +4001,12 @@ evas_textblock_cursor_char_delete(Evas_Textblock_Cursor *cur)
evas_object_change(cur->obj);
}
/*
/**
* to be documented.
* @param cur1 to be documented.
* @param cur2 to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_textblock_cursor_range_delete(Evas_Textblock_Cursor *cur1, Evas_Textblock_Cursor *cur2)
@ -4209,10 +4273,11 @@ evas_textblock_cursor_range_delete(Evas_Textblock_Cursor *cur1, Evas_Textblock_C
evas_object_change(cur1->obj);
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_textblock_cursor_node_text_get(const Evas_Textblock_Cursor *cur)
@ -4226,10 +4291,11 @@ evas_textblock_cursor_node_text_get(const Evas_Textblock_Cursor *cur)
return NULL;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI int
evas_textblock_cursor_node_text_length_get(const Evas_Textblock_Cursor *cur)
@ -4243,10 +4309,11 @@ evas_textblock_cursor_node_text_length_get(const Evas_Textblock_Cursor *cur)
return 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI const char *
evas_textblock_cursor_node_format_get(const Evas_Textblock_Cursor *cur)
@ -4260,10 +4327,11 @@ evas_textblock_cursor_node_format_get(const Evas_Textblock_Cursor *cur)
return NULL;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_node_format_is_visible_get(const Evas_Textblock_Cursor *cur)
@ -4308,12 +4376,13 @@ evas_textblock_cursor_node_format_is_visible_get(const Evas_Textblock_Cursor *cu
return 0;
}
/*
/**
* to be documented.
* @param cur1 to be documented.
* @param cur2 to be documented.
* @param format to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI char *
evas_textblock_cursor_range_text_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2, Evas_Textblock_Text_Type format)
@ -4461,7 +4530,7 @@ evas_textblock_cursor_range_text_get(const Evas_Textblock_Cursor *cur1, const Ev
return txt;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param cx to be documented.
@ -4469,6 +4538,7 @@ evas_textblock_cursor_range_text_get(const Evas_Textblock_Cursor *cur1, const Ev
* @param cw to be documented.
* @param ch to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI int
evas_textblock_cursor_char_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
@ -4544,7 +4614,7 @@ evas_textblock_cursor_char_geometry_get(const Evas_Textblock_Cursor *cur, Evas_C
return ln->line_no;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param cx to be documented.
@ -4552,6 +4622,7 @@ evas_textblock_cursor_char_geometry_get(const Evas_Textblock_Cursor *cur, Evas_C
* @param cw to be documented.
* @param ch to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI int
evas_textblock_cursor_line_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
@ -4582,12 +4653,13 @@ evas_textblock_cursor_line_geometry_get(const Evas_Textblock_Cursor *cur, Evas_C
return ln->line_no;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param x to be documented.
* @param y to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_textblock_cursor_char_coord_set(Evas_Textblock_Cursor *cur, Evas_Coord x, Evas_Coord y)
@ -4655,11 +4727,12 @@ evas_textblock_cursor_char_coord_set(Evas_Textblock_Cursor *cur, Evas_Coord x, E
return 0;
}
/*
/**
* to be documented.
* @param cur to be documented.
* @param y to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI int
evas_textblock_cursor_line_coord_set(Evas_Textblock_Cursor *cur, Evas_Coord y)
@ -4683,11 +4756,12 @@ evas_textblock_cursor_line_coord_set(Evas_Textblock_Cursor *cur, Evas_Coord y)
return -1;
}
/*
/**
* to be documented.
* @param cur1 to be documented.
* @param cur2 to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Eina_List *
evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2)
@ -4784,7 +4858,7 @@ evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, cons
}
/* general controls */
/*
/**
* to be documented.
* @param obj to be documented.
* @param line to be documented.
@ -4793,6 +4867,7 @@ evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, cons
* @param cw to be documented.
* @param ch to be documented.
* @return to be documented.
* @ingroup Evas_Object_Textblock
*/
EAPI Evas_Bool
evas_object_textblock_line_number_geometry_get(const Evas_Object *obj, int line, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
@ -4809,10 +4884,11 @@ evas_object_textblock_line_number_geometry_get(const Evas_Object *obj, int line,
return 1;
}
/*
/**
* to be documented.
* @param obj to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_clear(Evas_Object *obj)
@ -4846,12 +4922,13 @@ evas_object_textblock_clear(Evas_Object *obj)
/* FIXME: adjust cursors that are affected by the change */
}
/*
/**
* to be documented.
* @param obj to be documented.
* @param w to be documented.
* @param h to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_size_formatted_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
@ -4862,12 +4939,13 @@ evas_object_textblock_size_formatted_get(const Evas_Object *obj, Evas_Coord *w,
if (h) *h = o->formatted.h;
}
/*
/**
* to be documented.
* @param obj to be documented.
* @param w to be documented.
* @param h to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_size_native_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
@ -4885,7 +4963,7 @@ evas_object_textblock_size_native_get(const Evas_Object *obj, Evas_Coord *w, Eva
if (h) *h = o->native.h;
}
/*
/**
* to be documented.
* @param obj to be documented.
* @param l to be documented.
@ -4893,6 +4971,7 @@ evas_object_textblock_size_native_get(const Evas_Object *obj, Evas_Coord *w, Eva
* @param t to be documented.
* @param b to be documented.
* @return Returns no value.
* @ingroup Evas_Object_Textblock
*/
EAPI void
evas_object_textblock_style_insets_get(const Evas_Object *obj, Evas_Coord *l, Evas_Coord *r, Evas_Coord *t, Evas_Coord *b)