Mouse cursor class. More...

#include <cursor.h>

Public Member Functions

 Cursor ()
 Constructs a null instance.
 
 Cursor (const DisplayWindow &window, const CursorDescription &cursor_description)
 Constructs a Cursor.
 
CursorProviderget_provider () const
 Returns the cursor provider.
 
bool is_null () const
 Returns true if this object is invalid.
 
 operator bool () const
 
void throw_if_null () const
 Throw an exception if this object is invalid.
 

Detailed Description

Mouse cursor class.

Constructor & Destructor Documentation

◆ Cursor() [1/2]

clan::Cursor::Cursor ( )

Constructs a null instance.

◆ Cursor() [2/2]

clan::Cursor::Cursor ( const DisplayWindow window,
const CursorDescription cursor_description 
)

Constructs a Cursor.

Parameters
window= Display Window
cursor_description= Sprite Description
hotspot= Point

Member Function Documentation

◆ get_provider()

CursorProvider * clan::Cursor::get_provider ( ) const

Returns the cursor provider.

◆ is_null()

bool clan::Cursor::is_null ( ) const
inline

Returns true if this object is invalid.

◆ operator bool()

clan::Cursor::operator bool ( ) const
inlineexplicit

◆ throw_if_null()

void clan::Cursor::throw_if_null ( ) const

Throw an exception if this object is invalid.


The documentation for this class was generated from the following file: