---

CL_MouseCursorProvider Class Reference

#include <mousecursor_provider.h>

Inheritance diagram for CL_MouseCursorProvider:

[legend]List of all members.

Public Methods
virtual	~CL_MouseCursorProvider ()
	param: resource_id - Resource ID of the mouse cursor.param: manager - Resource manager where the cursor is loaded from.
virtual CL_SurfaceProvider*	get_surface_provider ()=0
virtual bool	is_animated ()=0
virtual int	get_frame_delay (unsigned int frame_number)=0
Static Public Methods
CL_MouseCursorProvider*	create (CL_SurfaceProvider *provider, bool delete_provider=true, bool animate=true, const std::vector< int > *frame_delays=NULL)
CL_MouseCursorProvider*	load (const char *resource_id, CL_ResourceManager *manager)
	param: provider - Image of the cursor.param: delete_provider - If true, the surface provider will beparam: deleted together with the cursor provider.param: animate - If true, the subframes in the surface provider willparam: be used to animate the cursor.param: frame_delays - A list of millis to wait between each frame,param: when animating the cursor.

---

Constructor & Destructor Documentation

CL_MouseCursorProvider::~CL_MouseCursorProvider ( ) [inline, virtual]

param: resource_id - Resource ID of the mouse cursor.param: manager - Resource manager where the cursor is loaded from. Definition at line 56 of file mousecursor_provider.h.

---

Member Function Documentation

CL_MouseCursorProvider* CL_MouseCursorProvider::create ( CL_SurfaceProvider * provider, bool delete_provider = true, bool animate = true, const std::vector< int > * frame_delays = NULL ) [static]

virtual int CL_MouseCursorProvider::get_frame_delay ( unsigned int frame_number ) [pure virtual]

Reimplemented in CL_MouseCursorProvider_Generic.

virtual CL_SurfaceProvider* CL_MouseCursorProvider::get_surface_provider ( ) [pure virtual]

Reimplemented in CL_MouseCursorProvider_Generic.

virtual bool CL_MouseCursorProvider::is_animated ( ) [pure virtual]

Reimplemented in CL_MouseCursorProvider_Generic.

CL_MouseCursorProvider* CL_MouseCursorProvider::load ( const char * resource_id, CL_ResourceManager * manager ) [static]

param: provider - Image of the cursor.param: delete_provider - If true, the surface provider will beparam: deleted together with the cursor provider.param: animate - If true, the subframes in the surface provider willparam: be used to animate the cursor.param: frame_delays - A list of millis to wait between each frame,param: when animating the cursor.

---

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

• mousecursor_provider.h

---