aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/gfx/path.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pages/develop/api/efl/gfx/path.txt')
-rw-r--r--pages/develop/api/efl/gfx/path.txt154
1 files changed, 66 insertions, 88 deletions
diff --git a/pages/develop/api/efl/gfx/path.txt b/pages/develop/api/efl/gfx/path.txt
index feb57b28a..612fc1e56 100644
--- a/pages/develop/api/efl/gfx/path.txt
+++ b/pages/develop/api/efl/gfx/path.txt
@@ -35,161 +35,139 @@ digraph hierarchy {
++++
===== Members =====
-**[[:develop:api:efl:gfx:path:method:append_arc_to|append_arc_to]]**
+**[[:develop:api:efl:gfx:path:method:append_arc_to|append_arc_to]]**\\
+> %%Append an arc that connects from the current point int the point list to the given point (x,y). The arc is defined by the given radius in x-direction (rx) and radius in y direction (ry).%%
<code c>
void efl_gfx_path_append_arc_to(Eo *obj, double x, double y, double rx, double ry, double angle, Eina_Bool large_arc, Eina_Bool sweep);
</code>
-
-%%Append an arc that connects from the current point int the point list to the given point (x,y). The arc is defined by the given radius in x-direction (rx) and radius in y direction (ry).%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_arc|append_arc]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_arc|append_arc]]**\\
+> %%Append an arc that enclosed in the given rectangle (x, y, w, h). The angle is defined in counter clock wise , use -ve angle for clockwise arc.%%
<code c>
void efl_gfx_path_append_arc(Eo *obj, double x, double y, double w, double h, double start_angle, double sweep_length);
</code>
-
-%%Append an arc that enclosed in the given rectangle (x, y, w, h). The angle is defined in counter clock wise , use -ve angle for clockwise arc.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_circle|append_circle]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_circle|append_circle]]**\\
+> %%Append a circle with given center and radius.%%
<code c>
void efl_gfx_path_append_circle(Eo *obj, double x, double y, double radius);
</code>
-
-%%Append a circle with given center and radius.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_close|append_close]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_close|append_close]]**\\
+> %%Closes the current subpath by drawing a line to the beginning of the subpath, automatically starting a new path. The current point of the new path is (0, 0).%%
<code c>
void efl_gfx_path_append_close(Eo *obj);
</code>
-
-%%Closes the current subpath by drawing a line to the beginning of the subpath, automatically starting a new path. The current point of the new path is (0, 0).%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_cubic_to|append_cubic_to]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_cubic_to|append_cubic_to]]**\\
+> %%Adds a cubic Bezier curve between the current position and the given end point (x,y) using the control points specified by (ctrl_x0, ctrl_y0), and (ctrl_x1, ctrl_y1). After the path is drawn, the current position is updated to be at the end point of the path.%%
<code c>
void efl_gfx_path_append_cubic_to(Eo *obj, double ctrl_x0, double ctrl_y0, double ctrl_x1, double ctrl_y1, double x, double y);
</code>
-
-%%Adds a cubic Bezier curve between the current position and the given end point (x,y) using the control points specified by (ctrl_x0, ctrl_y0), and (ctrl_x1, ctrl_y1). After the path is drawn, the current position is updated to be at the end point of the path.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_line_to|append_line_to]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_line_to|append_line_to]]**\\
+> %%Adds a straight line from the current position to the given end point. After the line is drawn, the current position is updated to be at the end point of the line.%%
<code c>
void efl_gfx_path_append_line_to(Eo *obj, double x, double y);
</code>
-
-%%Adds a straight line from the current position to the given end point. After the line is drawn, the current position is updated to be at the end point of the line.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_move_to|append_move_to]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_move_to|append_move_to]]**\\
+> %%Moves the current point to the given point, implicitly starting a new subpath and closing the previous one.%%
<code c>
void efl_gfx_path_append_move_to(Eo *obj, double x, double y);
</code>
-
-%%Moves the current point to the given point, implicitly starting a new subpath and closing the previous one.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_quadratic_to|append_quadratic_to]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_quadratic_to|append_quadratic_to]]**\\
+> %%Adds a quadratic Bezier curve between the current position and the given end point (x,y) using the control points specified by (ctrl_x, ctrl_y). After the path is drawn, the current position is updated to be at the end point of the path.%%
<code c>
void efl_gfx_path_append_quadratic_to(Eo *obj, double x, double y, double ctrl_x, double ctrl_y);
</code>
-
-%%Adds a quadratic Bezier curve between the current position and the given end point (x,y) using the control points specified by (ctrl_x, ctrl_y). After the path is drawn, the current position is updated to be at the end point of the path.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_rect|append_rect]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_rect|append_rect]]**\\
+> %%Append the given rectangle with rounded corner to the path.%%
<code c>
void efl_gfx_path_append_rect(Eo *obj, double x, double y, double w, double h, double rx, double ry);
</code>
-
-%%Append the given rectangle with rounded corner to the path.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_scubic_to|append_scubic_to]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_scubic_to|append_scubic_to]]**\\
+> %%Same as efl_gfx_path_append_cubic_to() api only difference is that it uses the current control point to draw the bezier.%%
<code c>
void efl_gfx_path_append_scubic_to(Eo *obj, double x, double y, double ctrl_x, double ctrl_y);
</code>
-
-%%Same as efl_gfx_path_append_cubic_to() api only difference is that it uses the current control point to draw the bezier.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_squadratic_to|append_squadratic_to]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_squadratic_to|append_squadratic_to]]**\\
+> %%Same as efl_gfx_path_append_quadratic_to() api only difference is that it uses the current control point to draw the bezier.%%
<code c>
void efl_gfx_path_append_squadratic_to(Eo *obj, double x, double y);
</code>
-
-%%Same as efl_gfx_path_append_quadratic_to() api only difference is that it uses the current control point to draw the bezier.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:append_svg_path|append_svg_path]]**
+\\
+**[[:develop:api:efl:gfx:path:method:append_svg_path|append_svg_path]]**\\
+> %%Append SVG path data%%
<code c>
void efl_gfx_path_append_svg_path(Eo *obj, const char *svg_path_data);
</code>
-
-%%Append SVG path data%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:bounds_get|bounds_get]]**
+\\
+**[[:develop:api:efl:gfx:path:method:bounds_get|bounds_get]]**\\
+> %%Compute and return the bounding box of the currently set path%%
<code c>
void efl_gfx_path_bounds_get(Eo *obj, Eina_Rect *r);
</code>
-
-%%Compute and return the bounding box of the currently set path%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:copy_from|copy_from]]**
+\\
+**[[:develop:api:efl:gfx:path:method:copy_from|copy_from]]**\\
+> %%Copy the shape data from the object specified.%%
<code c>
void efl_gfx_path_copy_from(Eo *obj, const Efl_Object *dup_from);
</code>
-
-%%Copy the shape data from the object specified.%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:equal_commands|equal_commands]]**
+\\
+**[[:develop:api:efl:gfx:path:method:equal_commands|equal_commands]]**\\
+> %%Equal commands in object%%
<code c>
Eina_Bool efl_gfx_path_equal_commands(Eo *obj, const Efl_Object *with);
</code>
-
-%%Equal commands in object%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:interpolate|interpolate]]**
+\\
+**[[:develop:api:efl:gfx:path:method:interpolate|interpolate]]**\\
+> %%Creates intermediary path part-way between two paths%%
<code c>
Eina_Bool efl_gfx_path_interpolate(Eo *obj, const Efl_Object *from, const Efl_Object *to, double pos_map);
</code>
-
-%%Creates intermediary path part-way between two paths%%\\
-\\
-**[[:develop:api:efl:gfx:path:method:reset|reset]]**
+\\
+**[[:develop:api:efl:gfx:path:method:reset|reset]]**\\
+> %%Reset the shape data of the shape object.%%
<code c>
void efl_gfx_path_reset(Eo *obj);
</code>
-
-%%Reset the shape data of the shape object.%%\\
-\\
-**[[:develop:api:efl:gfx:path:property:current_ctrl|current_ctrl]]** //**(get)**//
+\\
+**[[:develop:api:efl:gfx:path:property:current_ctrl|current_ctrl]]** //**(get)**//\\
+> %%Current control point coordinates%%
<code c>
void efl_gfx_path_current_ctrl_get(const Eo *obj, double *x, double *y);
</code>
-
-%%Current control point coordinates%%\\
-\\
-**[[:develop:api:efl:gfx:path:property:current|current]]** //**(get)**//
+\\
+**[[:develop:api:efl:gfx:path:property:current|current]]** //**(get)**//\\
+> %%Current point coordinates%%
<code c>
void efl_gfx_path_current_get(const Eo *obj, double *x, double *y);
</code>
-
-%%Current point coordinates%%\\
-\\
-**[[:develop:api:efl:gfx:path:property:length|length]]** //**(get)**//
+\\
+**[[:develop:api:efl:gfx:path:property:length|length]]** //**(get)**//\\
+> %%Path length property%%
<code c>
void efl_gfx_path_length_get(const Eo *obj, unsigned int *commands, unsigned int *points);
</code>
-
-%%Path length property%%\\
-\\
-**[[:develop:api:efl:gfx:path:property:path|path]]** //**(get, set)**//
+\\
+**[[:develop:api:efl:gfx:path:property:path|path]]** //**(get, set)**//\\
+> %%Set the list of commands and points to be used to create the content of shape.%%
<code c>
void efl_gfx_path_get(const Eo *obj, const Efl_Gfx_Path_Command_Type **op, const double **points);
void efl_gfx_path_set(Eo *obj, const Efl_Gfx_Path_Command_Type *op, const double *points);
</code>
-
-%%Set the list of commands and points to be used to create the content of shape.%%\\
-\\
+\\
===== Events =====
-**[[:develop:api:efl:gfx:path:event:changed|changed]]**
+**[[:develop:api:efl:gfx:path:event:changed|changed]]**\\
+> %%Graphics path was changed.%%
<code c>
EFL_GFX_PATH_EVENT_CHANGED(void)
</code>
-
-%%Graphics path was changed.%%\\
-\\
+\\ \ No newline at end of file