sdl::devices::Cursor Class Reference

Represents the system pointer. More...

#include <Cursor.h>

List of all members.

Public Member Functions
	Cursor ()
	Cursor (unsigned char *data, unsigned char *mask, const Rect &rect, const Coordinate< int > &pos)
	~Cursor ()
void	move (const Coordinate< short > &pos)
bool	show ()
bool	hide ()
bool	isVisible ()
bool	toggle ()
void	activate ()
void	redraw ()

---

Detailed Description

Represents the system pointer.

Definition at line 40 of file Cursor.h.

---

Constructor & Destructor Documentation

sdl::devices::Cursor::Cursor

(

)

[inline]

Constructs a Cursor using the system's cursor.

Exceptions:

runtime_error

Throws a runtime_error if unable to get the system cursor.

Definition at line 47 of file Cursor.h.

sdl::devices::Cursor::Cursor	(	unsigned char *	data,
		unsigned char *	mask,
		const Rect &	rect,
		const Coordinate< int > &	pos
	)		[inline]

Constructs a Cursor.

Parameters:

data	The color of each Cursor pixel.
mask	The mask for each Cursor pixel.
rect	A rectangle containing the height and width of the Cursor.
pos	The position of the upper-left corner of the Cursor.

Exceptions:

runtime_error,Throws

a runtime_error if unable to create cursor.

Definition at line 62 of file Cursor.h.

sdl::devices::Cursor::~Cursor

(

)

[inline]

Destroys a Cursor.

Definition at line 73 of file Cursor.h.

---

Member Function Documentation

void sdl::devices::Cursor::activate

(

)

[inline]

Activates the Cursor.

Definition at line 117 of file Cursor.h.

bool sdl::devices::Cursor::hide

(

)

[inline]

Hides the Cursor.

Returns:

True if successful, false otherwise.

Definition at line 96 of file Cursor.h.

bool sdl::devices::Cursor::isVisible

(

)

[inline]

Determines if the Cursor if visible or not.

Returns:

True is Cursor is visible, false otherwise.

Definition at line 103 of file Cursor.h.

void sdl::devices::Cursor::move

(

const Coordinate< short > &

pos

)

[inline]

Moves the Cursor to the specified position.

Parameters:

pos	The position to which to move the upper-left corner of the Cursor.

Returns:

void.

Definition at line 82 of file Cursor.h.

void sdl::devices::Cursor::redraw

(

)

[inline]

Force the cursor to redraw.

Definition at line 122 of file Cursor.h.

bool sdl::devices::Cursor::show

(

)

[inline]

Shows the Cursor.

Returns:

True if successful, false otherwise.

Definition at line 89 of file Cursor.h.

bool sdl::devices::Cursor::toggle

(

)

[inline]

Toggles the visibility of the Cursor.

Returns:

True if successful, false otherwise.

Definition at line 110 of file Cursor.h.

---

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

• devices/Cursor.h