summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graemeg@gmail.com>2013-04-29 17:14:03 +0100
committerGraeme Geldenhuys <graemeg@gmail.com>2013-04-29 17:14:03 +0100
commit1ef066af3f4fbfb339264c6095a318564dfee0b9 (patch)
tree613ae13d3d5360881d8b8446af2ff74d887343cc /docs
parent384d75d14735a111bf96bc3054d8a40c0601f53d (diff)
downloadfpGUI-1ef066af3f4fbfb339264c6095a318564dfee0b9.tar.xz
docs: Adds docs for Canvas.DrawArc() and Canvas.FillArc()
Diffstat (limited to 'docs')
-rw-r--r--docs/xml/corelib/fpg_base.xml66
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml
index 48c30abb..a124664a 100644
--- a/docs/xml/corelib/fpg_base.xml
+++ b/docs/xml/corelib/fpg_base.xml
@@ -935,6 +935,7 @@ Right. And the Top is always smaller than the Bottom.
<descr>This does not do any drawing, in only clips the line coordinates. This method is used internally by <link id="TfpgCanvasBase.DrawLineClipped"/>.</descr>
</element>
+
<element name="TfpgCanvasBase.GradientFill">
<short>Paints a rectangle with a gradient</short>
<descr><printshort id="#fpgui.fpg_base.TfpgCanvasBase.GradientFill"/>. If the gradient direction is
@@ -943,6 +944,71 @@ set to gdVertical, then it paints from top to bottom.</descr>
</element>
+<element name="TfpgCanvasBase.DrawArc">
+<short>Draws an outline arc shape</short>
+<descr><p><printshort id="#fpgui.fpg_base.TfpgCanvasBase.DrawArc"/>. It uses the TfpgCanvas.Color
+value to draw the arc.</p>
+<dl>
+<dt>x</dt>
+<dd>The left x co-ordinate of the arc drawing position</dd>
+<dt>y</dt>
+<dd>The top y co-ordinate of the arc drawing position</dd>
+<dt>w</dt>
+<dd>The width of the whole arc</dd>
+<dt>h</dt>
+<dd>The height of the whole arc</dd>
+<dt>a1</dt>
+<dd>This is the starting point of the arc. A value of 0 is the 3 o'clock
+position. A value of 270 is the 6 o'clock position. Positive values move
+counter-clockwise, and negative values move clockwise.</dd>
+<dt>a2</dt>
+<dd>This parameter is the length of the arc in degrees. A positive value
+goes counter-clockwise, and a negative values goes clockwise.</dd>
+</dl>
+</descr>
+<seealso>
+ <link id="#fpgui.fpg_base.TfpgCanvasBase.FillArc">TfpgCanvasBase.FillArc</link>
+</seealso>
+<example file="examples/fpg_base.fpgcanvasbase.drawarc.pas"/>
+</element>
+
+
+<element name="TfpgCanvasBase.FillArc.a1">
+<descr>This is the starting point of the arc. A value of 0 is the 3 o'clock
+position. A value of 270 is the 6 o'clock position. Positive values move
+counter-clockwise, and negative values move clockwise.</descr>
+</element>
+
+
+<element name="TfpgCanvasBase.FillArc">
+<short>Draws a filled arc shape</short>
+<descr><p><printshort id="#fpgui.fpg_base.TfpgCanvasBase.FillArc"/>. It uses the TfpgCanvas.Color
+value to draw and fill the arc.</p>
+<dl>
+<dt>x</dt>
+<dd>The left x co-ordinate of the arc drawing position</dd>
+<dt>y</dt>
+<dd>The top y co-ordinate of the arc drawing position</dd>
+<dt>w</dt>
+<dd>The width of the whole arc</dd>
+<dt>h</dt>
+<dd>The height of the whole arc</dd>
+<dt>a1</dt>
+<dd>This is the starting point of the arc. A value of 0 is the 3 o'clock
+position. A value of 270 is the 6 o'clock position. Positive values move
+counter-clockwise, and negative values move clockwise.</dd>
+<dt>a2</dt>
+<dd>This parameter is the length of the arc in degrees. A positive value
+goes counter-clockwise, and a negative values goes clockwise.</dd>
+</dl>
+</descr>
+<seealso>
+ <link id="#fpgui.fpg_base.TfpgCanvasBase.DrawArc">TfpgCanvasBase.DrawArc</link>
+</seealso>
+<example file="examples/fpg_base.fpgcanvasbase.fillarc.pas"/>
+</element>
+
+
<element name="TFileEntry">
<short>A simple data object representing a file</short>
<descr><printshort id="TFileEntry"/>. Some properties are OS dependant.</descr>