PLGui::Cursor Class Reference

Cursor class. More...

#include <Cursor.h>

List of all members.

Public Member Functions
PLGUI_API	Cursor (Gui &cGui)
	Constructor.
PLGUI_API	Cursor (Gui &cGui, EMouseCursor nCursor)
	Constructor.
PLGUI_API	Cursor (Gui &cGui, const PLCore::String &sFilename, const PLMath::Vector2i &vHotspot)
	Constructor.
PLGUI_API	Cursor (const Cursor &cCursor)
	Copy constructor.
PLGUI_API	~Cursor ()
	Destructor.
PLGUI_API Cursor &	operator= (const Cursor &cCursor)
	Assignment operator.
PLGUI_API Gui *	GetGui () const
	Get owner GUI.
PLGUI_API CursorImpl *	GetImpl () const
	Get implementation.
PLGUI_API void	Load (EMouseCursor nCursor)
	Load cursor.
PLGUI_API void	Load (const PLCore::String &sFilename, const PLMath::Vector2i &vHotspot)
	Load cursor.
PLGUI_API EMouseCursor	GetCursorID () const
	Get cursor ID.
PLGUI_API PLCore::String	GetFilename () const
	Get cursor filename.
Protected Attributes
Gui *	m_pGui
CursorImpl *	m_pCursorImpl
EMouseCursor	m_nMouseCursor
PLCore::String	m_sFilename

---

Detailed Description

Cursor class.

Note:

• Implementation of the bridge design pattern, this class is the abstraction

---

Constructor & Destructor Documentation

PLGUI_API PLGui::Cursor::Cursor

(

Gui &

cGui

)

Constructor.

Parameters:

[in]

cGui

Owner GUI

Remarks:

Loads the standard mouse cursor

PLGUI_API PLGui::Cursor::Cursor	(	Gui &	cGui,
		EMouseCursor	nCursor
	)

Constructor.

Parameters:

[in]	cGui	Owner GUI
[in]	nCursor	Cursor ID

Remarks:

Loads one of the predefined mouse cursors. If you pass CursorCustom here, it will be ignored and the standard mouse cursor will be used instead. To load a custom cursor, see the other constructor and pass a filename.

PLGUI_API PLGui::Cursor::Cursor	(	Gui &	cGui,
		const PLCore::String &	sFilename,
		const PLMath::Vector2i &	vHotspot
	)

Constructor.

Parameters:

[in]	cGui	Owner GUI
[in]	sFilename	Name of image file
[in]	vHotspot	Hotspot of cursor

Remarks:

Loads a custom cursor from an image. The mouse cursor ID will be set to CursorCustom.

PLGUI_API PLGui::Cursor::Cursor

(

const Cursor &

cCursor

)

Copy constructor.

Parameters:

[in]

cCursor

Cursor that is copied

PLGUI_API PLGui::Cursor::~Cursor

(

)

Destructor.

---

Member Function Documentation

PLGUI_API Cursor& PLGui::Cursor::operator=

(

const Cursor &

cCursor

)

Assignment operator.

Parameters:

[in]

cCursor

Cursor that is copied

PLGUI_API Gui* PLGui::Cursor::GetGui

(

)

const

Get owner GUI.

Returns:

Pointer to GUI object (never a null pointer)

PLGUI_API CursorImpl* PLGui::Cursor::GetImpl

(

)

const

Get implementation.

Returns:

Pointer to platform specific implementation

PLGUI_API void PLGui::Cursor::Load

(

EMouseCursor

nCursor

)

Load cursor.

Parameters:

[in]

nCursor

Cursor ID

PLGUI_API void PLGui::Cursor::Load	(	const PLCore::String &	sFilename,
		const PLMath::Vector2i &	vHotspot
	)

Load cursor.

Parameters:

[in]	sFilename	Name of image file
[in]	vHotspot	Hotspot of cursor

PLGUI_API EMouseCursor PLGui::Cursor::GetCursorID

(

)

const

Get cursor ID.

Returns:

Cursor ID or CursorCustom, if no standard cursor is used

PLGUI_API PLCore::String PLGui::Cursor::GetFilename

(

)

const

Get cursor filename.

Returns:

Cursor filename

---

Member Data Documentation

Gui* PLGui::Cursor::m_pGui [protected]

Pointer to GUI

CursorImpl* PLGui::Cursor::m_pCursorImpl [protected]

Cursor implementation

EMouseCursor PLGui::Cursor::m_nMouseCursor [protected]

Cursor ID (CustomCursor if a custom image has been loaded)

PLCore::String PLGui::Cursor::m_sFilename [protected]

Image filename

---

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

• Cursor.h