Class SLWaterfall.TSLWaterfallCursor

Revision as of 00:06, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 00:16, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 00:16, 11 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: SLWaterfall

Inherits: TSLBasicWaterfallCursor

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Pins 5 From TSLDisplayCursor 6 Properties 6.1 Published 6.2 Public 7 Methods 7.1 Public 8 Events 9 From TSLOptionalAxesDisplayCollectionItem 10 Methods 10.1 Public 11 From TSLOptionalDisplayCollectionItem 12 Properties 12.1 Published 13 From TSLDisplaySelectableCollectionItem 14 Methods 14.1 Public 15 From TSLDisplayCollectionItem 16 Properties 16.1 Published 17 From TLPNamedCollectionItem 18 Properties 18.1 Published 19 From TLPCollectionItem 20 Methods 20.1 Public

Syntax

Delphi:

type TSLWaterfallCursor = class( TSLBasicWaterfallCursor )

C++ Builder:

class TSLWaterfallCursor : public TSLBasicWaterfallCursor

Visual C++ (MFC):

class CTSLWaterfallCursor : public CTSLBasicWaterfallCursor

C# (.NET):

public ref class TSLWaterfallCursor : Mitov.PlotLab.BasicWaterfallCursor

Summary

Waterfall cursor.

Description

Defines a waterfall channel cursor. Cursors are used mainly to measure elements of on the waterfall.

Pins

• XOutputPin - The Real(double) output pin of the cursor for X data.
• YOutputPin - The Real(double) output pin of the cursor for Y data.

From TSLDisplayCursor

Properties

Published

• Position - Specifies the X and Y position of the cursor.
• Color - Specifies the color of the cursor.
• CanDrag - Specifies if the cursor can be dragged by mouse.
• Kind - Specifies the cursor kind - Horizontal, Vertical or Both (Crossed).
• MouseCursors - Specifies the image used to represent the mouse pointer when it passes into the region covered by the display cursor.

Public

• CursorLinks - Collection of cursor links.
• IsDynamic - The cursor is created by the user from inside the component dialog.

Methods

Public

• procedure Draw(ACanvas : TLPCanvas; DispRect : TRect)
• function HitTest(ACursorsInfo : TSLHighlightInfo; X : Integer; Y : Integer; DispRect : TRect) : Boolean
• procedure MoveTo(ACursorsInfo : TSLHighlightInfo; X : Integer; Y : Integer; DispRect : TRect)

Events

• OnClick - Occurs when the user clicks the cursor.
• OnMouseDown - Occurs when the user presses a mouse button with the mouse pointer over the cursor.
• OnMouseUp - Occurs when the user releases a mouse button that was pressed with the mouse pointer over the cursor.
• OnMouseEnter - Occurs when the mouse pointer moves over the display cursor.
• OnMouseLeave - Occurs when the mouse pointer moves off from over the display cursor.

From TSLOptionalAxesDisplayCollectionItem

Methods

Public

• function GetOwnerComponent() : TSLDataDisplay

From TSLOptionalDisplayCollectionItem

Properties

Published

• Visible - Specifies if the item will be visible.

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

From TLPNamedCollectionItem

Properties

Published

• Name

From TLPCollectionItem

Methods

Public

• function QueryInterface(IID : TGUID; Obj : TLPCollectionItem) : HResult