Difference between revisions of "API Panel.LinkBar.SetBarGfx"
From Flowcode Help
Jump to navigationJump to search (XML import of LinkBar API) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBarGfx''' | |
| − | + | |- | |
| − | + | | colspan="2" | Sets the graphic for the main line of the bar | |
| − | === | + | |- |
| − | [[ | + | |- |
| − | : | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | :: | + | | width="90%" | LinkBar |
| − | + | |- | |
| − | + | | colspan="2" | The handle to the bar to alter | |
| − | + | |- | |
| − | == | + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG |
| − | [[ | + | | width="90%" | Mode |
| − | + | |- | |
| − | + | | colspan="2" | The graphics mode to draw the bar with | |
| − | [[ | ||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | |
| − | + | | width="90%" | RGBA | |
|- | |- | ||
| − | | | + | | colspan="2" | The red, green, blue value to colour the point with |
| − | | | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| − | | | + | | width="90%" | Width |
|- | |- | ||
| − | | | + | | colspan="2" | The scale to use for 3D modes |
| − | | | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE |
| − | | | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' |
|} | |} | ||
| − | |||
| − | |||
| − | + | ==Detailed description== | |
| − | + | This sets the graphics mode for the main line of the bar. The default for the bar is to draw a single pixel line (''Bar_Line''). | |
| + | |||
| + | The ''Mode'' is the type of link to draw, and if a graphic is to be drawn this will be affected by ''Width'', which is always assumed to be positive and its sign is ignored. The height of the bar is its length, which is auto-calculated. | ||
| − | |||
| − | |||
| + | The RGBA is a true-colour red, green, blue value. This is 255 (0xFF) for red, 0xFF00 for green and 0xFF0000 for blue. | ||
| − | |||
| − | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
| − | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, | + | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, width)</pre> |
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
SetBarGfx |
| Sets the graphic for the main line of the bar | |
 - HANDLE
|
LinkBar |
| The handle to the bar to alter | |
 - ULONG
|
Mode |
| The graphics mode to draw the bar with | |
| - ULONG
|
RGBA |
| The red, green, blue value to colour the point with | |
 - FLOAT
|
Width |
| The scale to use for 3D modes | |
 - NONE
|
Return |
Detailed description
This sets the graphics mode for the main line of the bar. The default for the bar is to draw a single pixel line (Bar_Line).
The Mode is the type of link to draw, and if a graphic is to be drawn this will be affected by Width, which is always assumed to be positive and its sign is ignored. The height of the bar is its length, which is auto-calculated.
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.SetBarGfx(linkbar, ::Panel.LinkBar.Bar_None, rgba, width)
