spk::Win32::Cursor Class Reference

Thin wrapper around Win32 cursor handles with common cursor helpers. More...

#include <spk_cursor.hpp>

Collaboration diagram for spk::Win32::Cursor:

Public Types
using	Handle = HCURSOR
	Win32 cursor handle type.

Public Member Functions
	Cursor (Handle p_handle)
	Wraps an existing Win32 cursor handle.
const Handle &	handle () const
	Returns the underlying Win32 handle.
void	use () const
	Activates this cursor for the current thread.

Static Public Member Functions
static const Cursor *	activeCursor ()
	Returns the cursor currently marked as active.
static const Cursor &	arrowCursor ()
	Returns the standard arrow cursor.
static const Cursor &	textEditCursor ()
	Returns the I-beam text edit cursor.
static const Cursor &	waitCursor ()
	Returns the wait/busy cursor.
static const Cursor &	crossCursor ()
	Returns the crosshair cursor.
static const Cursor &	altCrossCursor ()
	Returns the alternate crosshair cursor.
static const Cursor &	resizeNWSECursor ()
	Returns the north-west/south-east resize cursor.
static const Cursor &	resizeNESWCursor ()
	Returns the north-east/south-west resize cursor.
static const Cursor &	resizeWECursor ()
	Returns the west/east resize cursor.
static const Cursor &	resizeNSCursor ()
	Returns the north/south resize cursor.
static const Cursor &	moveCursor ()
	Returns the move cursor.
static const Cursor &	noCursor ()
	Returns the hidden cursor.
static const Cursor &	handCursor ()
	Returns the hand cursor for clickable elements.
static const Cursor &	workingCursor ()
	Returns the working cursor.
static const Cursor &	helpCursor ()
	Returns the help cursor.

Detailed Description

Thin wrapper around Win32 cursor handles with common cursor helpers.

See also

Handle

spk::Win32::Cursor::handCursor().use();

Constructor & Destructor Documentation

Cursor()

spk::Win32::Cursor::Cursor

(

Handle

p_handle

)

Wraps an existing Win32 cursor handle.

Parameters

p_handle

Win32 cursor handle to store.

Here is the caller graph for this function:

Member Function Documentation

activeCursor()

const Cursor * spk::Win32::Cursor::activeCursor ( )

static

Returns the cursor currently marked as active.

Returns

Pointer to the active cursor or nullptr if none.

Here is the call graph for this function:

altCrossCursor()

const Cursor & spk::Win32::Cursor::altCrossCursor ( )

static

Returns the alternate crosshair cursor.

Returns

Cursor instance for alternate crosshair.

Here is the call graph for this function:

arrowCursor()

const Cursor & spk::Win32::Cursor::arrowCursor ( )

static

Returns the standard arrow cursor.

Returns

Cursor instance for the arrow.

Here is the call graph for this function:

Here is the caller graph for this function:

crossCursor()

const Cursor & spk::Win32::Cursor::crossCursor ( )

static

Returns the crosshair cursor.

Returns

Cursor instance for crosshair.

Here is the call graph for this function:

handCursor()

const Cursor & spk::Win32::Cursor::handCursor ( )

static

Returns the hand cursor for clickable elements.

Returns

Cursor instance for hand cursor.

Here is the call graph for this function:

handle()

const Cursor::Handle & spk::Win32::Cursor::handle

(

)

const

Returns the underlying Win32 handle.

Returns

Stored cursor handle.

helpCursor()

const Cursor & spk::Win32::Cursor::helpCursor ( )

static

Returns the help cursor.

Returns

Cursor instance for help cursor.

Here is the call graph for this function:

moveCursor()

const Cursor & spk::Win32::Cursor::moveCursor ( )

static

Returns the move cursor.

Returns

Cursor instance for move action.

Here is the call graph for this function:

noCursor()

const Cursor & spk::Win32::Cursor::noCursor ( )

static

Returns the hidden cursor.

Returns

Cursor instance representing no cursor.

Here is the call graph for this function:

resizeNESWCursor()

const Cursor & spk::Win32::Cursor::resizeNESWCursor ( )

static

Returns the north-east/south-west resize cursor.

Returns

Cursor instance for NE/SW resize.

Here is the call graph for this function:

resizeNSCursor()

const Cursor & spk::Win32::Cursor::resizeNSCursor ( )

static

Returns the north/south resize cursor.

Returns

Cursor instance for N/S resize.

Here is the call graph for this function:

resizeNWSECursor()

const Cursor & spk::Win32::Cursor::resizeNWSECursor ( )

static

Returns the north-west/south-east resize cursor.

Returns

Cursor instance for NW/SE resize.

Here is the call graph for this function:

resizeWECursor()

const Cursor & spk::Win32::Cursor::resizeWECursor ( )

static

Returns the west/east resize cursor.

Returns

Cursor instance for W/E resize.

Here is the call graph for this function:

textEditCursor()

const Cursor & spk::Win32::Cursor::textEditCursor ( )

static

Returns the I-beam text edit cursor.

Returns

Cursor instance for text editing.

Here is the call graph for this function:

Here is the caller graph for this function:

waitCursor()

const Cursor & spk::Win32::Cursor::waitCursor ( )

static

Returns the wait/busy cursor.

Returns

Cursor instance for wait state.

Here is the call graph for this function:

workingCursor()

const Cursor & spk::Win32::Cursor::workingCursor ( )

static

Returns the working cursor.

Returns

Cursor instance for working cursor.

Here is the call graph for this function:

---

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

• includes/structure/win32/spk_cursor.hpp
• srcs/structure/win32/spk_cursor.cpp