aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/efl/interfaces/efl_text_style.eo
blob: 99552ac0360ea0aebb3e757b6032f3229153c704 (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
enum Efl.Text_Style_Backing_Type
{
   [[Whether to apply backing style to the displayed text or not]]
   disabled = 0, [[Do not use backing]]
   enabled,      [[Use backing style]]
}

enum Efl.Text_Style_Strikethrough_Type
{
   [[Whether to apply strikethrough style to the displayed text or not]]
   disabled = 0, [[Do not use strikethrough]]
   enabled,      [[Use strikethrough style]]
}

enum Efl.Text_Style_Effect_Type
{
   [[Effect to apply to the displayed text]]
   none = 0, [[No effect]]

   // colored with shadow_color
   shadow, [[Shadow effect]]
   far_shadow, [[Far shadow effect]]
   soft_shadow, [[Soft shadow effect]]
   far_soft_shadow, [[Far and soft shadow effect]]
   // colored with glow_color
   glow, [[Glow effect]]
   // colored with outline_color
   outline, [[Outline effect]]
   soft_outline, [[Soft outline effect]]
   // colored with outline_color + shadow_color
   outline_shadow, [[Outline shadow effect]]
   outline_soft_shadow, [[Outline soft shadow effect]]
}

enum Efl.Text_Style_Shadow_Direction
{
   [[Direction of the shadow style, if used]]
   bottom_right = 0, [[Shadow towards bottom right]]
   bottom, [[Shadow towards botom]]
   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
{
   [[Underline type of the displayed text]]
   off = 0, [[Text without underline]]
   on, [[Underline enabled]]
   single, [[Underlined with a signle line]]
   double, [[Underlined with a double line]]
   dashed, [[Underlined with a dashed line]]
}

interface Efl.Text_Style {
   [[Style to apply to the text

     A style can be coloring, effects, underline, strikethrough etc.

     @since 1.20
   ]]
   eo_prefix: efl_text;
   methods {
      @property normal_color {
         [[Color of text, excluding style]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property backing_type {
          [[Enable or disable backing type]]
         values
         {
            type: Efl.Text_Style_Backing_Type; [[Backing type]]
         }
      }

      @property backing_color {
          [[Backing color]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property underline_type {
         [[Sets an underline style on the text]]
         values
         {
            type: Efl.Text_Style_Underline_Type; [[Underline type]]
         }
      }

      @property underline_color
      {
         [[Color of normal underline style]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property underline_height
      {
         [[Height of underline style]]
         values
         {
            height: double; [[Height]]
         }
      }

      @property underline_dashed_color
      {
         [[Color of dashed underline style]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property underline_dashed_width
      {
         [[Width of dashed underline style]]
         values
         {
            width: int; [[Width]]
         }
      }

      @property underline_dashed_gap
      {
         [[Gap of dashed underline style]]
         values
         {
            gap: int; [[Gap]]
         }
      }

      @property underline2_color
      {
         [[Color of underline2 style]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property strikethrough_type {
         [[Type of strikethrough style]]
         values
         {
            type: Efl.Text_Style_Strikethrough_Type; [[Strikethrough type]]
         }
      }

      @property strikethrough_color
      {
         [[Color of strikethrough_style]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property effect_type {
         [[Type of effect used for the displayed text]]
         values {
            type: Efl.Text_Style_Effect_Type; [[Effect type]]
         }
      }
      @property outline_color
      {
         [[Color of outline effect]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

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

      @property shadow_color
      {
         [[Color of shadow effect]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property glow_color
      {
         [[Color of glow effect]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

      @property glow2_color
      {
         [[Second color of the glow effect]]
         values
         {
            r: ubyte; [[Red component]]
            g: ubyte; [[Green component]]
            b: ubyte; [[Blue component]]
            a: ubyte; [[Alpha component]]
         }
      }

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

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