summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-06-30 12:18:21 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-06-30 15:17:58 +0200
commitee18b418e2c17a49cdbf768883351136294b5b46 (patch)
tree9ef67c751188c0a94439b054ec87e6993873b02d /src
parent9a2ad5468147008d13ca712119c878b76d8fce79 (diff)
efl: gfx_shape: document property itself and not the getters and setters
Diffstat (limited to 'src')
-rw-r--r--src/lib/efl/interfaces/efl_gfx_shape.eo129
1 files changed, 49 insertions, 80 deletions
diff --git a/src/lib/efl/interfaces/efl_gfx_shape.eo b/src/lib/efl/interfaces/efl_gfx_shape.eo
index 6163dba..bd2af3c 100644
--- a/src/lib/efl/interfaces/efl_gfx_shape.eo
+++ b/src/lib/efl/interfaces/efl_gfx_shape.eo
@@ -5,35 +5,27 @@ mixin Efl.Gfx.Shape
5{ 5{
6 methods { 6 methods {
7 @property stroke_scale { 7 @property stroke_scale {
8 set { 8 [[The stroke scale to be used for stroking the path. Will be used along
9 [[Sets the stroke scale to be used for stroking the path. 9 with stroke width property.
10 the scale property will be used along with stroke width property.
11 10
12 @since 1.14 11 @since 1.14
13 ]] 12 ]]
13 set {
14 } 14 }
15 get { 15 get {
16 [[Get the stroke scaling factor used for stroking this path.
17
18 @since 1.14
19 ]]
20 } 16 }
21 values { 17 values {
22 s: double; [[stroke scale value]] 18 s: double; [[Stroke scale value]]
23 } 19 }
24 } 20 }
25 @property stroke_color { 21 @property stroke_color {
26 set { 22 [[The color to be used for stroking the path.
27 [[Sets the color to be used for stroking the path.
28 23
29 @since 1.14 24 @since 1.14
30 ]] 25 ]]
26 set {
31 } 27 }
32 get { 28 get {
33 [[Gets the color used for stroking the path.
34
35 @since 1.14
36 ]]
37 } 29 }
38 values { 30 values {
39 r: int; [[The red component of the given color.]] 31 r: int; [[The red component of the given color.]]
@@ -43,39 +35,33 @@ mixin Efl.Gfx.Shape
43 } 35 }
44 } 36 }
45 @property stroke_width { 37 @property stroke_width {
46 set { 38 [[The stroke width to be used for stroking the path.
47 [[Sets the stroke width to be used for stroking the path.
48 39
49 @since 1.14 40 @since 1.14
50 ]] 41 ]]
42 set {
51 } 43 }
52 get { 44 get {
53 [[Gets the stroke width to be used for stroking the path.
54
55 @since 1.14
56 ]]
57 } 45 }
58 values { 46 values {
59 w: double; [[stroke width to be used]] 47 w: double; [[Stroke width to be used]]
60 } 48 }
61 } 49 }
62 @property stroke_location { 50 @property stroke_location {
51 [[Not Implemented]]
63 set { 52 set {
64 [[Not Implemented]]
65 } 53 }
66 get { 54 get {
67 [[Not Implemented]]
68 } 55 }
69 values { 56 values {
70 centered: double; 57 centered: double;
71 } 58 }
72 } 59 }
73 @property stroke_dash { 60 @property stroke_dash {
61 [[Not Implemented]]
74 set { 62 set {
75 [[Not Implemented]]
76 } 63 }
77 get { 64 get {
78 [[Not Implemented]]
79 } 65 }
80 values { 66 values {
81 dash: const(Efl.Gfx.Dash) *; 67 dash: const(Efl.Gfx.Dash) *;
@@ -83,61 +69,48 @@ mixin Efl.Gfx.Shape
83 } 69 }
84 } 70 }
85 @property stroke_cap { 71 @property stroke_cap {
86 set { 72 [[The cap style to be used for stroking the path.
87 [[Sets the cap style to be used for stroking the path. 73 The cap will be used for capping the end point of a
88 The cap will be used for capping the end point of a 74 open subpath.
89 open subpath.
90 75
91 See also \@ref Efl_Gfx_Cap. 76 See also \@ref Efl_Gfx_Cap.
92 77
93 @since 1.14 78 @since 1.14
94 ]] 79 ]]
80 set {
95 } 81 }
96 get { 82 get {
97 [[Gets the cap style used for stroking path.
98
99 @since 1.14
100 ]]
101 } 83 }
102 values { 84 values {
103 c: Efl.Gfx.Cap; [[cap style to use, default is EFL_GFX_CAP_BUTT]] 85 c: Efl.Gfx.Cap; [[Cap style to use, default is EFL_GFX_CAP_BUTT]]
104 } 86 }
105 } 87 }
106 @property stroke_join { 88 @property stroke_join {
107 set { 89 [[The join style to be used for stroking the path.
108 [[Sets the join style to be used for stroking the path. 90 The join style will be used for joining the two line segment
109 The join style will be used for joining the two line segment 91 while stroking the path.
110 while stroking the path.
111 92
112 See also \@ref Efl_Gfx_Join. 93 See also \@ref Efl_Gfx_Join.
113 94
114 @since 1.14 95 @since 1.14
115 ]] 96 ]]
97 set {
116 } 98 }
117 get { 99 get {
118 [[
119 Gets the join style used for stroking path.
120
121 @since 1.14
122 ]]
123 } 100 }
124 values { 101 values {
125 j: Efl.Gfx.Join; [[join style to use, default is EFL_GFX_JOIN_MITER]] 102 j: Efl.Gfx.Join; [[Join style to use, default is EFL_GFX_JOIN_MITER]]
126 } 103 }
127 } 104 }
128 @property fill_rule { 105 @property fill_rule {
129 set { 106 [[The fill rule of the given shape object.
130 [[Sets the fill rule of the given shape object. 107 $EFL_GFX_FILL_RULE_WINDING, or $EFL_GFX_FILL_RULE_ODD_EVEN.
131 $EFL_GFX_FILL_RULE_WINDING, or $EFL_GFX_FILL_RULE_ODD_EVEN.
132 108
133 @since 1.14 109 @since 1.14
134 ]] 110 ]]
111 set {
135 } 112 }
136 get { 113 get {
137 [[Retrieves the fill rule for the given shape object.
138
139 @since 1.14
140 ]]
141 } 114 }
142 values { 115 values {
143 fill_rule: Efl.Gfx.Fill.Rule; [[The current fill rule of the shape object. 116 fill_rule: Efl.Gfx.Fill.Rule; [[The current fill rule of the shape object.
@@ -145,24 +118,20 @@ mixin Efl.Gfx.Shape
145 } 118 }
146 } 119 }
147 @property path { 120 @property path {
148 set { 121 [[Set the list of commands and points to be used to create the
149 [[Set the list of commands and points to be used to create the 122 content of shape.
150 content of shape.
151 123
152 See \@ref efl_gfx_path interface for how to create a command list. 124 See \@ref efl_gfx_path interface for how to create a command list.
153 125
154 @since 1.14 126 @since 1.14
155 ]] 127 ]]
128 set {
156 } 129 }
157 get { 130 get {
158 [[Gets the command and points list
159
160 @since 1.14
161 ]]
162 } 131 }
163 values { 132 values {
164 op: const(Efl.Gfx.Path.Command_Type) *; [[command list]] 133 op: const(Efl.Gfx.Path.Command_Type) *; [[Command list]]
165 points: const(double) *; [[point list]] 134 points: const(double) *; [[Point list]]
166 } 135 }
167 } 136 }
168 @property path_length { 137 @property path_length {
@@ -190,10 +159,10 @@ mixin Efl.Gfx.Shape
190 } 159 }
191 } 160 }
192 dup { 161 dup {
193 [[Copy the shape data from the object specified . 162 [[Copy the shape data from the object specified .
194 163
195 @since 1.14 164 @since 1.14
196 ]] 165 ]]
197 params { 166 params {
198 @in dup_from: const(Eo.Base); [[Shape object from where data will be copied.]] 167 @in dup_from: const(Eo.Base); [[Shape object from where data will be copied.]]
199 } 168 }