forked from enlightenment/efl
docs: efl_vg: fill gaps in efl vector graphics eo file documentation
This commit is contained in:
parent
212fac6c37
commit
1abaecc481
|
@ -2,6 +2,7 @@ import eina_types;
|
||||||
|
|
||||||
abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Stack)
|
abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Stack)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics abstract class]]
|
||||||
eo_prefix: efl_vg;
|
eo_prefix: efl_vg;
|
||||||
legacy_prefix: evas_vg_node;
|
legacy_prefix: evas_vg_node;
|
||||||
methods {
|
methods {
|
||||||
|
@ -24,7 +25,7 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Stack)
|
||||||
]]
|
]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
name: string;
|
name: string; [[Node name]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property transformation {
|
@property transformation {
|
||||||
|
@ -41,7 +42,7 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Stack)
|
||||||
@since 1.14]]
|
@since 1.14]]
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
m: ptr(const(Eina.Matrix3)); [[transformation matrix.]]
|
m: ptr(const(Eina.Matrix3)); [[Transformation matrix.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property origin {
|
@property origin {
|
||||||
|
@ -63,12 +64,13 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Stack)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property mask {
|
@property mask {
|
||||||
|
[[Vector graphics object mask]]
|
||||||
set {
|
set {
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
m: Efl.VG;
|
m: Efl.VG; [[Object mask]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
/* quality {
|
/* quality {
|
||||||
|
@ -88,20 +90,23 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Stack)
|
||||||
|
|
||||||
@since 1.14]]
|
@since 1.14]]
|
||||||
params {
|
params {
|
||||||
@out r: Eina.Rectangle; [[bounding box to be returned.]]
|
@out r: Eina.Rectangle; [[Bounding box to be returned.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
interpolate {
|
interpolate {
|
||||||
return: bool;
|
[[Interpolate a given vector graphics object]]
|
||||||
|
|
||||||
|
return: bool; [[$true on success, $false otherwise]]
|
||||||
params {
|
params {
|
||||||
@in from: const(Efl.VG);
|
@in from: const(Efl.VG); [[Source object]]
|
||||||
@in to: const(Efl.VG);
|
@in to: const(Efl.VG); [[Destination object]]
|
||||||
@in pos_map: double;
|
@in pos_map: double; [[Interpolate mapping]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
dup {
|
dup {
|
||||||
|
[[Duplicate vector graphics object]]
|
||||||
params {
|
params {
|
||||||
@in from: const(Efl.VG);
|
@in from: const(Efl.VG); [[Source object]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,15 +1,18 @@
|
||||||
class Efl.VG.Container (Efl.VG)
|
class Efl.VG.Container (Efl.VG)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics container class]]
|
||||||
legacy_prefix: evas_vg_container;
|
legacy_prefix: evas_vg_container;
|
||||||
methods {
|
methods {
|
||||||
child_get {
|
child_get {
|
||||||
|
[[Get child of container]]
|
||||||
params {
|
params {
|
||||||
@in name: string;
|
@in name: string; [[Child node name]]
|
||||||
}
|
}
|
||||||
return: Efl.VG;
|
return: Efl.VG; [[Child object]]
|
||||||
}
|
}
|
||||||
children_get {
|
children_get {
|
||||||
return: free(own(iterator<Efl.VG>), eina_iterator_free) @warn_unused;
|
[[Get all children of container]]
|
||||||
|
return: free(own(iterator<Efl.VG>), eina_iterator_free) @warn_unused; [[Iterator to children]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
implements {
|
implements {
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
abstract Efl.VG.Gradient (Efl.VG, Efl.Gfx.Gradient)
|
abstract Efl.VG.Gradient (Efl.VG, Efl.Gfx.Gradient)
|
||||||
{
|
{
|
||||||
|
[[Efl vectopr graphics gradient abstract class]]
|
||||||
legacy_prefix: evas_vg_gradient;
|
legacy_prefix: evas_vg_gradient;
|
||||||
implements {
|
implements {
|
||||||
Efl.Gfx.Gradient.stop.set;
|
Efl.Gfx.Gradient.stop.set;
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
class Efl.VG.Gradient.Linear (Efl.VG.Gradient, Efl.Gfx.Gradient.Linear)
|
class Efl.VG.Gradient.Linear (Efl.VG.Gradient, Efl.Gfx.Gradient.Linear)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics gradient linear class]]
|
||||||
legacy_prefix: evas_vg_gradient_linear;
|
legacy_prefix: evas_vg_gradient_linear;
|
||||||
implements {
|
implements {
|
||||||
Efl.Gfx.Gradient.Linear.start.set;
|
Efl.Gfx.Gradient.Linear.start.set;
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
class Efl.VG.Gradient.Radial (Efl.VG.Gradient, Efl.Gfx.Gradient.Radial)
|
class Efl.VG.Gradient.Radial (Efl.VG.Gradient, Efl.Gfx.Gradient.Radial)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics gradient radial class]]
|
||||||
legacy_prefix: evas_vg_gradient_radial;
|
legacy_prefix: evas_vg_gradient_radial;
|
||||||
implements {
|
implements {
|
||||||
Efl.Gfx.Gradient.Radial.center.set;
|
Efl.Gfx.Gradient.Radial.center.set;
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
class Efl.VG.Root_Node (Efl.VG.Container)
|
class Efl.VG.Root_Node (Efl.VG.Container)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics root node class]]
|
||||||
legacy_prefix: evas_vg_root_node;
|
legacy_prefix: evas_vg_root_node;
|
||||||
implements {
|
implements {
|
||||||
Efl.Object.parent.set;
|
Efl.Object.parent.set;
|
||||||
|
|
|
@ -1,32 +1,36 @@
|
||||||
class Efl.VG.Shape (Efl.VG, Efl.Gfx.Shape)
|
class Efl.VG.Shape (Efl.VG, Efl.Gfx.Shape)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics shape class]]
|
||||||
legacy_prefix: evas_vg_shape;
|
legacy_prefix: evas_vg_shape;
|
||||||
methods {
|
methods {
|
||||||
@property fill {
|
@property fill {
|
||||||
|
[[Fill of the shape object]]
|
||||||
set {
|
set {
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
f: Efl.VG;
|
f: Efl.VG; [[Fill object]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property stroke_fill {
|
@property stroke_fill {
|
||||||
|
[[Stroke fill of the shape object]]
|
||||||
set {
|
set {
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
f: Efl.VG;
|
f: Efl.VG; [[Stroke fill object]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property stroke_marker {
|
@property stroke_marker {
|
||||||
|
[[Stroke marker of the shape object]]
|
||||||
set {
|
set {
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
m: Efl.VG;
|
m: Efl.VG; [[Stroke marker object]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
class Evas.VG (Efl.Canvas.Object, Efl.Gfx.Fill, Efl.Gfx.View)
|
class Evas.VG (Efl.Canvas.Object, Efl.Gfx.Fill, Efl.Gfx.View)
|
||||||
{
|
{
|
||||||
|
[[Efl vector graphics class]]
|
||||||
legacy_prefix: evas_object_vg;
|
legacy_prefix: evas_object_vg;
|
||||||
eo_prefix: evas_obj_vg;
|
eo_prefix: evas_obj_vg;
|
||||||
methods {
|
methods {
|
||||||
|
@ -8,7 +9,7 @@ class Evas.VG (Efl.Canvas.Object, Efl.Gfx.Fill, Efl.Gfx.View)
|
||||||
[[Get the root node of the evas_object_vg.
|
[[Get the root node of the evas_object_vg.
|
||||||
|
|
||||||
Note: To manually create the shape object and show in the Vg
|
Note: To manually create the shape object and show in the Vg
|
||||||
object canvas you must create the hirarchy and set the
|
object canvas you must create the hierarchy and set the
|
||||||
parent as root node.
|
parent as root node.
|
||||||
|
|
||||||
@since 1.14]]
|
@since 1.14]]
|
||||||
|
|
Loading…
Reference in New Issue