Difference between revisions of "Event Scope.Overlay"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated Event docs)
Line 1: Line 1:
 +
 +
 
Sent when the mouse hovers over a scope stream
 
Sent when the mouse hovers over a scope stream
  
Line 38: Line 40:
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


Sent when the mouse hovers over a scope stream

This event is part of the Scope class

Parameters

HANDLE StreamH

The stream handle

ULONG TimeUS

The -ve offset from now of the time hovered over, in microseconds

FLOAT UnitValue

The value pointed to on the scope, from 0 to 1

STRING Info

The text to display on the overlay
This parameter is returned back to Flowcode

LONG OverlayOffset

The number of micoseconds to add to the Time for the overlay start
This parameter is returned back to Flowcode

ULONG OverlaySize

The number of microseconds of the overlay from its start
This parameter is returned back to Flowcode


Return value

ULONG Non-zero to add the overlay to the stream


Detailed description

No additional information


Examples

No additional examples