API Panel.LinkBar.SetStartGfx - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:57Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:30Z

JonnyW: XML import

2014-01-16T15:57:51Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:33Z

XML import of API documentation

JonnyW at 13:39, 1 July 2013

2013-07-01T13:39:01Z

JonnyW: XML import

2013-07-01T13:35:37Z

XML import

JonnyW: XML import of LinkBar API

2013-07-01T10:46:11Z

XML import of LinkBar API

New page

<sidebar>API contents</sidebar>
Sets the position for the start point of the bar

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Panel|Panel]]
:[[API Panel.LinkBar|LinkBar]]
::[[API Panel.LinkBar|SetStartGfx]]
</div>
__TOC__

==Parameters==
[[Variable Types|HANDLE]] ''LinkBar''
:The handle to the bar to alter

[[Variable Types|ULONG]] ''Mode''
:The graphics mode to draw the bar start-point with
:''Typical values for this parameter:''
::{| class="wikitable" width="65%"
|-
! width="30%" |Name
! width="55%" |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
|}

[[Variable Types|ULONG]] ''RGBA''
:The red, green, blue value to colour the point with

[[Variable Types|FLOAT]] ''Width''
:The width to use for 3D and arrow modes

[[Variable Types|FLOAT]] ''Height''
:The height to use for 3D and arrow modes

==Return value==
''This call does not return a value''

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)</pre>

''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 11:54, 16 January 2023
Line 51:		Line 51:
	===Calling in a calculation===		===Calling in a calculation===
	* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartGfx(linkbar, ::Panel.LinkBar.Cap_None, rgba, width, height)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-! width="30%" |Name
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-! width="55%" |Description
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetStartGfx'''
 |-
-|Cap_None
+| colspan="2" | Sets the graphic for the start point of the bar&nbsp;
 |-
 |-
-|Cap_Triangle
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-|A flat 2D traingle
+| width="90%" | LinkBar
 |-
-|Cap_Cone
+| colspan="2" | The handle to the bar to alter&nbsp;
 |-
-|Cap_Sphere
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-|A 3D sphere
+| width="90%" | Mode
 |-
-|Cap_Dome
+| colspan="2" | The graphics mode to draw the bar start-point with&nbsp;
 |-
-|Cap_Cylinder
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-|A 3D cylinder
+| width="90%" | RGBA
 |}

← Older revision		Revision as of 15:57, 16 January 2014
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

← Older revision		Revision as of 14:27, 9 August 2013
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

← Older revision		Revision as of 13:39, 1 July 2013
Line 61:		Line 61:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	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.
		+

@@ Line 2: / Line 2: @@
 <sidebar>API contents</sidebar>
-Sets the position for the start point of the bar
+Sets the graphic for the start point of the bar
 <div style="width:25%; float:right" class="toc">