aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/canvas/layout/property/color_class.txt
blob: 6dab9c42321296802ecf2cf48b4cbc3106cb2f9d (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
~~Title: Efl.Canvas.Layout.color_class~~
===== Description =====




{{page>:develop:api-include:efl:canvas:layout:property:color_class:description&nouser&nolink&nodate}}

===== Keys =====

  * **color_class** - %%The name of color class%%
  * **layer** - %%The layer to set the color%%
===== Values =====

  * **r** - %%The intensity of the red color%%
  * **g** - %%The intensity of the green color%%
  * **b** - %%The intensity of the blue color%%
  * **a** - %%The alpha value%%
==== Getter ====

%%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.%%
</note>


{{page>:develop:api-include:efl:canvas:layout:property:color_class:getter_description&nouser&nolink&nodate}}

==== Setter ====

%%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.%%
</note>
{{page>:develop:api-include:efl:canvas:layout:property:color_class:getter_description&nouser&nolink&nodate}}


//Overridden from [[:develop:api:efl:gfx:color_class:property:color_class|Efl.Gfx.Color_Class.color_class]] **(get, set)**.//===== Signature =====

<code>
@property color_class @pure_virtual {
    get {
        keys {
            color_class: free(string, free);
            layer: Efl.Gfx.Color_Class.Layer @optional;
        }
        values {
            r: int;
            g: int;
            b: int;
            a: int;
        }
        return: bool;
    }
    set {
        keys {
            color_class: free(string, free);
            layer: Efl.Gfx.Color_Class.Layer @optional;
        }
        values {
            r: int;
            g: int;
            b: int;
            a: int;
        }
        return: bool;
    }
}
</code>

===== C signature =====

<code c>
Eina_Bool efl_gfx_color_class_get(const Eo *obj, const char *color_class, Efl_Gfx_Color_Class_Layer layer, int *r, int *g, int *b, int *a);
Eina_Bool efl_gfx_color_class_set(Eo *obj, const char *color_class, Efl_Gfx_Color_Class_Layer layer, int r, int g, int b, int a);
</code>

===== Implemented by =====

  * [[:develop:api:efl:gfx:color_class:property:color_class|Efl.Gfx.Color_Class.color_class]]