summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_gfx_base.eo
blob: e3d70260a3e502d91f7814a5c2b0152c9be35521 (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
interface Efl.Gfx.Base {
   legacy_prefix: null;
   eo_prefix: efl_gfx;
   methods {
      @property position {
         set {
            /*@ Move the given Evas object to the given location inside its canvas' viewport. */
         }
         get {
            /*@ Retrieves the position of the given Evas object. */
         }
         values {
            int x; /*@ in */
            int y; /*@ in */
         }
      }
      @property size {
         set {
            /*@ Changes the size of the given Evas object. */
         }
         get {
            /*@ Retrieves the (rectangular) size of the given Evas object. */
         }
         values {
            int w; /*@ in */
            int h; /*@ in */
         }
      }
      @property color {
         set {
            /*@
            Sets the general/main color of the given Evas object to the given
            one.

            @see evas_object_color_get() (for an example)
            @note These color values are expected to be premultiplied by @p a.

            @ingroup Evas_Object_Group_Basic */
         }
         get {
            /*@
            Retrieves the general/main color of the given Evas object.

            Retrieves the “main” color's RGB component (and alpha channel)
            values, <b>which range from 0 to 255</b>. For the alpha channel,
            which defines the object's transparency level, 0 means totally
            transparent, while 255 means opaque. These color values are
            premultiplied by the alpha value.

            Usually you’ll use this attribute for text and rectangle objects,
            where the “main” color is their unique one. If set for objects
            which themselves have colors, like the images one, those colors get
            modulated by this one.

            @note All newly created Evas rectangles get the default color
            values of <code>255 255 255 255</code> (opaque white).

            @note Use @c NULL pointers on the components you're not interested
            in: they'll be ignored by the function.

            Example:
            @dontinclude evas-object-manipulation.c
            @skip int alpha, r, g, b;
            @until return

            See the full @ref Example_Evas_Object_Manipulation "example".

            @ingroup Evas_Object_Group_Basic */
         }
         values {
            int r; /*@ The red component of the given color. */
            int g; /*@ The green component of the given color. */
            int b; /*@ The blue component of the given color. */
            int a; /*@ The alpha component of the given color. */
         }
      }
      @property color_part {
         set {
            /*@
            Sets a specifc color of the given Efl.Gfx.Base object to the given
            one.

            @see evas_object_color_get() (for an example)
            @note These color values are expected to be premultiplied by @p a.

            */
	    return: bool;
         }
         get {
            /*@
            Retrieves a specific color of the given Evas object.

            Retrieves a specific color's RGB component (and alpha channel)
            values, <b>which range from 0 to 255</b>. For the alpha channel,
            which defines the object's transparency level, 0 means totally
            transparent, while 255 means opaque. These color values are
            premultiplied by the alpha value.

	    The “main“ color being mapped to @c NULL.

            Usually you’ll use this attribute for text and rectangle objects,
            where the “main” color is their unique one. If set for objects
            which themselves have colors, like the images one, those colors get
            modulated by this one.

            @note Use @c NULL pointers on the components you're not interested
            in: they'll be ignored by the function.

            */
	    return: bool;
         }
	 keys {
	    const (char)* part; /*@ The part you are interested in. */
	 }
         values {
            int r; /*@ The red component of the given color. */
            int g; /*@ The green component of the given color. */
            int b; /*@ The blue component of the given color. */
            int a; /*@ The alpha component of the given color. */
         }
      }
      @property visible {
         set {
            /*@ Makes the given Evas object visible or invisible. */
         }
         get {
            /*@ Retrieves whether or not the given Evas object is visible. */
         }
         values {
            bool v; /*@ @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise */
         }
      }
   }
}