Class SLScope.TSLDisplayCursorLink
(Automated Syncronization with Documentation) |
(Automated Syncronization with Documentation) |
||
(6 intermediate revisions by one user not shown) | |||
Line 26: | Line 26: | ||
=== C# (.NET): === | === C# (.NET): === | ||
<code> | <code> | ||
− | '''public ref class''' | + | '''public ref class''' DisplayCursorLink : [[Class SLScope.TSLDisplaySelectableCollectionItem|Mitov.PlotLab.DisplaySelectableCollectionItem]] |
</code> | </code> | ||
== Summary == | == Summary == | ||
Line 58: | Line 58: | ||
*[[Property SLScope.TSLDisplayCursorLink.EndCursorIndex|EndCursorIndex]] - Specifies the index of the second (ending) cursor to which the link is established. | *[[Property SLScope.TSLDisplayCursorLink.EndCursorIndex|EndCursorIndex]] - Specifies the index of the second (ending) cursor to which the link is established. | ||
*[[Property SLScope.TSLDisplayCursorLink.MeasurementLine|MeasurementLine]] - Specifies the settings for the measurement line. | *[[Property SLScope.TSLDisplayCursorLink.MeasurementLine|MeasurementLine]] - Specifies the settings for the measurement line. | ||
− | |||
*[[Property SLScope.TSLDisplayCursorLink.MouseCursor|MouseCursor]] - Specifies the image used to represent the mouse pointer when it passes into the region covered by the cursor link. | *[[Property SLScope.TSLDisplayCursorLink.MouseCursor|MouseCursor]] - Specifies the image used to represent the mouse pointer when it passes into the region covered by the cursor link. | ||
Line 69: | Line 68: | ||
=== Public === | === Public === | ||
− | *[[Method | + | *[[Method function SLScope.TSLDisplayCursorLink.GetOwnerComponent() : TSLDataDisplay|function GetOwnerComponent() : TSLDataDisplay]] |
+ | *[[Method function SLScope.TSLDisplayCursorLink.HitTest(TSLHighlightInfo;Integer;Integer;TRect) : Boolean|function HitTest(ACursorsInfo : TSLHighlightInfo; X : Integer; Y : Integer; DispRect : TRect) : Boolean]] | ||
+ | *[[Method procedure SLScope.TSLDisplayCursorLink.MoveTo(TSLHighlightInfo;Integer;Integer;TRect)|procedure MoveTo(ACursorsInfo : TSLHighlightInfo; X : Integer; Y : Integer; DispRect : TRect)]] | ||
+ | *[[Method procedure SLScope.TSLDisplayCursorLink.Draw(TSLDisplayDrawPart;TLPCanvas;TRect;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; DispRect : TRect; Printing : Boolean)]] | ||
== Events == | == Events == | ||
Line 77: | Line 79: | ||
*[[Event SLScope.TSLDisplayCursorLink.OnMouseEnter|OnMouseEnter]] - Occurs when the mouse pointer moves over the display cursor link. | *[[Event SLScope.TSLDisplayCursorLink.OnMouseEnter|OnMouseEnter]] - Occurs when the mouse pointer moves over the display cursor link. | ||
*[[Event SLScope.TSLDisplayCursorLink.OnMouseLeave|OnMouseLeave]] - Occurs when the mouse pointer moves off from over the display cursor link. | *[[Event SLScope.TSLDisplayCursorLink.OnMouseLeave|OnMouseLeave]] - Occurs when the mouse pointer moves off from over the display cursor link. | ||
+ | |||
+ | == From [[Class SLScope.TSLDisplaySelectableCollectionItem|TSLDisplaySelectableCollectionItem]] == | ||
+ | |||
+ | == Methods == | ||
+ | |||
+ | === Public === | ||
+ | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseEnter()|procedure MouseEnter()]] | ||
+ | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseLeave()|procedure MouseLeave()]] | ||
+ | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseDown(TMouseButton;TShiftState;Integer;Integer;Boolean;Boolean)|procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)]] | ||
+ | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseUp(TMouseButton;TShiftState;Integer;Integer;Boolean)|procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)]] | ||
== From [[Class SLScope.TSLDisplayCollectionItem|TSLDisplayCollectionItem]] == | == From [[Class SLScope.TSLDisplayCollectionItem|TSLDisplayCollectionItem]] == | ||
Line 83: | Line 95: | ||
=== Published === | === Published === | ||
− | |||
*[[Property SLScope.TSLDisplayCollectionItem.Tag|Tag]] - Stores an general purpose integer value as part of an item | *[[Property SLScope.TSLDisplayCollectionItem.Tag|Tag]] - Stores an general purpose integer value as part of an item | ||
+ | |||
+ | == From [[Class LPComponent.TLPNamedCollectionItem|TLPNamedCollectionItem]] == | ||
+ | |||
+ | == Properties == | ||
+ | |||
+ | === Published === | ||
+ | *[[Property LPComponent.TLPNamedCollectionItem.Name|Name]] | ||
+ | |||
+ | == From [[Class LPComponent.TLPCollectionItem|TLPCollectionItem]] == | ||
+ | |||
+ | == Methods == | ||
+ | |||
+ | === Public === | ||
+ | *[[Method function LPComponent.TLPCollectionItem.QueryInterface(TGUID;TLPCollectionItem) : HResult|function QueryInterface(IID : TGUID; Obj : TLPCollectionItem) : HResult]] | ||
[[Category:Classes]] | [[Category:Classes]] |
Latest revision as of 00:30, 26 June 2013
This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.
Package: SignalLabScopePkg
Unit: SLScope
Inherits: TSLDisplaySelectableCollectionItem
Contents |
Syntax
Delphi:
type TSLDisplayCursorLink = class( TSLDisplaySelectableCollectionItem )
C++ Builder:
class TSLDisplayCursorLink : public TSLDisplaySelectableCollectionItem
Visual C++ (MFC):
class CTSLDisplayCursorLink : public CTSLDisplaySelectableCollectionItem
C# (.NET):
public ref class DisplayCursorLink : Mitov.PlotLab.DisplaySelectableCollectionItem
Summary
Link between two display cursors.
Description
\
Defines a link between two display cursors, to be used for distance measurement or for selection/highlighting part of the display.
Examples:
Measurement line:
Highlighting:
Properties
Published
- BeginCursorIndex - Specifies the index of the first (beginning) cursor to which the link is established.
- EndCursorIndex - Specifies the index of the second (ending) cursor to which the link is established.
- MeasurementLine - Specifies the settings for the measurement line.
- MouseCursor - Specifies the image used to represent the mouse pointer when it passes into the region covered by the cursor link.
Public
- IsDynamic - The cursor link is created by the user from inside the component dialog.
- BeginCursor - Specifies the first (beginning) cursor to which the link is established.
- EndCursor - Specifies the second (ending) cursor to which the link is established.
Methods
Public
- function GetOwnerComponent() : TSLDataDisplay
- function HitTest(ACursorsInfo : TSLHighlightInfo; X : Integer; Y : Integer; DispRect : TRect) : Boolean
- procedure MoveTo(ACursorsInfo : TSLHighlightInfo; X : Integer; Y : Integer; DispRect : TRect)
- procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; DispRect : TRect; Printing : Boolean)
Events
- OnClick - Occurs when the user clicks the display cursor link.
- OnMouseDown - Occurs when the user presses a mouse button with the mouse pointer over the cursor link.
- OnMouseUp - Occurs when the user releases a mouse button that was pressed with the mouse pointer over the cursor link.
- OnMouseEnter - Occurs when the mouse pointer moves over the display cursor link.
- OnMouseLeave - Occurs when the mouse pointer moves off from over the display cursor link.
From TSLDisplaySelectableCollectionItem
Methods
Public
- procedure MouseEnter()
- procedure MouseLeave()
- procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)
- procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)
From TSLDisplayCollectionItem
Properties
Published
- Tag - Stores an general purpose integer value as part of an item