CNiCursor

CNi

previous page next page
Class CNiCursor Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: SetPositionNext page: Color    
Class Declared in:
 NiCursor.h

'Overview' icon -- Shortcut to top of page. Overview

CNiCursor encapsulates the interface to a single cursor on a graph control, which allows you to modify its appearance and behavior.

Individual cursors are obtained via the Cursors property on a CNiGraph object.

Note: To specify a date/time value, you must convert your date or time value to a double. A date is implemented as a floating-point value with the integer part of the number measuring days from midnight, 30 December 1899, and the fractional part representing the time of day. The absolute value of the fractional part of the number represents the time as a fraction of a day. Thus, 1 second equals 1 / 24 hours / 60 minutes, which is 1/86400 or approximately 1.157407e-5. So, midnight, 31 December 1899, is represented by 1.0. Similarly, 6 AM, 1 January 1900, is represented by 2.25, and midnight, 29 December 1899, is -1.0. However, 6 AM, 29 December 1899, is -1.25.

Hierarchy Chart Hierarchy Chart

'Base Classes' icon -- Shortcut to top of page. Base Classes

Public base class CNiInterface

'Data Items' icon -- Shortcut to top of page. Data Items

Public data CNiColor Color Specifies the color of the cursor crosshair and point.
Public data CrosshairStyles CrosshairStyle Specifies the type of lines that identify the cursor position.
Public data bool Enabled Specifies if the cursor generates mouse events or if you can drag the cursor in cursor tracking mode.
Public data CString Name Specifies the name of the cursor.
Public data CNiPlot Plot Specifies the plot associated with the cursor.
Public data long PointIndex Specifies the point associated with the cursor on the plot.
Public data PointStyles PointStyle Specifies the cursor point style.
Public data SnapModes SnapMode Specifies the snap mode of the cursor.
Public data bool Visible Specifies if the cursor is visible or hidden.
Public data double XPosition Current x axis position of the cursor.
Public data double YPosition Current y axis position of the cursor.

'Constructors' icon -- Shortcut to top of page. Constructors

Public constructor

CNiCursor()

 Default constructor.
Public constructor

CNiCursor( CWCursor_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWCursor_CI pointer.
Public constructor

CNiCursor( const CNiCursor& source )

 Copy constructor.

'Destructors' icon -- Shortcut to top of page. Destructors

Public destructor

~CNiCursor()

 Destructor.

'Functions' icon -- Shortcut to top of page. Functions

Public function static const IID &

GetIid()

 Returns the globally unique identifier (GUID) of the ActiveX interface to which this class connects.
Public function const CNiCursor &

operator =( const CNiCursor& source )

 Assignment operator.
Public function void

SetPosition( double xPosition, double yPosition )

 Sets the x and y axis positions of the cursor at the same time.

Shortcut to top of page. Example

    // Change the snap mode of the first cursor on the graph.

    CNiGraph graph;
    CNiCursor cursor = graph.Cursors.Item(1);
    cursor.SnapMode = CNiCursor::SnapNearestPoint;
previous page start next page