nkWinUi::CursorManager Class Reference

Manages the recorded cursors living in the component. More...

Inheritance diagram for nkWinUi::CursorManager:

Public Member Functions
System *	getSystem () const
Cursor *	createOrRetrieve (nkMemory::StringView name)
Cursor *	record (nkMemory::StringView name, nkMemory::UniquePtr< Cursor > resource)
Cursor *	get (nkMemory::StringView name) const
Cursor *	getByIndex (unsigned int index) const
void	rename (nkMemory::StringView currentName, nkMemory::StringView newName)
void	erase (nkMemory::StringView name)
nkMemory::UniquePtr< Cursor >	relinquish (nkMemory::StringView name)
void	setActiveCursor (Cursor *cursor)

Detailed Description

Manages the recorded cursors living in the component.

Member Function Documentation

getSystem()

System* nkWinUi::CursorManager::getSystem

(

)

const

Returns

The system the manager is living in.

createOrRetrieve()

Cursor* nkWinUi::CursorManager::createOrRetrieve

(

nkMemory::StringView

name

)

Creates (if unavailable) or retrieves (if available) a resource attached to passed name.

Parameters

name	The name, aka identifier, of the resource to create or retrieve.

Returns

The resource attached to passed name. The Manager is the owner of the memory returned.

record()

Cursor* nkWinUi::CursorManager::record	(	nkMemory::StringView	name,
		nkMemory::UniquePtr< Cursor >	resource
	)

Records an already existing resource in the manager, passing its ownership around.

Parameters

name	The name under which the resource should be recorded.
resource	The resource to record.

Returns

A raw pointer over the resource, now recorded in the manager.

get()

Cursor* nkWinUi::CursorManager::get

(

nkMemory::StringView

name

)

const

Returns a resource attached to a name, if available.

Parameters

name	The name of the resource that should be retrieved.

Returns

The resource if existing, nullptr else.

getByIndex()

Cursor* nkWinUi::CursorManager::getByIndex

(

unsigned int

index

)

const

Returns the resource at given index, if available.

Parameters

index

The index of the resource to retrieve.

Returns

The resource attached to given index.

Remarks

An index refers to the index in the manager's container, so one index can be attached through different resources depending on allocations. This method is meant to loop on all resources in one go, because of this.

rename()

void nkWinUi::CursorManager::rename	(	nkMemory::StringView	currentName,
		nkMemory::StringView	newName
	)

Renames a resource.

Parameters

currentName	The name of the resource to rename.
newName	The name to reassign to the resource.

erase()

void nkWinUi::CursorManager::erase

(

nkMemory::StringView

name

)

Erases a resource. Memory attached to it will be freed.

Parameters

name	The name identifying the resource to erase.

relinquish()

nkMemory::UniquePtr<Cursor> nkWinUi::CursorManager::relinquish

(

nkMemory::StringView

name

)

Requests the manager to relinquish the ownership of a resource and pass it around.

Parameters

name	The name of the recorded resource to relinquish.

Returns

The ownership over the resource requested if available, nullptr otherwise.

setActiveCursor()

void nkWinUi::CursorManager::setActiveCursor

(

Cursor *

cursor

)

Sets the active cursor.

Parameters

cursor

The cursor to activate and use.

---

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

• Documentation/Headers/NilkinsWinUi/Cursors/CursorManager.h