aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/efl/interfaces/efl_gfx_color_class.eo
blob: 23df7352332cd508b5f48d0ba1f81ec1768483cf (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
import efl_gfx_types;

interface Efl.Gfx.Color_Class
{
   [[Efl Gfx Color Class interface]]
   methods {
      @property color_class {
         set {
            [[Set the color of color class.

              This function sets the color values for a color class. This will
              cause all edje parts in the specified object that have the specified
              color class to have their colors multiplied by these values.

              The first color is the object, the second is the text outline, and
              the third is the text shadow. (Note that the second two only apply
              to text parts).

              Setting color emits a signal "color_class,set" with source being
              the given color.

              Note: These color values are expected to be premultiplied by \@p a.]]
            return: bool; [[$true if setting the color succeeded, $false otherwise]]
         }
         get {
            [[Get the color of color class.

              This function gets the color values for a color class. If no explicit
              object color is set, then global values will be used.

              The first color is the object, the second is the text outline, and
              the third is the text shadow. (Note that the second two only apply
              to text parts).

              Note: These color values are expected to be premultiplied by \@p a.]]
            return: bool; [[$true if getting the color succeeded, $false otherwise]]
         }
         keys {
            color_class: string; [[The name of color class]]
            layer: Efl.Gfx.Color_Class.Layer @optional; [[The layer to set the color]]
         }
         values {
            r: int; [[The intensity of the red color]]
            g: int; [[The intensity of the green color]]
            b: int; [[The intensity of the blue color]]
            a: int; [[The alpha value]]
         }
      }
      @property color_class_description {
         get {
            [[Get the description of a color class.

              This function gets the description of a color class in use by an object.]]
         }
         keys {
            color_class: string; [[The name of color class]]
         }
         values {
            description: string; [[The description of the target color class or $null if not found]]
         }
      }
      color_class_del {
         [[Delete the color class.

           This function deletes any values for the specified color class.

           Deleting the color class will revert it to the values defined
           by @.color_class.set() or the color class defined in the theme file.

           Deleting the color class will emit the signal "color_class,del"
           for the given Edje object.]]
         params {
            @in color_class: string; [[The name of color_class]]
         }
      }
      color_class_clear {
         [[Delete all color classes defined in object level.

           This function deletes any color classes defined in object level.
           Clearing color classes will revert the color of all edje parts to
           the values defined in global level or theme file.

           @since 1.17.0]]
      }
   }
}