summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_text_style.eo
blob: d0cd196e9aa612bc70e800861df0c1563d4434e3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
enum Efl.Text_Style_Background_Type
{
   [[Type of background to use behind each line of text.

     @since 1.24
   ]]
   none = 0,    [[Do not use background.]]
   solid_color, [[Use a solid-color rectangle as background.
                  Requires @Efl.Text_Style.text_background_color.]]
}

enum Efl.Text_Style_Strikethrough_Type
{
   [[Whether to add a strike-through decoration to the displayed text or not.
     @since 1.24
   ]]
   none = 0, [[Do not use strike-through.]]
   single,   [[Strike-through with a single line.
               Requires @Efl.Text_Style.text_strikethrough_color.]]
}

enum Efl.Text_Style_Effect_Type
{
   [[Effect to apply to the displayed text.
     @since 1.24
   ]]
   none = 0,            [[No effect.]]
   shadow,              [[Shadow effect.
                          Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
   far_shadow,          [[Far shadow effect.
                          Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
   soft_shadow,         [[Soft shadow effect.
                          Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
   far_soft_shadow,     [[Far and soft shadow effect.
                          Uses @Efl.Text_Style.text_shadow_color and @Efl.Text_Style.text_shadow_direction.]]
   glow,                [[Glow effect.
                          Uses @Efl.Text_Style.text_glow_color and @Efl.Text_Style.text_secondary_glow_color.]]
   outline,             [[Outline effect.
                          Uses @Efl.Text_Style.text_outline_color.]]
   soft_outline,        [[Soft outline effect.
                          Uses @Efl.Text_Style.text_outline_color.]]
   outline_shadow,      [[Outline + shadow effect.
                          Uses @Efl.Text_Style.text_shadow_color, @Efl.Text_Style.text_shadow_direction and
                          @Efl.Text_Style.text_outline_color.]]
   outline_soft_shadow, [[Outline + soft shadow effect.
                          Uses @Efl.Text_Style.text_shadow_color, @Efl.Text_Style.text_shadow_direction and
                          @Efl.Text_Style.text_outline_color.]]
}

enum Efl.Text_Style_Shadow_Direction
{
   [[Direction of the shadow effect.
     @since 1.24
   ]]
   bottom_right = 0, [[Shadow towards bottom right.]]
   bottom,           [[Shadow towards bottom.]]
   bottom_left,      [[Shadow towards bottom left.]]
   left,             [[Shadow towards left.]]
   top_left,         [[Shadow towards top left.]]
   top,              [[Shadow towards top.]]
   top_right,        [[Shadow towards top right.]]
   right,            [[Shadow towards right.]]
}

enum Efl.Text_Style_Underline_Type
{
   [[Type of underline for the displayed text.
     @since 1.24
   ]]
   none = 0, [[Text without underline.]]
   single,   [[Underlined with a single line.
               Requires @Efl.Text_Style.text_underline_color.]]
   double,   [[Underlined with a double line.
               Requires @Efl.Text_Style.text_underline_color and @Efl.Text_Style.text_secondary_underline_color.]]
   dashed,   [[Underlined with a dashed line.
               Requires @Efl.Text_Style.text_underline_dashed_color, @Efl.Text_Style.text_underline_dashed_width and
               @Efl.Text_Style.text_underline_dashed_gap.]]
}

interface Efl.Text_Style {
   [[Decorations to add to the text.

     Decorations include text color, glow, outline, underline, strike-through and shadows.
     @since 1.24
   ]]
   c_prefix: efl_text;
   methods {
      @property text_color {
         [[Color of text, excluding all other decorations. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_background_type {
         [[Type of background to use behind each line of text.]]
         values
         {
            type: Efl.Text_Style_Background_Type; [[Background type.]]
         }
      }

      @property text_background_color {
         [[Color of the background behind each line of text. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_underline_type {
         [[Type of underline to use for the text.]]
         values
         {
            type: Efl.Text_Style_Underline_Type; [[Underline type.]]
         }
      }

      @property text_underline_color
      {
         [[Color of the primary underline. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_underline_height
      {
         [[Width (in pixels) of the single underline when @.text_underline_type is
           @Efl.Text_Style_Underline_Type.single.]]
         values
         {
            height: double; [[Underline width in pixels.]]
         }
      }

      @property text_underline_dashed_color
      {
         [[Color of the dashed underline. Only valid when @.text_underline_type is
           @Efl.Text_Style_Underline_Type.dashed. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_underline_dashed_width
      {
         [[Length (in pixels) of the dashes when @.text_underline_type is
           @Efl.Text_Style_Underline_Type.dashed.]]
         values
         {
            width: int; [[Dash length in pixels.]]
         }
      }

      @property text_underline_dashed_gap
      {
         [[Length (in pixels) of the gaps between the dashes when @.text_underline_type is
           @Efl.Text_Style_Underline_Type.dashed.]]
         values
         {
            gap: int; [[Gap length in pixels.]]
         }
      }

      @property text_secondary_underline_color
      {
         [[Color of the secondary underline. Only valid when @.text_underline_type is
           @Efl.Text_Style_Underline_Type.double. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_strikethrough_type {
         [[Enables crossed-out text.]]
         values
         {
            type: Efl.Text_Style_Strikethrough_Type; [[Strike-through type.]]
         }
      }

      @property text_strikethrough_color
      {
         [[Color of the line striking through the text. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_effect_type {
         [[Controls a number of decorations around the text, like shadow, outline
           and glow, including combinations of them.]]
         values {
            type: Efl.Text_Style_Effect_Type; [[Effect type.]]
         }
      }
      @property text_outline_color
      {
         [[Color of the text outline. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_shadow_direction
      {
         [[Direction of the shadow effect.]]
         values
         {
            type: Efl.Text_Style_Shadow_Direction; [[Shadow direction.]]
         }
      }

      @property text_shadow_color
      {
         [[Color of the text shadow. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_glow_color
      {
         [[Color of the text glow. By default it is invisible.]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_secondary_glow_color
      {
         [[Color of the secondary glow decoration.
           This is the color of the inner glow (where it touches the text) which
           gradually fades into @.text_glow_color as it reaches the outer edge.
           By default it is invisible.
         ]]
         values
         {
            r: ubyte; [[Red component.]]
            g: ubyte; [[Green component.]]
            b: ubyte; [[Blue component.]]
            a: ubyte; [[Alpha component.]]
         }
      }

      @property text_gfx_filter
      {
         [[Program that applies a special filter

           See @Efl.Gfx.Filter.
         ]]
         values
         {
            code: string; [[Filter code.]]
         }
      }
   }
}