Event Scope.Overlay - Revision history

JonnyW: XML import

2014-01-16T15:59:01Z

XML import

JonnyW: XML import of events update

2013-08-21T14:33:54Z

XML import of events update

JonnyW: XML import of updated Event docs

2013-06-17T09:58:46Z

XML import of updated Event docs

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:32Z

XML Import to change Variable types into Variable Types

JonnyW: XML import API changes

2013-05-14T12:22:21Z

XML import API changes

New page

Sent when the mouse hovers over a scope stream

This event is part of the [[Event class Scope|Scope]] class

__TOC__

==Parameters==
[[Variable types|HANDLE]] ''StreamH''
:The stream handle

[[Variable types|ULONG]] ''TimeUS''
:The -ve offset from now of the time hovered over, in microseconds

[[Variable types|FLOAT]] ''UnitValue''
:The value pointed to on the scope, from 0 to 1

[[Variable types|STRING]] ''Info''
:The text to display on the overlay
:''This parameter is returned back to Flowcode''

[[Variable types|LONG]] ''OverlayOffset''
:The number of micoseconds to add to the Time for the overlay start
:''This parameter is returned back to Flowcode''

[[Variable types|ULONG]] ''OverlaySize''
:The number of microseconds of the overlay from its start
:''This parameter is returned back to Flowcode''

==Return value==
[[Variable types|ULONG]]
Non-zero to add the overlay to the stream

==Detailed description==
''<span style="color:red;">No additional information</span>''

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

← Older revision		Revision as of 15:59, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>Event Contents</sidebar>		<sidebar>Event Contents</sidebar>
	Sent when the mouse hovers over a scope stream		Sent when the mouse hovers over a scope stream

← Older revision		Revision as of 14:33, 21 August 2013
Line 1:		Line 1:


		+	<sidebar>Event Contents</sidebar>
	Sent when the mouse hovers over a scope stream		Sent when the mouse hovers over a scope stream

@@ Line 1: / Line 1: @@
 Sent when the mouse hovers over a scope stream
@@ Line 38: / Line 40: @@
 ==Examples==
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

@@ Line 1: / Line 1: @@
 Sent when the mouse hovers over a scope stream
@@ Line 7: / Line 6: @@
 ==Parameters==
-[[Variable types|HANDLE]] ''StreamH''
+[[Variable Types|HANDLE]] ''StreamH''
 :The stream handle
-[[Variable types|ULONG]] ''TimeUS''
+[[Variable Types|ULONG]] ''TimeUS''
 :The -ve offset from now of the time hovered over, in microseconds
-[[Variable types|FLOAT]] ''UnitValue''
+[[Variable Types|FLOAT]] ''UnitValue''
 :The value pointed to on the scope, from 0 to 1
-[[Variable types|STRING]] ''Info''
+[[Variable Types|STRING]] ''Info''
 :The text to display on the overlay
 :''This parameter is returned back to Flowcode''
-[[Variable types|LONG]] ''OverlayOffset''
+[[Variable Types|LONG]] ''OverlayOffset''
 :The number of micoseconds to add to the Time for the overlay start
 :''This parameter is returned back to Flowcode''
-[[Variable types|ULONG]] ''OverlaySize''
+[[Variable Types|ULONG]] ''OverlaySize''
 :The number of microseconds of the overlay from its start
 :''This parameter is returned back to Flowcode''
@@ Line 30: / Line 29: @@
 ==Return value==
-[[Variable types|ULONG]]
+[[Variable Types|ULONG]]
 Non-zero to add the overlay to the stream