Difference between revisions of "Component: Mouse (Controls )"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Controls  
 
| Controls  
 
|}
 
|}
  
  
−
 
+
==Mouse component==
−
==[[File:Component Icon 82a800d4_8620_4386_8ba3_25af2768f24e.png|Image]] Mouse component==
 
 
A component to read the mouse buttons or position of the cursor on the screen.
 
A component to read the mouse buttons or position of the cursor on the screen.
  
−
==Examples==
+
==Component Pack==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
FREE
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetMouseButtons</tt></u></span>===
 
−
Reads the button states for the mouse.
 
  
−
0 = No Buttons Down / 1 = Left Button Down / 2 = Right Button Down
 
  
−
3 = Both Left and Right Buttons Down
+
''No detailed description exists yet for this component''
  
−
'''Parameters'''
+
==Examples==
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
===<span style="font-weight: normal;"><u><tt>GetMouseOverComponentHandle</tt></u></span>===
+
==Downloadable macro reference==
−
Gets the handle of the panel component under the mouse pointer
 
  
−
'''Parameters'''
+
{| 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;" | '''GetMouseButtons'''
 +
|-
 +
| colspan="2" | Reads the button states for the mouse. 0 = No Buttons Down / 1 = Left Button Down / 2 = Right Button Down 3 = Both Left and Right Buttons Down&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:''This macro has no parameters''
 
  
 +
{| 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;" | '''GetMouseOverComponentHandle'''
 +
|-
 +
| colspan="2" | Gets the handle of the panel component under the mouse pointer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Return value'''
 
  
−
:[[Variable Types|HANDLE]]
+
{| 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;" | '''GetMouseCoords'''
 +
|-
 +
| colspan="2" | Gets the coordinates of the mouse in screen coordinates.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | 0=X, 1=Y&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>GetMouseCoords</tt></u></span>===
 
−
Gets the coordinates of the mouse in screen coordinates.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''Axis''
+
==Property reference==
−
::0=X, 1=Y
 
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
:[[Variable Types|ULONG]]
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|}
−
 
 
−
 
 
−
==Property reference==
 
−
''This component does not contain any properties''
 

Latest revision as of 17:22, 9 November 2022

Author Matrix TSL
Version 1.0
Category Controls


Mouse component

A component to read the mouse buttons or position of the cursor on the screen.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png GetMouseButtons
Reads the button states for the mouse. 0 = No Buttons Down / 1 = Left Button Down / 2 = Right Button Down 3 = Both Left and Right Buttons Down 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetMouseOverComponentHandle
Gets the handle of the panel component under the mouse pointer 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png GetMouseCoords
Gets the coordinates of the mouse in screen coordinates. 
Fc9-bool-icon.png - BOOL Axis
0=X, 1=Y 
Fc9-u32-icon.png - ULONG Return



Property reference

Fc9-prop-icon.png Properties
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Mouse_(Controls_)&oldid=28726"