Difference between revisions of "API Panel.LinkBar.SetStartGfx"
From Flowcode Help
Jump to navigationJump to search (XML import of API documentation) |
(XML import) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
<sidebar>API Contents</sidebar> | <sidebar>API Contents</sidebar> | ||
Sets the graphic for the start point of the bar | Sets the graphic for the start point of the bar | ||
Revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets the graphic for the start point of the bar
Contents
Parameters
HANDLE LinkBar
- The handle to the bar to alter
ULONG Mode
- The graphics mode to draw the bar start-point with
- Typical values for this parameter:
Name Description Cap_None No cap is drawn for the start or end point Cap_Line A line arrow is drawn Cap_Triangle A flat 2D traingle Cap_Cone A 3D cone Cap_Sphere A 3D sphere Cap_Dome A 3D half-sphere Cap_Cylinder A 3D cylinder
ULONG RGBA
- The red, green, blue value to colour the point with
FLOAT Width
- The width to use for 3D and arrow modes
FLOAT Height
- The height to use for 3D and arrow modes
Return value
This call does not return a value
Detailed description
This sets the graphics mode for the start point of the bar. The default for the start is to have no graphics.
The Mode is the type of link to draw, and if a graphic is to be drawn this will be affected by Width and Height. Width is always assumed to be positive and its sign is ignored, but Height may be negative to invert the arrow or graphic specified.
The RGBA is a true-colour red, green, blue value. This is 255 (0xFF) for red, 0xFF00 for green and 0xFF0000 for blue.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.LinkBar.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)
No additional examples
