evas: add documentation for Evas_Object_Vg class.

This commit is contained in:
Subhransu Sekhar Mohanty 2015-04-03 16:30:38 +02:00 committed by Cedric BAIL
parent b108fe8a10
commit 7ee3f8d952
2 changed files with 61 additions and 34 deletions

View File

@ -4,13 +4,21 @@ class Evas.VG (Evas.Object, Efl.File, Efl.Gfx.Fill, Efl.Gfx.View)
eo_prefix: evas_obj_vg; eo_prefix: evas_obj_vg;
properties { properties {
root_node { root_node {
get { get {
} /*@
values { Get the root node of the evas_object_vg.
Evas_VG_Node *container;
} @note To manually create the shape object and show in the Vg
object canvas you must create the hirarchy and set the
parent as root node.
@since 1.14
*/
}
values {
Evas_VG_Node *container; /*@ Root node of the VG canvas */
}
} }
} }
implements { implements {
Eo.Base.constructor; Eo.Base.constructor;
Efl.File.file.set; Efl.File.file.set;

View File

@ -5,22 +5,39 @@ abstract Evas.VG_Node (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack)
properties { properties {
transformation { transformation {
set { set {
} /*@
get { Sets the transformation matrix to be used for this node object.
} @since 1.14
values { */
const(Eina_Matrix3) *m; }
} get {
/*@
Gets the transformation matrix used for this node object.
@since 1.14
*/
}
values {
const(Eina_Matrix3) *m; /*@ transformation matrix */
}
} }
origin { origin {
set { set {
} /*@
get { Sets the origin position of this node object. This origin position
} affects to node transformation
values { @since 1.14
double x; */
double y; }
} get {
/*@
Gets the origin position of this node object.
@since 1.14
*/
}
values {
double x; /* @origin x position */
double y; /* @origin y position */
}
} }
mask { mask {
set { set {
@ -43,25 +60,27 @@ abstract Evas.VG_Node (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack)
} }
methods { methods {
bound_get { bound_get {
/*@ /*@
Give the bounding box in screen coordinate as being drawn. Give the bounding box in screen coordinate as being drawn.
It will start as the control box until it is refined once It will start as the control box until it is refined once the shape
the shape is computed. is computed.
*/ @since 1.14
*/
return: bool @warn_unused; return: bool @warn_unused;
params { params {
@out Eina_Rectangle r; @out Eina_Rectangle r; /*@ bounding box to be returned */
} }
} }
original_bound_get { original_bound_get {
/*@ /*@
Give the bounding box in screen coordinate as defined in Give the bounding box in screen coordinate as defined in
the file or at the insertion of the object (before any scaling). the file or at the insertion of the object (before any scaling).
*/ @since 1.14
*/
return: bool @warn_unused; return: bool @warn_unused;
params { params {
@out Eina_Rectangle r; @out Eina_Rectangle r; /*@ original bounding box to be returned */
} }
} }
} }
implements { implements {