forked from enlightenment/efl
efl_gfx_base: convert docs
This commit is contained in:
parent
06e3a330fe
commit
0032c48a19
|
@ -4,130 +4,121 @@ interface Efl.Gfx.Base {
|
||||||
methods {
|
methods {
|
||||||
@property position {
|
@property position {
|
||||||
set {
|
set {
|
||||||
/*@ Move the given Evas object to the given location inside its canvas' viewport. */
|
[[Move the given Evas object to the given location inside its
|
||||||
|
canvas' viewport.
|
||||||
|
]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@ Retrieves the position of the given Evas object. */
|
[[Retrieves the position of the given Evas object.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
x: int; /*@ in */
|
x: int;
|
||||||
y: int; /*@ in */
|
y: int;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property size {
|
@property size {
|
||||||
set {
|
set {
|
||||||
/*@ Changes the size of the given Evas object. */
|
[[Changes the size of the given Evas object.]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@ Retrieves the (rectangular) size of the given Evas object. */
|
[[Retrieves the (rectangular) size of the given Evas object.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
w: int; /*@ in */
|
w: int;
|
||||||
h: int; /*@ in */
|
h: int;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property color {
|
@property color {
|
||||||
set {
|
set {
|
||||||
/*@
|
[[Sets the general/main color of the given Evas object to the given
|
||||||
Sets the general/main color of the given Evas object to the given
|
one.
|
||||||
one.
|
|
||||||
|
|
||||||
@see evas_object_color_get() (for an example)
|
See also @evas_object_color_get (for an example)
|
||||||
@note These color values are expected to be premultiplied by @p a.
|
|
||||||
|
|
||||||
@ingroup Evas_Object_Group_Basic */
|
These color values are expected to be premultiplied by alpha.
|
||||||
|
]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@
|
[[Retrieves the general/main color of the given Evas object.
|
||||||
Retrieves the general/main color of the given Evas object.
|
|
||||||
|
|
||||||
Retrieves the main color's RGB component (and alpha channel)
|
Retrieves the main color's RGB component (and alpha channel)
|
||||||
values, <b>which range from 0 to 255</b>. For the alpha channel,
|
values, which range from 0 to 255. For the alpha channel,
|
||||||
which defines the object's transparency level, 0 means totally
|
which defines the object's transparency level, 0 means totally
|
||||||
transparent, while 255 means opaque. These color values are
|
transparent, while 255 means opaque. These color values are
|
||||||
premultiplied by the alpha value.
|
premultiplied by the alpha value.
|
||||||
|
|
||||||
Usually youll use this attribute for text and rectangle objects,
|
Usually youll use this attribute for text and rectangle objects,
|
||||||
where the main color is their unique one. If set for objects
|
where the main color is their unique one. If set for objects
|
||||||
which themselves have colors, like the images one, those colors get
|
which themselves have colors, like the images one, those colors
|
||||||
modulated by this one.
|
get modulated by this one.
|
||||||
|
|
||||||
@note All newly created Evas rectangles get the default color
|
All newly created Evas rectangles get the default color
|
||||||
values of <code>255 255 255 255</code> (opaque white).
|
values of 255 255 255 255 (opaque white).
|
||||||
|
|
||||||
@note Use @c NULL pointers on the components you're not interested
|
Use null pointers on the components you're not interested
|
||||||
in: they'll be ignored by the function.
|
in: they'll be ignored by the function.
|
||||||
|
|
||||||
Example:
|
See the full @Example_Evas_Object_Manipulation "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 {
|
values {
|
||||||
r: int; /*@ The red component of the given color. */
|
r: int; [[The red component of the given color.]]
|
||||||
g: int; /*@ The green component of the given color. */
|
g: int; [[The green component of the given color.]]
|
||||||
b: int; /*@ The blue component of the given color. */
|
b: int; [[The blue component of the given color.]]
|
||||||
a: int; /*@ The alpha component of the given color. */
|
a: int; [[The alpha component of the given color.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property color_part {
|
@property color_part {
|
||||||
set {
|
set {
|
||||||
/*@
|
[[Sets a specifc color of the given Efl.Gfx.Base object to the
|
||||||
Sets a specifc color of the given Efl.Gfx.Base object to the given
|
given one.
|
||||||
one.
|
|
||||||
|
|
||||||
@see evas_object_color_get() (for an example)
|
See also @evas_object_color_get (for an example)
|
||||||
@note These color values are expected to be premultiplied by @p a.
|
|
||||||
|
|
||||||
*/
|
These color values are expected to be premultiplied by alpha.
|
||||||
return: bool;
|
]]
|
||||||
|
return: bool;
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@
|
[[Retrieves a specific color of the given Evas object.
|
||||||
Retrieves a specific color of the given Evas object.
|
|
||||||
|
|
||||||
Retrieves a specific color's RGB component (and alpha channel)
|
Retrieves a specific color's RGB component (and alpha channel)
|
||||||
values, <b>which range from 0 to 255</b>. For the alpha channel,
|
values, which range from 0 to 255. For the alpha channel,
|
||||||
which defines the object's transparency level, 0 means totally
|
which defines the object's transparency level, 0 means totally
|
||||||
transparent, while 255 means opaque. These color values are
|
transparent, while 255 means opaque. These color values are
|
||||||
premultiplied by the alpha value.
|
premultiplied by the alpha value.
|
||||||
|
|
||||||
The main color being mapped to @c NULL.
|
The main color being mapped to null.
|
||||||
|
|
||||||
Usually youll use this attribute for text and rectangle objects,
|
Usually youll use this attribute for text and rectangle objects,
|
||||||
where the main color is their unique one. If set for objects
|
where the main color is their unique one. If set for objects
|
||||||
which themselves have colors, like the images one, those colors get
|
which themselves have colors, like the images one, those colors
|
||||||
modulated by this one.
|
get modulated by this one.
|
||||||
|
|
||||||
@note Use @c NULL pointers on the components you're not interested
|
Use null pointers on the components you're not interested
|
||||||
in: they'll be ignored by the function.
|
in: they'll be ignored by the function.
|
||||||
|
]]
|
||||||
*/
|
return: bool;
|
||||||
return: bool;
|
}
|
||||||
|
keys {
|
||||||
|
part: const (char)*; [[The part you are interested in.]]
|
||||||
}
|
}
|
||||||
keys {
|
|
||||||
part: const (char)*; /*@ The part you are interested in. */
|
|
||||||
}
|
|
||||||
values {
|
values {
|
||||||
r: int; /*@ The red component of the given color. */
|
r: int; [[The red component of the given color.]]
|
||||||
g: int; /*@ The green component of the given color. */
|
g: int; [[The green component of the given color.]]
|
||||||
b: int; /*@ The blue component of the given color. */
|
b: int; [[The blue component of the given color.]]
|
||||||
a: int; /*@ The alpha component of the given color. */
|
a: int; [[The alpha component of the given color.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property visible {
|
@property visible {
|
||||||
set {
|
set {
|
||||||
/*@ Makes the given Evas object visible or invisible. */
|
[[Makes the given Evas object visible or invisible.]]
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
/*@ Retrieves whether or not the given Evas object is visible. */
|
[[Retrieves whether or not the given Evas object is visible.]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
v: bool; /*@ @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise */
|
v: bool; [[true if to make the object visible, false otherwise]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue