summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-01-09 18:11:59 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2020-01-09 18:17:33 +0100
commit93c7e7dc8f2ad5efa7617e25b8f51346e67778ce (patch)
treec652682936230d3375d1349da9876d682b212456
parent83a291604399351a4c92da539eb6754c083b9360 (diff)
docs: Improvements to Text API documentation
Ref T7855 Ref T7934 Ref T7935 Ref T7936 Ref T7937 Ref T7938 Ref T7941 Ref T7942 Ref T7943 Ref T7944 Ref T7945
-rw-r--r--src/lib/efl/interfaces/efl_text_font_properties.eo82
-rw-r--r--src/lib/efl/interfaces/efl_text_format.eo39
-rw-r--r--src/lib/efl/interfaces/efl_text_style.eo107
-rw-r--r--src/lib/elementary/efl_ui_textbox.eo21
-rw-r--r--src/lib/evas/canvas/efl_canvas_textblock.eo8
5 files changed, 140 insertions, 117 deletions
diff --git a/src/lib/efl/interfaces/efl_text_font_properties.eo b/src/lib/efl/interfaces/efl_text_font_properties.eo
index 160b182803..71d8e3d5d9 100644
--- a/src/lib/efl/interfaces/efl_text_font_properties.eo
+++ b/src/lib/efl/interfaces/efl_text_font_properties.eo
@@ -1,50 +1,54 @@
1import efl_gfx_types; 1import efl_gfx_types;
2enum @beta Efl.Text_Font_Weight { 2enum @beta Efl.Text_Font_Weight {
3 [[Type of font weight.]] 3 [[The weight of a particular font is the thickness of the character outlines relative to their height.
4 normal, [[Normal font weight.]] 4 The given numerical values follow the TrueType scale (from 100 to 900) and are approximate.
5 thin, [[Thin font weight.]] 5 It is up to each font to provide all of them.]]
6 ultralight, [[Ultralight font weight.]] 6 normal, [[Normal font weight (400).]]
7 extralight, [[Extralight font weight.]] 7 thin, [[Thin font weight (100).]]
8 light, [[Light font weight.]] 8 ultralight, [[Ultralight font weight (200).]]
9 book, [[Book font weight.]] 9 extralight, [[Extralight font weight (200).]]
10 medium, [[Medium font weight.]] 10 light, [[Light font weight (300).]]
11 semibold, [[Semibold font weight.]] 11 book, [[Book font weight (350).]]
12 bold, [[Bold font weight.]] 12 medium, [[Medium font weight (500).]]
13 ultrabold, [[Ultrabold font weight.]] 13 semibold, [[Semibold font weight (600).]]
14 extrabold, [[Extrabold font weight.]] 14 bold, [[Bold font weight (700).]]
15 black, [[Black font weight.]] 15 ultrabold, [[Ultrabold font weight (800).]]
16 extrablack, [[Extrablack font weight.]] 16 extrabold, [[Extrabold font weight (800).]]
17 black, [[Black font weight (900).]]
18 extrablack, [[Extrablack font weight (950).]]
17} 19}
18 20
19enum @beta Efl.Text_Font_Width { 21enum @beta Efl.Text_Font_Width {
20 [[Type of font width.]] 22 [[Font width relative to its height.
21 normal, [[Normal font width.]] 23 It is up to each font to provide all these widths.]]
24 normal, [[Normal font width.]]
22 ultracondensed, [[Ultracondensed font width.]] 25 ultracondensed, [[Ultracondensed font width.]]
23 extracondensed, [[Extracondensed font width.]] 26 extracondensed, [[Extracondensed font width.]]
24 condensed, [[Condensed font width.]] 27 condensed, [[Condensed font width.]]
25 semicondensed, [[Semicondensed font width.]] 28 semicondensed, [[Semicondensed font width.]]
26 semiexpanded, [[Semiexpanded font width.]] 29 semiexpanded, [[Semiexpanded font width.]]
27 expanded, [[Expanded font width.]] 30 expanded, [[Expanded font width.]]
28 extraexpanded, [[Extraexpanded font width.]] 31 extraexpanded, [[Extraexpanded font width.]]
29 ultraexpanded, [[Ultraexpanded font width.]] 32 ultraexpanded, [[Ultraexpanded font width.]]
30} 33}
31 34
32enum @beta Efl.Text_Font_Slant { 35enum @beta Efl.Text_Font_Slant {
33 [[Type of font slant.]] 36 [[Type of font slant.]]
34 normal, [[Normal font slant.]] 37 normal, [[Normal font slant: Sets the text to the normal font (non-italicized).]]
35 oblique, [[Oblique font slant.]] 38 oblique, [[Oblique font slant: Sets the text to use a simulated version of an italic font,
36 italic, [[Italic font slant.]] 39 created by algorithmically slanting the normal version.]]
40 italic, [[Italic font slant: Sets the text to use the italic version of the font if available.
41 If not available, it will simulate italics with oblique instead.]]
37} 42}
38 43
39enum @beta Efl.Text_Font_Bitmap_Scalable { 44enum @beta Efl.Text_Font_Bitmap_Scalable {
40 [[Scalable of bitmap fonts. 45 [[When are bitmap fonts allowed to be scaled.]]
41 ]] 46 none = 0, [[Disable scaling for bitmap fonts.]]
42 none = 0, [[Disable scalable feature for bitmap fonts.]] 47 color = (1 << 0), [[Enable scaling for color bitmap fonts.]]
43 color = (1 << 0), [[Enable scalable feature for color bitmap fonts.]]
44} 48}
45 49
46interface @beta Efl.Text_Font_Properties { 50interface @beta Efl.Text_Font_Properties {
47 [[Font settings for text. 51 [[Properties related to font handling.
48 ]] 52 ]]
49 c_prefix: efl_text; 53 c_prefix: efl_text;
50 methods { 54 methods {
@@ -72,9 +76,9 @@ interface @beta Efl.Text_Font_Properties {
72 } 76 }
73 77
74 @property font_size { 78 @property font_size {
75 [[The font size for a given text object. 79 [[The font size to use, in points.
76 80
77 This property controls the font size of a text object. 81 If the specified @.font_family does not provide this particular size, it will be scaled.
78 ]] 82 ]]
79 set {} 83 set {}
80 get {} 84 get {}
@@ -112,7 +116,7 @@ interface @beta Efl.Text_Font_Properties {
112 } 116 }
113 117
114 @property font_weight { 118 @property font_weight {
115 [[Type of weight of the displayed font 119 [[Type of weight (e.g. bold or normal) of the displayed font
116 120
117 Default is @Efl.Text_Font_Weight.normal. 121 Default is @Efl.Text_Font_Weight.normal.
118 ]] 122 ]]
@@ -122,7 +126,7 @@ interface @beta Efl.Text_Font_Properties {
122 } 126 }
123 127
124 @property font_slant { 128 @property font_slant {
125 [[Type of slant of the displayed font. 129 [[Type of slant (e.g. italic or normal) of the displayed font.
126 130
127 Default is @Efl.Text_Font_Slant.normal. 131 Default is @Efl.Text_Font_Slant.normal.
128 ]] 132 ]]
@@ -132,7 +136,7 @@ interface @beta Efl.Text_Font_Properties {
132 } 136 }
133 137
134 @property font_width { 138 @property font_width {
135 [[Type of width of the displayed font. 139 [[Type of width (e.g. condensed, expanded or normal) of the displayed font.
136 140
137 Default is @Efl.Text_Font_Width.normal. 141 Default is @Efl.Text_Font_Width.normal.
138 ]] 142 ]]
@@ -155,14 +159,14 @@ interface @beta Efl.Text_Font_Properties {
155 } 159 }
156 160
157 @property font_bitmap_scalable { 161 @property font_bitmap_scalable {
158 [[The bitmap fonts have fixed size glyphs for several available sizes. 162 [[Bitmap fonts have fixed size glyphs for several available sizes.
159 Basically, it is not scalable. But, it needs to be scalable for some use cases. 163 Other sizes need to be algorithmically scaled, resulting in blurry glyphs.
160 (e.g. colorful emoji fonts) 164 This property controls whether scaling of non-provided sizes is allowed.
161 165
162 Default is @Efl.Text_Font_Bitmap_Scalable.none. 166 Default is @Efl.Text_Font_Bitmap_Scalable.none.
163 ]] 167 ]]
164 values { 168 values {
165 scalable: Efl.Text_Font_Bitmap_Scalable; [[Scalable.]] 169 scalable: Efl.Text_Font_Bitmap_Scalable; [[When should bitmap fonts be scaled.]]
166 } 170 }
167 } 171 }
168 } 172 }
diff --git a/src/lib/efl/interfaces/efl_text_format.eo b/src/lib/efl/interfaces/efl_text_format.eo
index 96b724c84b..14d80a107c 100644
--- a/src/lib/efl/interfaces/efl_text_format.eo
+++ b/src/lib/efl/interfaces/efl_text_format.eo
@@ -1,5 +1,5 @@
1enum @beta Efl.Text_Format_Wrap { 1enum @beta Efl.Text_Format_Wrap {
2 [[Wrapping policy of the text.]] 2 [[Wrapping policy for the text.]]
3 none, [[No wrapping.]] 3 none, [[No wrapping.]]
4 char, [[Wrap at character boundaries.]] 4 char, [[Wrap at character boundaries.]]
5 word, [[Wrap at word boundaries.]] 5 word, [[Wrap at word boundaries.]]
@@ -9,7 +9,7 @@ enum @beta Efl.Text_Format_Wrap {
9} 9}
10 10
11enum @beta Efl.Text_Format_Horizontal_Alignment_Auto_Type { 11enum @beta Efl.Text_Format_Horizontal_Alignment_Auto_Type {
12 [[Auto-horizontal alignment setting for the text (Left-To-Right or Right-To-Left).]] 12 [[Automatic horizontal alignment setting for the text (Left-To-Right or Right-To-Left).]]
13 none, [[No auto-alignment rule: Horizontal Alignment is decided by @Efl.Text_Format.text_horizontal_align]] 13 none, [[No auto-alignment rule: Horizontal Alignment is decided by @Efl.Text_Format.text_horizontal_align]]
14 auto, [[Respects LTR/RTL (bidirectional) characters found inside the text content.]] 14 auto, [[Respects LTR/RTL (bidirectional) characters found inside the text content.]]
15 locale, [[Respects the system's language settings.]] 15 locale, [[Respects the system's language settings.]]
@@ -33,36 +33,42 @@ interface @beta Efl.Text_Format {
33 ]] 33 ]]
34 values 34 values
35 { 35 {
36 value: double; [[Ellipsis value.]] 36 value: double; [[Position of the ellipsis inside the text, from $[0.0] to $[1.0].]]
37 } 37 }
38 } 38 }
39 39
40 @property wrap { 40 @property wrap {
41 [[Wrapping policy of the text. Requires @.multiline to be $true.]] 41 [[Wrapping policy for the text.
42
43 When text does not fit the widget in a single line, it can be automatically wrapped at
44 character or word boundaries, for example.
45
46 Requires @.multiline to be $true.
47 ]]
42 values { 48 values {
43 wrap: Efl.Text_Format_Wrap; [[Wrap mode.]] 49 wrap: Efl.Text_Format_Wrap; [[Wrapping policy.]]
44 } 50 }
45 } 51 }
46 52
47 @property multiline { 53 @property multiline {
48 [[Enables text to span multiple lines. 54 [[Enables text to span multiple lines.
49 55
50 When $false, new-line characters are ignored and no text wrapping occurs. 56 When $false, new-line characters are ignored and no text wrapping occurs.
51 ]] 57 ]]
52 values { 58 values {
53 enabled: bool; [[$true if multiline is enabled.]] 59 enabled: bool; [[$true if multiple lines should be rendered.]]
54 } 60 }
55 } 61 }
56 62
57 @property text_horizontal_align_auto_type { 63 @property text_horizontal_align_auto_type {
58 [[Specifies when the text's horizontal alignment should be set automatically.]] 64 [[Specifies when the text's horizontal alignment should be set automatically.]]
59 values { 65 values {
60 value: Efl.Text_Format_Horizontal_Alignment_Auto_Type; [[Alignment type.]] 66 value: Efl.Text_Format_Horizontal_Alignment_Auto_Type; [[Automatic horizontal alignment type.]]
61 } 67 }
62 } 68 }
63 69
64 @property text_horizontal_align { 70 @property text_horizontal_align {
65 [[Horizontal alignment of text. $[0.0] means "left" 71 [[Manual horizontal alignment of text. $[0.0] means "left"
66 and $[1.0] means "right". 72 and $[1.0] means "right".
67 Setting this value also sets @.text_horizontal_align_auto_type to 73 Setting this value also sets @.text_horizontal_align_auto_type to
68 @Efl.Text_Format_Horizontal_Alignment_Auto_Type.none. 74 @Efl.Text_Format_Horizontal_Alignment_Auto_Type.none.
@@ -75,7 +81,7 @@ interface @beta Efl.Text_Format {
75 } 81 }
76 82
77 @property text_vertical_align { 83 @property text_vertical_align {
78 [[Vertical alignment of text.$[0.0] means "top" 84 [[Vertical alignment of text. $[0.0] means "top"
79 and $[1.0] means "bottom"]] 85 and $[1.0] means "bottom"]]
80 values { 86 values {
81 value: double; [[Alignment value between $[0.0] and $[1.0].]] 87 value: double; [[Alignment value between $[0.0] and $[1.0].]]
@@ -105,16 +111,16 @@ interface @beta Efl.Text_Format {
105 } 111 }
106 112
107 @property tab_stops { 113 @property tab_stops {
108 [[Size of the tab character.]] 114 [[Size (in pixels) of the tab character.]]
109 values 115 values
110 { 116 {
111 value: int; [[Size in pixels.]] 117 value: int; [[Size in pixels, greater than 1.]]
112 } 118 }
113 } 119 }
114 120
115 @property password { 121 @property password {
116 [[Enabling this causes all characters to be replaced by @.replacement_char. 122 [[Enabling this causes all characters to be replaced by @.replacement_char.
117 123
118 This is useful for password input boxes. 124 This is useful for password input boxes.
119 ]] 125 ]]
120 values 126 values
@@ -124,13 +130,12 @@ interface @beta Efl.Text_Format {
124 } 130 }
125 131
126 @property replacement_char { 132 @property replacement_char {
127 [[The character used to replace characters that can't be displayed 133 [[The character used to replace characters that can't be displayed.
128 134
129 Currently only used to replace characters if @.password 135 Only used to replace characters if @.password is enabled.
130 is enabled.
131 ]] 136 ]]
132 values { 137 values {
133 repch: string; [[Replacement character]] 138 repch: string; [[Replacement character.]]
134 } 139 }
135 } 140 }
136 } 141 }
diff --git a/src/lib/efl/interfaces/efl_text_style.eo b/src/lib/efl/interfaces/efl_text_style.eo
index a975ebdc96..bb168fd5dd 100644
--- a/src/lib/efl/interfaces/efl_text_style.eo
+++ b/src/lib/efl/interfaces/efl_text_style.eo
@@ -1,70 +1,80 @@
1enum @beta Efl.Text_Style_Background_Type 1enum @beta Efl.Text_Style_Background_Type
2{ 2{
3 [[Whether to add a background colored rectangle (background) to each line of text or not.]] 3 [[Type of background to use behind each line of text.]]
4 none = 0, [[Do not use background.]] 4 none = 0, [[Do not use background.]]
5 solid_color, [[Use solid color background.]] 5 solid_color, [[Use a solid-color rectangle as background.
6 6 Requires @Efl.Text_Style.text_background_color.]]
7} 7}
8 8
9enum @beta Efl.Text_Style_Strikethrough_Type 9enum @beta Efl.Text_Style_Strikethrough_Type
10{ 10{
11 [[Whether to add a strike-through decoration to the displayed text or not.]] 11 [[Whether to add a strike-through decoration to the displayed text or not.]]
12 none = 0, [[Do not use strike-through.]] 12 none = 0, [[Do not use strike-through.]]
13 single, [[Strikethrough with a single line.]] 13 single, [[Strike-through with a single line.
14 14 Requires @Efl.Text_Style.text_strikethrough_color.]]
15} 15}
16 16
17enum @beta Efl.Text_Style_Effect_Type 17enum @beta Efl.Text_Style_Effect_Type
18{ 18{
19 [[Effect to apply to the displayed text.]] 19 [[Effect to apply to the displayed text.]]
20 none = 0, [[No effect.]] 20 none = 0, [[No effect.]]
21 21 shadow, [[Shadow effect.
22 // colored with shadow_color 22 Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
23 shadow, [[Shadow effect.]] 23 far_shadow, [[Far shadow effect.
24 far_shadow, [[Far shadow effect.]] 24 Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
25 soft_shadow, [[Soft shadow effect.]] 25 soft_shadow, [[Soft shadow effect.
26 far_soft_shadow, [[Far and soft shadow effect.]] 26 Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
27 // colored with glow_color 27 far_soft_shadow, [[Far and soft shadow effect.
28 glow, [[Glow effect.]] 28 Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
29 // colored with outline_color 29 glow, [[Glow effect.
30 outline, [[Outline effect.]] 30 Uses @Efl.Text_Style.text_glow_color and @Efl.Text_Style.text_secondary_glow_color.]]
31 soft_outline, [[Soft outline effect.]] 31 outline, [[Outline effect.
32 // colored with outline_color + shadow_color 32 Uses @Efl.Text_Style.text_outline_color.]]
33 outline_shadow, [[Outline + shadow effect.]] 33 soft_outline, [[Soft outline effect.
34 outline_soft_shadow, [[Outline + soft shadow effect.]] 34 Uses @Efl.Text_Style.text_outline_color.]]
35 outline_shadow, [[Outline + shadow effect.
36 Uses @Efl.Text_Style.text_shadow_color, @Efl.Text_Style.text_shadow_direction and
37 @Efl.Text_Style.text_outline_color.]]
38 outline_soft_shadow, [[Outline + soft shadow effect.
39 Uses @Efl.Text_Style.text_shadow_color, @Efl.Text_Style.text_shadow_direction and
40 @Efl.Text_Style.text_outline_color.]]
35} 41}
36 42
37enum @beta Efl.Text_Style_Shadow_Direction 43enum @beta Efl.Text_Style_Shadow_Direction
38{ 44{
39 [[Direction of the shadow.]] 45 [[Direction of the shadow effect.]]
40 bottom_right = 0, [[Shadow towards bottom right.]] 46 bottom_right = 0, [[Shadow towards bottom right.]]
41 bottom, [[Shadow towards bottom.]] 47 bottom, [[Shadow towards bottom.]]
42 bottom_left, [[Shadow towards bottom left.]] 48 bottom_left, [[Shadow towards bottom left.]]
43 left, [[Shadow towards left.]] 49 left, [[Shadow towards left.]]
44 top_left, [[Shadow towards top left.]] 50 top_left, [[Shadow towards top left.]]
45 top, [[Shadow towards top.]] 51 top, [[Shadow towards top.]]
46 top_right, [[Shadow towards top right.]] 52 top_right, [[Shadow towards top right.]]
47 right, [[Shadow towards right.]] 53 right, [[Shadow towards right.]]
48} 54}
49 55
50enum @beta Efl.Text_Style_Underline_Type 56enum @beta Efl.Text_Style_Underline_Type
51{ 57{
52 [[Type of underline of the displayed text.]] 58 [[Type of underline for the displayed text.]]
53 none = 0, [[Text without underline.]] 59 none = 0, [[Text without underline.]]
54 single, [[Underlined with a single line.]] 60 single, [[Underlined with a single line.
55 double, [[Underlined with a double line.]] 61 Requires @Efl.Text_Style.text_underline_color.]]
56 dashed, [[Underlined with a dashed line.]] 62 double, [[Underlined with a double line.
63 Requires @Efl.Text_Style.text_underline_color and @Efl.Text_Style.text_secondary_underline_color.]]
64 dashed, [[Underlined with a dashed line.
65 Requires @Efl.Text_Style.text_underline_dashed_color, @Efl.Text_Style.text_underline_dashed_width and
66 @Efl.Text_Style.text_underline_dashed_gap.]]
57} 67}
58 68
59interface @beta Efl.Text_Style { 69interface @beta Efl.Text_Style {
60 [[Decorations to add to the text. 70 [[Decorations to add to the text.
61 71
62 Decorations can be coloring, effects, underlines, strike-through etc. 72 Decorations include text color, glow, outline, underline, strike-through and shadows.
63 ]] 73 ]]
64 c_prefix: efl_text; 74 c_prefix: efl_text;
65 methods { 75 methods {
66 @property text_color { 76 @property text_color {
67 [[Color of text, excluding decorations like, shadow, outline or glow.]] 77 [[Color of text, excluding all other decorations. By default it is invisible.]]
68 values 78 values
69 { 79 {
70 r: ubyte; [[Red component.]] 80 r: ubyte; [[Red component.]]
@@ -75,7 +85,7 @@ interface @beta Efl.Text_Style {
75 } 85 }
76 86
77 @property text_background_type { 87 @property text_background_type {
78 [[Enables rendering of a background rectangle behind each line of text.]] 88 [[Type of background to use behind each line of text.]]
79 values 89 values
80 { 90 {
81 type: Efl.Text_Style_Background_Type; [[Background type.]] 91 type: Efl.Text_Style_Background_Type; [[Background type.]]
@@ -83,7 +93,7 @@ interface @beta Efl.Text_Style {
83 } 93 }
84 94
85 @property text_background_color { 95 @property text_background_color {
86 [[Color of the background rectangle (backing) behind each line of text.]] 96 [[Color of the background behind each line of text. By default it is invisible.]]
87 values 97 values
88 { 98 {
89 r: ubyte; [[Red component.]] 99 r: ubyte; [[Red component.]]
@@ -94,7 +104,7 @@ interface @beta Efl.Text_Style {
94 } 104 }
95 105
96 @property text_underline_type { 106 @property text_underline_type {
97 [[Underline style for the text.]] 107 [[Type of underline to use for the text.]]
98 values 108 values
99 { 109 {
100 type: Efl.Text_Style_Underline_Type; [[Underline type.]] 110 type: Efl.Text_Style_Underline_Type; [[Underline type.]]
@@ -103,7 +113,7 @@ interface @beta Efl.Text_Style {
103 113
104 @property text_underline_color 114 @property text_underline_color
105 { 115 {
106 [[Color of normal underline style.]] 116 [[Color of the primary underline. By default it is invisible.]]
107 values 117 values
108 { 118 {
109 r: ubyte; [[Red component.]] 119 r: ubyte; [[Red component.]]
@@ -126,7 +136,7 @@ interface @beta Efl.Text_Style {
126 @property text_underline_dashed_color 136 @property text_underline_dashed_color
127 { 137 {
128 [[Color of the dashed underline. Only valid when @.text_underline_type is 138 [[Color of the dashed underline. Only valid when @.text_underline_type is
129 @Efl.Text_Style_Underline_Type.dashed.]] 139 @Efl.Text_Style_Underline_Type.dashed. By default it is invisible.]]
130 values 140 values
131 { 141 {
132 r: ubyte; [[Red component.]] 142 r: ubyte; [[Red component.]]
@@ -159,7 +169,7 @@ interface @beta Efl.Text_Style {
159 @property text_secondary_underline_color 169 @property text_secondary_underline_color
160 { 170 {
161 [[Color of the secondary underline. Only valid when @.text_underline_type is 171 [[Color of the secondary underline. Only valid when @.text_underline_type is
162 @Efl.Text_Style_Underline_Type.double.]] 172 @Efl.Text_Style_Underline_Type.double. By default it is invisible.]]
163 values 173 values
164 { 174 {
165 r: ubyte; [[Red component.]] 175 r: ubyte; [[Red component.]]
@@ -179,7 +189,7 @@ interface @beta Efl.Text_Style {
179 189
180 @property text_strikethrough_color 190 @property text_strikethrough_color
181 { 191 {
182 [[Color of the line striking through the text.]] 192 [[Color of the line striking through the text. By default it is invisible.]]
183 values 193 values
184 { 194 {
185 r: ubyte; [[Red component.]] 195 r: ubyte; [[Red component.]]
@@ -198,7 +208,7 @@ interface @beta Efl.Text_Style {
198 } 208 }
199 @property text_outline_color 209 @property text_outline_color
200 { 210 {
201 [[Color of the text outline.]] 211 [[Color of the text outline. By default it is invisible.]]
202 values 212 values
203 { 213 {
204 r: ubyte; [[Red component.]] 214 r: ubyte; [[Red component.]]
@@ -210,7 +220,7 @@ interface @beta Efl.Text_Style {
210 220
211 @property text_shadow_direction 221 @property text_shadow_direction
212 { 222 {
213 [[Direction of shadow effect.]] 223 [[Direction of the shadow effect.]]
214 values 224 values
215 { 225 {
216 type: Efl.Text_Style_Shadow_Direction; [[Shadow direction.]] 226 type: Efl.Text_Style_Shadow_Direction; [[Shadow direction.]]
@@ -219,7 +229,7 @@ interface @beta Efl.Text_Style {
219 229
220 @property text_shadow_color 230 @property text_shadow_color
221 { 231 {
222 [[Color of the shadow.]] 232 [[Color of the text shadow. By default it is invisible.]]
223 values 233 values
224 { 234 {
225 r: ubyte; [[Red component.]] 235 r: ubyte; [[Red component.]]
@@ -231,7 +241,7 @@ interface @beta Efl.Text_Style {
231 241
232 @property text_glow_color 242 @property text_glow_color
233 { 243 {
234 [[Color of the glow decoration.]] 244 [[Color of the text glow. By default it is invisible.]]
235 values 245 values
236 { 246 {
237 r: ubyte; [[Red component.]] 247 r: ubyte; [[Red component.]]
@@ -245,7 +255,8 @@ interface @beta Efl.Text_Style {
245 { 255 {
246 [[Color of the secondary glow decoration. 256 [[Color of the secondary glow decoration.
247 This is the color of the inner glow (where it touches the text) which 257 This is the color of the inner glow (where it touches the text) which
248 gradually fades into @.text_glow_color as it reaches the edge. 258 gradually fades into @.text_glow_color as it reaches the outer edge.
259 By default it is invisible.
249 ]] 260 ]]
250 values 261 values
251 { 262 {
@@ -264,7 +275,7 @@ interface @beta Efl.Text_Style {
264 ]] 275 ]]
265 values 276 values
266 { 277 {
267 code: string; [[Filter code]] 278 code: string; [[Filter code.]]
268 } 279 }
269 } 280 }
270 } 281 }
diff --git a/src/lib/elementary/efl_ui_textbox.eo b/src/lib/elementary/efl_ui_textbox.eo
index aa3a5dd5be..ce4ca09b24 100644
--- a/src/lib/elementary/efl_ui_textbox.eo
+++ b/src/lib/elementary/efl_ui_textbox.eo
@@ -6,7 +6,7 @@ class @beta Efl.Ui.Textbox extends Efl.Ui.Layout_Base implements Efl.Input.Click
6 [[A flexible text widget which can be static (as a label) or editable by 6 [[A flexible text widget which can be static (as a label) or editable by
7 the user (as a text entry). It provides all sorts of editing facilities 7 the user (as a text entry). It provides all sorts of editing facilities
8 like automatic scrollbars, virtual keyboard, clipboard, configurable 8 like automatic scrollbars, virtual keyboard, clipboard, configurable
9 context menus or autocapitalization, for example.]] 9 context menus or auto-capitalization, for example.]]
10 methods { 10 methods {
11 @property scrollable { 11 @property scrollable {
12 [[Enable or disable scrolling in the widget. 12 [[Enable or disable scrolling in the widget.
@@ -16,17 +16,19 @@ class @beta Efl.Ui.Textbox extends Efl.Ui.Layout_Base implements Efl.Input.Click
16 set {} 16 set {}
17 get {} 17 get {}
18 values { 18 values {
19 scroll: bool; [[$true to enable scrolling. Default is $false.]] 19 scroll: bool(false); [[$true to enable scrolling.]]
20 } 20 }
21 } 21 }
22 @property context_menu_enabled { 22 @property context_menu_enabled {
23 [[This enables or disables the entry's contextual (longpress) menu.]] 23 [[This enables or disables the widget's contextual menu, typically
24 accessible through a long-press or a right-button click.
25 ]]
24 set { 26 set {
25 } 27 }
26 get { 28 get {
27 } 29 }
28 values { 30 values {
29 enabled: bool; [[If $true, the menu is enabled.]] 31 enabled: bool; [[$true to enable the contextual menu.]]
30 } 32 }
31 } 33 }
32 @property cnp_mode { 34 @property cnp_mode {
@@ -46,13 +48,14 @@ class @beta Efl.Ui.Textbox extends Efl.Ui.Layout_Base implements Efl.Input.Click
46 } 48 }
47 } 49 }
48 @property selection_handles_enabled { 50 @property selection_handles_enabled {
49 [[This enables or disables the entry's selection handlers.]] 51 [[This enables or disables the visual handles around selected text,
52 to allow simpler modification on touch screens.]]
50 set { 53 set {
51 } 54 }
52 get { 55 get {
53 } 56 }
54 values { 57 values {
55 enabled: bool; [[If $true, the selection handlers are enabled.]] 58 enabled: bool; [[$true to enable the selection handles.]]
56 } 59 }
57 } 60 }
58 61
@@ -69,13 +72,13 @@ class @beta Efl.Ui.Textbox extends Efl.Ui.Layout_Base implements Efl.Input.Click
69 return: Efl.Text.Cursor @move; [[Text cursor.]] 72 return: Efl.Text.Cursor @move; [[Text cursor.]]
70 } 73 }
71 selection_copy { 74 selection_copy {
72 [[This executes a "copy" action on the selected text in the entry.]] 75 [[This executes a "copy" action on the selected text in the widget.]]
73 } 76 }
74 selection_paste { 77 selection_paste {
75 [[This executes a "paste" action in the entry.]] 78 [[This executes a "paste" action in the widget.]]
76 } 79 }
77 selection_cut { 80 selection_cut {
78 [[This executes a "cut" action on the selected text in the entry.]] 81 [[This executes a "cut" action on the selected text in the widget.]]
79 } 82 }
80 } 83 }
81 implements { 84 implements {
diff --git a/src/lib/evas/canvas/efl_canvas_textblock.eo b/src/lib/evas/canvas/efl_canvas_textblock.eo
index edc170ba81..8e9bee7dba 100644
--- a/src/lib/evas/canvas/efl_canvas_textblock.eo
+++ b/src/lib/evas/canvas/efl_canvas_textblock.eo
@@ -140,8 +140,8 @@ class @beta Efl.Canvas.Textblock extends Efl.Canvas.Object implements Efl.Text,
140 Requires $underline. 140 Requires $underline.
141 See @Efl.Text_Style.text_underline_color. 141 See @Efl.Text_Style.text_underline_color.
142 142
143 - $secondary_underline_color: Color code for the secondary text underline (See bottom for the complete list of 143 - $secondary_underline_color: Color code for the secondary text underline (See bottom for the complete list
144 supported codes). Only valid when $[underline=double]. 144 of supported codes). Only valid when $[underline=double].
145 Default value is $[rgba(0,0,0,0)] meaning that secondary underline will not be rendered. 145 Default value is $[rgba(0,0,0,0)] meaning that secondary underline will not be rendered.
146 See @Efl.Text_Style.text_secondary_underline_color. 146 See @Efl.Text_Style.text_secondary_underline_color.
147 147
@@ -165,8 +165,8 @@ class @beta Efl.Canvas.Textblock extends Efl.Canvas.Object implements Efl.Text,
165 Default value is $[rgba(0,0,0,0)] meaning that no glow will be rendered. 165 Default value is $[rgba(0,0,0,0)] meaning that no glow will be rendered.
166 See @Efl.Text_Style.text_glow_color. 166 See @Efl.Text_Style.text_glow_color.
167 167
168 - $secondary_glow_color: Color code for the secondary (inner) glow component of the text (See bottom for the complete 168 - $secondary_glow_color: Color code for the secondary (inner) glow component of the text (See bottom for
169 list of supported codes). Only valid when the $style attribute includes a glow. 169 the complete list of supported codes). Only valid when the $style attribute includes a glow.
170 Default value is $[rgba(0,0,0,0)] meaning that only the primary $glow_color will be used. 170 Default value is $[rgba(0,0,0,0)] meaning that only the primary $glow_color will be used.
171 See @Efl.Text_Style.text_secondary_glow_color. 171 See @Efl.Text_Style.text_secondary_glow_color.
172 172