paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-06 22:18:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/graphutil. Updates content in DrawArrow topic.

Browse Source 
Related to 54efec74, Issue #39983.
This commit is contained in:
dsiders 2022-11-03 04:12:37 +01:00
parent 0ee5a45d42
commit e64a5bdd44
1 changed files with 62 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/xml/lcl/graphutil.xml
View File

@ -485,45 +485,93 @@ Enumerated type that indicates the direction for scrollbar arrows.
</element>
<element name="DrawArrow">
<short>Draws an arrow at the specified location on a canvas.</short>
<short>
Draws a line with an arrow at the specified location on a canvas.
</short>
<descr>
<p>
<var>DrawArrow</var> is an overloaded procedure used to draw an arrow on a
canvas at the specified location. Overloaded variants of the routine allow
the type of arrow, length, angle, and drawing style to be specified as
arguments.
<var>DrawArrow</var> is an overloaded procedure used to draw a line between
the specified points with an arrow at the ending point.
</p>
<p>
Overloaded variants of the routine allow the arguments to be specified using
various types. The variant with Direction, Location, Size, and ArrowType
arguments can draw a line with an arrow head in horizontal or vertical
directions only. The variant with the ArrowAngleRad argument allows the slope
for sides on the arrow head to be specified as a number of radians.
</p>
<p>
<var>Direction</var> is a <var>TScrollDirection</var> enumeration value, and
indicates the direction for the line and the arrow head. Allowed values
include: sdLeft, sdRight, sdUp, or sdDown.
</p>
<p>
<var>Location</var> is a <var>TPoint</var> instance which contains the
coordinates for the line starting point. This is the same as the
<var>p1</var> argument in an overloaded variant. <var>p2</var> is the ending
point for the line and the position where the tip of the arrow head is drawn.
</p>
<p>
<var>Size</var> contains the length of the line in pixels. It is used to
calculate both the ending point for the line starting at Location, and the
position where the tip of the arrow head is drawn.
</p>
<p>
<var>ArrowType</var> is a <var>TArrowType</var> enumeration value, and
indicates the drawing style used for the arrow head. atSolid causes the arrow
head to be drawn as a filled triangular polygon. atArrows causes two inclined
lines to be draw at the tip of the arrow head using the slope angle specified
in ArrowAngleRad.
</p>
<p>
<var>ArrowAngleRad</var> is a floating point value with the number of radians
for the slope on the sides of the arrow head. The default value for the
argument is defined in the NiceArrowAngle constant, and causes a 45 degree
angle to be used to draw the inclined sides on arrow head. Use
<b>&lt;angle&gt;*pi/180</b> to convert an angle in degrees to radians.
</p>
</descr>
<seealso></seealso>
<seealso/>
</element>
<element name="DrawArrow.Canvas">
<short>Canvas where the arrow is drawn.</short>
<short>Canvas where the line and arrow are drawn.</short>
</element>
<element name="DrawArrow.Direction">
<short>Direction for the arrow.</short>
<short>Direction for arrow head. Left, Right, Up, or Down.</short>
</element>
<element name="DrawArrow.Location">
<short>
Point that indicates the canvas coordinates where the arrow is drawn.
TPoint instance with the canvas coordinates for the line starting point.
</short>
</element>
<element name="DrawArrow.Size">
<short></short>
<short>
Length of the line in pixels. Determines the ending point for the line and
the position where the tip of the arrow head is drawn.
</short>
</element>
<element name="DrawArrow.ArrowType">
<short>Drawing style for the arrow.</short>
</element>
<element name="DrawArrow.p1">
<short></short>
<short>
TPoint instance with the starting point for the line drawn in the routine.
</short>
</element>
<element name="DrawArrow.p2">
<short></short>
<short>
TPoint instance with the ending point for the line drawn in the routine. It is also the position where the tip of the arrow head is drawn.
</short>
</element>
<element name="DrawArrow.ArrowLen">
<short></short>
<short>
Length in pixels for the arrow head. It is used as an offset from the ending point in the opposite direction used for the line.
</short>
</element>
<element name="DrawArrow.ArrowAngleRad">
<short></short>
<short>
Angle specified in radians used to draw the sloped sides on the arrow head.
</short>
</element>
<element name="FloodFill">