Jump to content

Component: Library Component (Misc): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,424 edits
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;..."
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(16 intermediate revisions by 2 users not shown)
Line 15: Line 15:
A simple library component designed to create a panel presence for any components that don't need or have a graphical simulation. Compatible with linking icons.
A simple library component designed to create a panel presence for any components that don't need or have a graphical simulation. Compatible with linking icons.


==Component Source Code==
==Detailed description==
 
 
 
 
 
 
 
 


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_LibraryComponent.fcfx FC_Comp_Source_LibraryComponent.fcfx]


==Detailed description==


''No detailed description exists yet for this component''
''No detailed description exists yet for this component''


==Examples==
==Examples==


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


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===FlashRx===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FlashRx'''
| width="90%" class="mtx-class-macrohead" | '''FlashRx'''
|-
|-
| colspan="2" | Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
| colspan="2" | Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
Line 42: Line 71:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===FlashTx===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FlashTx'''
| width="90%" class="mtx-class-macrohead" | '''FlashTx'''
|-
|-
| colspan="2" | Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
| colspan="2" | Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up.&nbsp;
Line 55: Line 85:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetLinkHandle===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLinkHandle'''
| width="90%" class="mtx-class-macrohead" | '''GetLinkHandle'''
|-
|-
| colspan="2" | Gets the handle of the source object we are pointing to. Returns 0 for not valid.&nbsp;
| colspan="2" | Gets the handle of the source object we are pointing to. Returns 0 for not valid.&nbsp;
Line 73: Line 104:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetConsoleHandle===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLinkHandle'''
| width="90%" class="mtx-class-macrohead" | '''SetConsoleHandle'''
|-
|-
| colspan="2" | Sets the handle of the source object we are pointing to. &nbsp;
| colspan="2" | Sets the link to the component console allowing for click through and for  panel console viewer linkage.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
|-
| colspan="2" | 0=Source, 1=Reference&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
Line 96: Line 123:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetLinkHandle===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetLinkHandle'''
|-
| colspan="2" | Sets the handle of the source object we are pointing to. &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetConsoleHandle'''
|-
|-
| colspan="2" | Sets the link to the component console allowing for click through and for  panel console viewer linkage.&nbsp;
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
|-
| colspan="2" | 0=Source, 1=Reference&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
Line 112: Line 145:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
Line 127: Line 158:
| width="90%" | Title
| width="90%" | Title
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Component main title, shown in the middle of the library component.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Name
|-
| colspan="2" | Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Peripheral
| width="90%" | Peripheral
|-
|-
| colspan="2" | Text to display&nbsp;
| colspan="2" | Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
Line 144: Line 180:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Source Icon
| width="90%" class="mtx-class-propfolder" | Icon0 Source/Ref
|-
|-
|-
|-
Line 158: Line 194:
| colspan="2" | Moves both I/O icons to be on the right hand side.&nbsp;
| colspan="2" | Moves both I/O icons to be on the right hand side.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Reference Icon
| width="90%" class="mtx-class-propfolder" | Icon1 Ref
|-
|-
|-
|-
Line 169: Line 205:
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | LinkTo
| width="90%" | LinkTo
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Icon2 Source
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | CommsType
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|}
|}
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LibraryComponent.fcfx FC_Comp_Source_LibraryComponent.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LibraryComponent.fcfx FC_Comp_Source_LibraryComponent.fcfx]

Latest revision as of 14:37, 13 July 2026

Author MatrixTSL
Version 1.0
Category Misc


Library Component component

A simple library component designed to create a panel presence for any components that don't need or have a graphical simulation. Compatible with linking icons.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

FlashRx

FlashRx
Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up. 
- VOID Return


FlashTx

FlashTx
Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up. 
- VOID Return


GetLinkHandle

GetLinkHandle
Gets the handle of the source object we are pointing to. Returns 0 for not valid. 
- BYTE Index
0=Source, 1=Reference 
- HANDLE Return


SetConsoleHandle

SetConsoleHandle
Sets the link to the component console allowing for click through and for panel console viewer linkage. 
- HANDLE Handle
 
- VOID Return


SetLinkHandle

SetLinkHandle
Sets the handle of the source object we are pointing to.  
- BYTE Index
0=Source, 1=Reference 
- HANDLE Handle
 
- VOID Return


Property reference

Properties
Title
Component main title, shown in the middle of the library component. 
Name
Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event. 
Peripheral
Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer. 
Vertical Alignment
 
Show Comms Indicators
 
Icon0 Source/Ref
Input Icon
 
Source Is Ref
Moves both I/O icons to be on the right hand side. 
Icon1 Ref
Output Icon
 
LinkTo
 
Icon2 Source
CommsType
 

Component Source Code

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

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Library_Component_(Misc)&oldid=47981"