Class SLWaterfall.TSLWaterfallMarkerGroup

Revision as of 00:20, 22 November 2011 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)		Latest revision as of 00:30, 26 June 2013 (view source) David Alm (Talk | contribs) (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''' TSLWaterfallMarkerGroup : [[Class SLScope.TSLDisplayMarkerGroup|Mitov.PlotLab.DisplayMarkerGroup]]	+	'''public ref class''' WaterfallMarkerGroup : [[Class SLScope.TSLDisplayMarkerGroup|Mitov.PlotLab.DisplayMarkerGroup]]
	</code>		</code>
	== Summary ==		== Summary ==
Line 42:		Line 42:
	*[[Property SLWaterfall.TSLWaterfallMarkerGroup.Line|Line]] - Specifies how the lines connecting the markers will be drawn.		*[[Property SLWaterfall.TSLWaterfallMarkerGroup.Line|Line]] - Specifies how the lines connecting the markers will be drawn.
	*[[Property SLWaterfall.TSLWaterfallMarkerGroup.Mode|Mode]] - Specifies the markers mode.		*[[Property SLWaterfall.TSLWaterfallMarkerGroup.Mode|Mode]] - Specifies the markers mode.
		+
		+	== Methods ==
		+
		+	=== Public ===
		+	*[[Method function SLWaterfall.TSLWaterfallMarkerGroup.HitTest(Integer;Integer;TSLDisplayMarker) : Real|function HitTest(X : Integer; Y : Integer; var SelectedMarker : TSLDisplayMarker) : Real]]
	== From [[Class SLScope.TSLDisplayMarkerGroup|TSLDisplayMarkerGroup]] ==		== From [[Class SLScope.TSLDisplayMarkerGroup|TSLDisplayMarkerGroup]] ==
Line 55:		Line 60:
	*[[Property SLScope.TSLDisplayMarkerGroup.Labels|Labels]] - Specifies the setting of the labels of the markers of the marker group.		*[[Property SLScope.TSLDisplayMarkerGroup.Labels|Labels]] - Specifies the setting of the labels of the markers of the marker group.
	*[[Property SLScope.TSLDisplayMarkerGroup.CanDrag|CanDrag]] - Specifies if the markers in the group can be dragged by mouse.		*[[Property SLScope.TSLDisplayMarkerGroup.CanDrag|CanDrag]] - Specifies if the markers in the group can be dragged by mouse.
		+	*[[Property SLScope.TSLDisplayMarkerGroup.MouseCursor|MouseCursor]] - Specifies the image used to represent the mouse pointer when it passes into the region covered by the markers belonging to the group.
	*[[Property SLScope.TSLDisplayMarkerGroup.Visible|Visible]] - Controls the visibility of the marker group.		*[[Property SLScope.TSLDisplayMarkerGroup.Visible|Visible]] - Controls the visibility of the marker group.
		+
		+	== Methods ==
		+
		+	=== Public ===
		+	*[[Method procedure SLScope.TSLDisplayMarkerGroup.MouseUp(TMouseButton;TShiftState;Integer;Integer;Boolean)|procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)]]
		+	*[[Method procedure SLScope.TSLDisplayMarkerGroup.MouseDown(TMouseButton;TShiftState;Integer;Integer;Boolean;Boolean)|procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)]]
	== Events ==		== Events ==
Line 70:		Line 82:
	=== Published ===		=== Published ===
	*[[Property SLScope.TSLOptionalDisplayCollectionItem.Visible|Visible]] - Specifies if the item will be visible.		*[[Property SLScope.TSLOptionalDisplayCollectionItem.Visible|Visible]] - Specifies if the item will be visible.
		+
		+	== 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 76:		Line 98:
	=== Published ===		=== Published ===
−	*[[Property SLScope.TSLDisplayCollectionItem.Name|Name]] - Specifies the name of the item.
	*[[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: SLWaterfall

Inherits: TSLDisplayMarkerGroup

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 5 Methods 5.1 Public 6 From TSLDisplayMarkerGroup 7 Properties 7.1 Published 8 Methods 8.1 Public 9 Events 10 From TSLOptionalDisplayCollectionItem 11 Properties 11.1 Published 12 From TSLDisplaySelectableCollectionItem 13 Methods 13.1 Public 14 From TSLDisplayCollectionItem 15 Properties 15.1 Published 16 From TLPNamedCollectionItem 17 Properties 17.1 Published 18 From TLPCollectionItem 19 Methods 19.1 Public

Syntax

Delphi:

type TSLWaterfallMarkerGroup = class( TSLDisplayMarkerGroup )

C++ Builder:

class TSLWaterfallMarkerGroup : public TSLDisplayMarkerGroup

Visual C++ (MFC):

class CTSLWaterfallMarkerGroup : public CTSLDisplayMarkerGroup

C# (.NET):

public ref class WaterfallMarkerGroup : Mitov.PlotLab.DisplayMarkerGroup

Summary

Waterfall marker group class.

Description

Defines a Waterfall marker group. All the markers that belong to the group will have the same visual appearance as specified by the properties of the group.

Properties

Published

• Markers - Collection of the markers that belong to the Marker Group.
• Line - Specifies how the lines connecting the markers will be drawn.
• Mode - Specifies the markers mode.

Methods

Public

• function HitTest(X : Integer; Y : Integer; var SelectedMarker : TSLDisplayMarker) : Real

From TSLDisplayMarkerGroup

Properties

Published

• Brush - Specifies the Brush to be used for the markers in the marker group.
• Pen - Specifies the Pen to be used for the markers in the marker group.
• Shape - Specifies the shapes of the markers in the marker group.
• CrosshairLines - Specifies the setting of the crosshairs of the markers of the marker group.
• Size - Specifies the size of the markers in the marker group.
• Labels - Specifies the setting of the labels of the markers of the marker group.
• CanDrag - Specifies if the markers in the group can be dragged by mouse.
• MouseCursor - Specifies the image used to represent the mouse pointer when it passes into the region covered by the markers belonging to the group.
• Visible - Controls the visibility of the marker group.

Methods

Public

• procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)
• procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)

Events

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

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