diff options
| author | Bryce Harrington <bryce@osg.samsung.com> | 2017-09-19 16:55:47 +0900 |
|---|---|---|
| committer | Jean-Philippe Andre <jp.andre@samsung.com> | 2017-09-19 16:55:47 +0900 |
| commit | d94a4d8d892f4b6ba1cbd0ecbe4dc27175142a82 (patch) | |
| tree | f0970a1fcb199c27b7891407d938eea66a0be9f1 | |
| parent | c955625c44f3e31034a3d9d17745c5c82053c752 (diff) | |
| download | efl-d94a4d8d892f4b6ba1cbd0ecbe4dc27175142a82.tar.gz | |
evas: Document Textgrid objects API
Subscribers: cedric, jpeg
Differential Revision: https://phab.enlightenment.org/D5179
| -rw-r--r-- | src/lib/evas/Evas_Common.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h index 8ee99427f3..72ec2b9dfc 100644 --- a/src/lib/evas/Evas_Common.h +++ b/src/lib/evas/Evas_Common.h @@ -1790,6 +1790,11 @@ EAPI Eina_Bool evas_object_image_extension_can_load_fast_get /** * @defgroup Evas_Object_Textgrid Textgrid Object Functions * + * Textgrid objects manage chunks of text as a 2D grid of cells, each of + * which contains a single unicode character with color and style + * formatting information. The object's text can be interacted with + * character-by-character or by row. + * * @todo put here some usage examples * * @since 1.7 @@ -1802,7 +1807,9 @@ EAPI Eina_Bool evas_object_image_extension_can_load_fast_get /** * @struct _Evas_Textgrid_Cell * - * The values that describes each cell. + * A cell contains a single unicode character, with associated formatting + * data including style, color, and color palette. Double-wide characters + * are flagged to permit visually merging the cell to the right. * * @since 1.7 */ |