summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_text_font.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-12-13 11:47:47 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-12-17 14:20:12 +0100
commit0265f4fd5565e01bba0c2228f4f981a644dcaee1 (patch)
treead82735b5b955a2ee8927cfe9a7160d843015c5b /src/lib/efl/interfaces/efl_text_font.eo
parent3bfc73a95ae2b0eeb473ace10eacafa5802eca93 (diff)
docs: Add detailed text styling information
Summary: More detailed descriptions for each attribute. Relationship between attributes. Default values. Links to direct API methods for the corresponding property. General text overhaul and formatting. Test Plan: Builds and passes tests. Generate docgen or DocFX documentation and enjoy your new Text styling descriptions! Reviewers: ali.alzyod Reviewed By: ali.alzyod Subscribers: AbdullehGhujeh, cedric, #reviewers, #committers, woohyun, bu5hm4n Tags: #efl Differential Revision: https://phab.enlightenment.org/D10873
Diffstat (limited to 'src/lib/efl/interfaces/efl_text_font.eo')
-rw-r--r--src/lib/efl/interfaces/efl_text_font.eo88
1 files changed, 44 insertions, 44 deletions
diff --git a/src/lib/efl/interfaces/efl_text_font.eo b/src/lib/efl/interfaces/efl_text_font.eo
index 836835c2a6..dce81a7e10 100644
--- a/src/lib/efl/interfaces/efl_text_font.eo
+++ b/src/lib/efl/interfaces/efl_text_font.eo
@@ -1,53 +1,53 @@
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 [[Type of font weight.]]
4 normal, [[Normal font weight]] 4 normal, [[Normal font weight.]]
5 thin, [[Thin font weight]] 5 thin, [[Thin font weight.]]
6 ultralight, [[Ultralight font weight]] 6 ultralight, [[Ultralight font weight.]]
7 extralight, [[Extralight font weight]] 7 extralight, [[Extralight font weight.]]
8 light, [[Light font weight]] 8 light, [[Light font weight.]]
9 book, [[Book font weight]] 9 book, [[Book font weight.]]
10 medium, [[Medium font weight]] 10 medium, [[Medium font weight.]]
11 semibold, [[Semibold font weight]] 11 semibold, [[Semibold font weight.]]
12 bold, [[Bold font weight]] 12 bold, [[Bold font weight.]]
13 ultrabold, [[Ultrabold font weight]] 13 ultrabold, [[Ultrabold font weight.]]
14 extrabold, [[Extrabold font weight]] 14 extrabold, [[Extrabold font weight.]]
15 black, [[Black font weight]] 15 black, [[Black font weight.]]
16 extrablack, [[Extrablack font weight]] 16 extrablack, [[Extrablack font weight.]]
17} 17}
18 18
19enum @beta Efl.Text_Font_Width { 19enum @beta Efl.Text_Font_Width {
20 [[Type of font width]] 20 [[Type of font width.]]
21 normal, [[Normal font width]] 21 normal, [[Normal font width.]]
22 ultracondensed, [[Ultracondensed font width]] 22 ultracondensed, [[Ultracondensed font width.]]
23 extracondensed, [[Extracondensed font width]] 23 extracondensed, [[Extracondensed font width.]]
24 condensed, [[Condensed font width]] 24 condensed, [[Condensed font width.]]
25 semicondensed, [[Semicondensed font width]] 25 semicondensed, [[Semicondensed font width.]]
26 semiexpanded, [[Semiexpanded font width]] 26 semiexpanded, [[Semiexpanded font width.]]
27 expanded, [[Expanded font width]] 27 expanded, [[Expanded font width.]]
28 extraexpanded, [[Extraexpanded font width]] 28 extraexpanded, [[Extraexpanded font width.]]
29 ultraexpanded, [[Ultraexpanded font width]] 29 ultraexpanded, [[Ultraexpanded font width.]]
30} 30}
31 31
32enum @beta Efl.Text_Font_Slant { 32enum @beta Efl.Text_Font_Slant {
33 [[Type of font slant]] 33 [[Type of font slant.]]
34 normal, [[Normal font slant]] 34 normal, [[Normal font slant.]]
35 oblique, [[Oblique font slant]] 35 oblique, [[Oblique font slant.]]
36 italic, [[Italic font slant]] 36 italic, [[Italic font slant.]]
37} 37}
38 38
39/* FIXME: It needs to support "normal" option for non-color bitmap font. 39/* FIXME: It needs to support "normal" option for non-color bitmap font.
40 For supporting "normal" option, S/W glyph drawing engine should be updated. 40 For supporting "normal" option, S/W glyph drawing engine should be updated.
41 */ 41 */
42enum @beta Efl.Text_Font_Bitmap_Scalable { 42enum @beta Efl.Text_Font_Bitmap_Scalable {
43 [[Scalable of bitmap fonts 43 [[Scalable of bitmap fonts.
44 ]] 44 ]]
45 none = 0, [[Disable scalable feature for bitmap fonts.]] 45 none = 0, [[Disable scalable feature for bitmap fonts.]]
46 color = (1 << 0), [[Enable scalable feature for color bitmap fonts.]] 46 color = (1 << 0), [[Enable scalable feature for color bitmap fonts.]]
47} 47}
48 48
49interface @beta Efl.Text_Font { 49interface @beta Efl.Text_Font {
50 [[Font settings of the text 50 [[Font settings for text.
51 ]] 51 ]]
52 c_prefix: efl_text; 52 c_prefix: efl_text;
53 methods { 53 methods {
@@ -105,42 +105,42 @@ interface @beta Efl.Text_Font {
105 } 105 }
106 106
107 @property font_fallbacks { 107 @property font_fallbacks {
108 [[Comma-separated list of font fallbacks 108 [[Comma-separated list of font fallbacks.
109 109
110 Will be used in case the primary font isn't available. 110 Will be used in case the primary font isn't available.
111 ]] 111 ]]
112 values { 112 values {
113 font_fallbacks: string; [[Font name fallbacks]] 113 font_fallbacks: string; [[List of fallback font names.]]
114 } 114 }
115 } 115 }
116 116
117 @property font_weight { 117 @property font_weight {
118 [[Type of weight of the displayed font 118 [[Type of weight of the displayed font
119 119
120 Default is @Efl.Text_Font_Weight.normal\. 120 Default is @Efl.Text_Font_Weight.normal.
121 ]] 121 ]]
122 values { 122 values {
123 font_weight: Efl.Text_Font_Weight; [[Font weight]] 123 font_weight: Efl.Text_Font_Weight; [[Font weight.]]
124 } 124 }
125 } 125 }
126 126
127 @property font_slant { 127 @property font_slant {
128 [[Type of slant of the displayed font 128 [[Type of slant of the displayed font.
129 129
130 Default is @Efl.Text_Font_Slant.normal\. 130 Default is @Efl.Text_Font_Slant.normal.
131 ]] 131 ]]
132 values { 132 values {
133 style: Efl.Text_Font_Slant; [[Font slant]] 133 style: Efl.Text_Font_Slant; [[Font slant.]]
134 } 134 }
135 } 135 }
136 136
137 @property font_width { 137 @property font_width {
138 [[Type of width of the displayed font 138 [[Type of width of the displayed font.
139 139
140 Default is @Efl.Text_Font_Width.normal\. 140 Default is @Efl.Text_Font_Width.normal.
141 ]] 141 ]]
142 values { 142 values {
143 width: Efl.Text_Font_Width; [[Font width]] 143 width: Efl.Text_Font_Width; [[Font width.]]
144 } 144 }
145 } 145 }
146 146
@@ -153,19 +153,19 @@ interface @beta Efl.Text_Font {
153 "auto" to use the system locale, or "none". 153 "auto" to use the system locale, or "none".
154 ]] 154 ]]
155 values { 155 values {
156 lang: string; [[Language]] 156 lang: string; [[Language code.]]
157 } 157 }
158 } 158 }
159 159
160 @property font_bitmap_scalable { 160 @property font_bitmap_scalable {
161 [[The bitmap fonts have fixed size glyphs for several available sizes. 161 [[The bitmap fonts have fixed size glyphs for several available sizes.
162 Basically, it is not scalable. But, it needs to be scalable for some use cases. 162 Basically, it is not scalable. But, it needs to be scalable for some use cases.
163 (ex. colorful emoji fonts) 163 (e.g. colorful emoji fonts)
164 164
165 Default is @Efl.Text_Font_Bitmap_Scalable.none\. 165 Default is @Efl.Text_Font_Bitmap_Scalable.none.
166 ]] 166 ]]
167 values { 167 values {
168 scalable: Efl.Text_Font_Bitmap_Scalable; [[Scalable]] 168 scalable: Efl.Text_Font_Bitmap_Scalable; [[Scalable.]]
169 } 169 }
170 } 170 }
171 } 171 }