Difference between revisions of "Component: Library Component (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/LibraryComponent.fcfx FC_Comp_Source_temp/LibraryComponent.fcfx] |
| − | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/ | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/LibraryComponent.fcfx FC_Comp_Source_temp/LibraryComponent.fcfx] |
==Detailed description== | ==Detailed description== | ||
| Line 48: | Line 48: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| + | |||
| + | |||
| Line 102: | Line 104: | ||
| − | === | + | ===SetConsoleHandle=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetConsoleHandle''' |
|- | |- | ||
| − | | colspan="2" | Sets the | + | | colspan="2" | Sets the link to the component console allowing for click through and for panel console viewer linkage. |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| Line 126: | Line 123: | ||
| − | === | + | ===SetLinkHandle=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLinkHandle''' |
| + | |- | ||
| + | | colspan="2" | Sets the handle of the source object we are pointing to. | ||
| + | |- | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| + | | width="90%" | Index | ||
|- | |- | ||
| + | | colspan="2" | 0=Source, 1=Reference | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
Revision as of 12:02, 3 February 2023
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Misc |
Contents
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.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_temp/LibraryComponent.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_temp/LibraryComponent.fcfx
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 |
|
Source Icon |
|
Input Icon |
|
|
Source Is Ref |
| Moves both I/O icons to be on the right hand side. | |
|
|
Reference Icon |
|
|
Output Icon |
|
|
LinkTo |
