luciad::MouseCursor Struct Reference

Represents a mouse cursor in the map API. More...

#include <luciad/maps/MouseCursor.h>

Public Member Functions
	MouseCursor (size_t id)
	Creates a new mouse cursor with the given id. More...
bool	operator!= (const MouseCursor &rhs) const
bool	operator== (const MouseCursor &rhs) const

Static Public Member Functions
static const MouseCursor &	arrow ()
	Returns the arrow mouse cursor. More...
static const MouseCursor &	cross ()
	Returns the cross mouse cursor. More...
static const MouseCursor &	defaultCursor ()
	Returns the default mouse cursor. More...
static const MouseCursor &	hand ()
	Returns the hand mouse cursor. More...
static const MouseCursor &	iBeam ()
	Returns the I-beam mouse cursor, for example used when editing text. More...
static const MouseCursor &	none ()
	Returns a mouse cursor that is not visible. More...
static const MouseCursor &	sizeAll ()
	Returns the size-all mouse cursor. More...
static const MouseCursor &	sizeHorizontal ()
	Returns the horizontal size mouse cursor. More...
static const MouseCursor &	sizeNeSw ()
	Returns the size mouse cursor that follows the north-east to south-west diagonal. More...
static const MouseCursor &	sizeNwSe ()
	Returns the size mouse cursor that follows the north-west to south-east diagonal. More...
static const MouseCursor &	sizeVertical ()
	Returns the vertical size mouse cursor. More...

Public Attributes
size_t	id
	The id of the mouse cursor. More...

Detailed Description

Represents a mouse cursor in the map API.

Since

2020.1

Constructor & Destructor Documentation

MouseCursor()

luciad::MouseCursor::MouseCursor ( size_t  id )

inlineexplicit

Creates a new mouse cursor with the given id.

Parameters

id	the id of the mouse cursor.

Member Function Documentation

arrow()

static const MouseCursor & luciad::MouseCursor::arrow ( )

static

Returns the arrow mouse cursor.

Returns

the arrow mouse cursor.

cross()

static const MouseCursor & luciad::MouseCursor::cross ( )

static

Returns the cross mouse cursor.

Returns

the cross mouse cursor.

defaultCursor()

static const MouseCursor & luciad::MouseCursor::defaultCursor ( )

static

Returns the default mouse cursor.

Returns

the default mouse cursor.

hand()

static const MouseCursor & luciad::MouseCursor::hand ( )

static

Returns the hand mouse cursor.

Returns

the hand mouse cursor.

iBeam()

static const MouseCursor & luciad::MouseCursor::iBeam ( )

static

Returns the I-beam mouse cursor, for example used when editing text.

Returns

the I-beam mouse cursor, for example used when editing text.

none()

static const MouseCursor & luciad::MouseCursor::none ( )

static

Returns a mouse cursor that is not visible.

Returns

a mouse cursor that is not visible.

Since

2022.0

operator!=()

bool luciad::MouseCursor::operator!=

(

const MouseCursor &

rhs

)

const

operator==()

bool luciad::MouseCursor::operator==

(

const MouseCursor &

rhs

)

const

sizeAll()

static const MouseCursor & luciad::MouseCursor::sizeAll ( )

static

Returns the size-all mouse cursor.

Returns

the size-all mouse cursor.

sizeHorizontal()

static const MouseCursor & luciad::MouseCursor::sizeHorizontal ( )

static

Returns the horizontal size mouse cursor.

Returns

the horizontal size mouse cursor.

sizeNeSw()

static const MouseCursor & luciad::MouseCursor::sizeNeSw ( )

static

Returns the size mouse cursor that follows the north-east to south-west diagonal.

Returns

the size mouse cursor that follows the north-east to south-west diagonal.

sizeNwSe()

static const MouseCursor & luciad::MouseCursor::sizeNwSe ( )

static

Returns the size mouse cursor that follows the north-west to south-east diagonal.

Returns

the size mouse cursor that follows the north-west to south-east diagonal.

sizeVertical()

static const MouseCursor & luciad::MouseCursor::sizeVertical ( )

static

Returns the vertical size mouse cursor.

Returns

the vertical size mouse cursor.

Member Data Documentation

id

size_t luciad::MouseCursor::id

The id of the mouse cursor.