Difference between revisions of "Component: Slider control (Advanced Shapes)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Advanced Shapes
 
| Advanced Shapes
 
|}
 
|}
 +
 +
 +
==Slider control component==
 +
A simple graphical interface for a vertical meter or slider control.  This can be used within custom components to give them a way to display an analogue value, or to allow setting a value by clicking and dragging with the mouse.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_slider.fcfx FC_Comp_Source_slider.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_slider.fcfx FC_Comp_Source_slider.fcfx]
 +
 +
==Detailed description==
 +
 +
  
  
  
−
==[[File:Component Icon 0d074f2e_5ff6_45d2_a0a8_1b5c3aa34e41.png|Image]] Slider control component==
 
−
A simple graphical interface for a vertical meter or slider control.  This can be used within
 
−
custom components to give them a way to display an analogue value, or to allow setting
 
−
a value by clicking and dragging with the mouse.
 
  
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
 
−
Gets the current value of the slider.  This will be within the range set by the
 
  
−
SetRange macro.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
 
−
Set the current value of the slider.  This will override any value set by using the mouse.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Value''
 
−
::The value to set.
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetInteractive</tt></u></span>===
 
−
Set whether the mouse can be used to change the slider value.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''Enable''
 
−
::Set true to allow clicks to set scale
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetTitle</tt></u></span>===
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ShowScale</tt></u></span>===
 
−
Set whether graduated marking are shown along the length of the slider.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''Show''
 
−
::True to show scale, else false
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
Simple example showing how to use the simulation slider component as a meter display for use in monitoring type applications.
 +
{{Fcfile|Meters.fcfx|Meters}}
  
  
−
===<span style="font-weight: normal;"><u><tt>SetRange</tt></u></span>===
 
−
Set the minimum and maximum values that can be shown on the slider.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|INT]] ''Min''
 
−
::Min (start) value
 
  
−
:[[Variable Types|INT]] ''Max''
 
−
::Maximum (end) value
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
 +
 +
==Macro reference==
 +
 +
===GetValue===
 +
{| 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;" | '''GetValue'''
 +
|-
 +
| colspan="2" | Gets the current value of the slider.  This will be within the range set by the SetRange macro.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
===SetInteractive===
 +
{| 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;" | '''SetInteractive'''
 +
|-
 +
| colspan="2" | Set whether the mouse can be used to change the slider value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Enable
 +
|-
 +
| colspan="2" | Set true to allow clicks to set scale&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
===SetRange===
 +
{| 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;" | '''SetRange'''
 +
|-
 +
| colspan="2" | Set the minimum and maximum values that can be shown on the slider.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Min
 +
|-
 +
| colspan="2" | Min (start) value&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Max
 +
|-
 +
| colspan="2" | Maximum (end) value&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
===SetValue===
 +
{| 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;" | '''SetValue'''
 +
|-
 +
| colspan="2" | Set the current value of the slider.  This will override any value set by using the mouse.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | The value to set.&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
===ShowScale===
 +
{| 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;" | '''ShowScale'''
 +
|-
 +
| colspan="2" | Set whether graduated marking are shown along the length of the slider.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Show
 +
|-
 +
| colspan="2" | True to show scale, else false&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
 
==Property reference==
 
==Property reference==
−
''This component does not contain any properties''
+
 
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|}

Latest revision as of 13:14, 7 February 2023

Author Matrix Ltd
Version 1.1
Category Advanced Shapes


Slider control component

A simple graphical interface for a vertical meter or slider control. This can be used within custom components to give them a way to display an analogue value, or to allow setting a value by clicking and dragging with the mouse.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_slider.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_slider.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Simple example showing how to use the simulation slider component as a meter display for use in monitoring type applications. FC6 Icon.png Meters






Macro reference

GetValue

Fc9-comp-macro.png GetValue
Gets the current value of the slider. This will be within the range set by the SetRange macro. 
Fc9-f32-icon.png - FLOAT Return


SetInteractive

Fc9-comp-macro.png SetInteractive
Set whether the mouse can be used to change the slider value. 
Fc9-bool-icon.png - BOOL Enable
Set true to allow clicks to set scale 
Fc9-void-icon.png - VOID Return


SetRange

Fc9-comp-macro.png SetRange
Set the minimum and maximum values that can be shown on the slider. 
Fc9-s16-icon.png - INT Min
Min (start) value 
Fc9-s16-icon.png - INT Max
Maximum (end) value 
Fc9-void-icon.png - VOID Return


SetValue

Fc9-comp-macro.png SetValue
Set the current value of the slider. This will override any value set by using the mouse. 
Fc9-f32-icon.png - FLOAT Value
The value to set. 
Fc9-void-icon.png - VOID Return


ShowScale

Fc9-comp-macro.png ShowScale
Set whether graduated marking are shown along the length of the slider. 
Fc9-bool-icon.png - BOOL Show
True to show scale, else false 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Slider_control_(Advanced_Shapes)&oldid=38499"