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
* 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)
/**
* Creates a new textblock style.
* @return The new textblock style.
+ * @ingroup Evas_Object_Textblock
*/
EAPI Evas_Textblock_Style *
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)
* @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)
* 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)
* @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)
* 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)
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)
{
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)
{
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)
{
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)
{
* @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)
* @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)
}
}
-/*
+/**
* 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)
}
/* 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)
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)
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)
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)
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)
}
}
-/*
+/**
* 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)
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)
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)
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)
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)
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)
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)
}
}
-/*
+/**
* 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)
}
}
-/*
+/**
* 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)
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)
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)
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)
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)
/* 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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
return txt;
}
-/*
+/**
* to be documented.
* @param cur to be documented.
* @param cx to be documented.
* @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)
return ln->line_no;
}
-/*
+/**
* to be documented.
* @param cur to be documented.
* @param cx to be documented.
* @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)
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)
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)
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)
}
/* general controls */
-/*
+/**
* to be documented.
* @param obj to be documented.
* @param line to be documented.
* @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)
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)
/* 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)
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)
if (h) *h = o->native.h;
}
-/*
+/**
* to be documented.
* @param obj to be documented.
* @param l to be documented.
* @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)