MouseManager Class Reference

#include <mouseman.h>

Inheritance diagram for MouseManager:

Public Member Functions
CoreExport	MouseManager ()
CoreExport	~MouseManager ()
CoreExport int	SetMouseProc (MouseCallBack *mproc, int button, int nPoints=2)
CoreExport int	SetDragMode (int mode)
CoreExport int	GetDragMode ()
CoreExport int	SetNumPoints (int nPoints, int button)
CoreExport int	ButtonFlags ()
CoreExport void	Pan (IPoint2 p)
CoreExport LRESULT CALLBACK	MouseWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
CoreExport void	Reset ()
int	GetMouseMode ()
UINT	GetMouseMsg ()
int	GetMousePoint ()
CoreExport void	SetCapture (HWND hWnd)
CoreExport HWND	HasCapture ()
CoreExport void	ReleaseCapture ()
CoreExport void	RestoreCapture ()
CoreExport void	SetMouseWindProcCallback (WNDPROC pMouseWindProc)
WNDPROC	GetMouseWindProcCallback () const
CoreExport MouseCallBack *	GetMouseProc (int button)
	To get a mouse callback when the button index was indicated by SetMouseProc function. More...
Public Member Functions inherited from BaseInterfaceServer
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport int	NumInterfaces () const
virtual UtilExport BaseInterface *	GetInterfaceAt (int i) const
virtual UtilExport	~BaseInterfaceServer ()
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Friends
class	MouseManagerStateInterface
class	MouseOverride

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
Protected Attributes inherited from BaseInterfaceServer
Tab< BaseInterface * >	interfaces

Detailed Description

Represents the interface to the mouse manager and handling system and is used internally only. This class should not be instanced directly into plugin code. To retrieve a pointer to the mouse manager you can use the method Interface::GetMouseManager().

See also

BaseInterfaceServer, MouseCallBack, Interface

Constructor & Destructor Documentation

MouseManager()

CoreExport MouseManager

(

)

~MouseManager()

CoreExport ~MouseManager

(

)

Member Function Documentation

SetMouseProc()

CoreExport int SetMouseProc	(	MouseCallBack *	mproc,
		int	button,
		int	nPoints = 2
	)

SetDragMode()

CoreExport int SetDragMode

(

int

mode

)

GetDragMode()

CoreExport int GetDragMode

(

)

SetNumPoints()

CoreExport int SetNumPoints	(	int	nPoints,
		int	button
	)

ButtonFlags()

CoreExport int ButtonFlags

(

)

Pan()

CoreExport void Pan

(

IPoint2

p

)

MouseWinProc()

CoreExport LRESULT CALLBACK MouseWinProc	(	HWND	hwnd,
		UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

Reset()

CoreExport void Reset

(

)

GetMouseMode()

int GetMouseMode ( )

inline

{return mouseMode;}

GetMouseMsg()

UINT GetMouseMsg ( )

inline

{return m_msg;}

GetMousePoint()

int GetMousePoint ( )

inline

{return curPoint;}

SetCapture()

CoreExport void SetCapture

(

HWND

hWnd

)

HasCapture()

CoreExport HWND HasCapture

(

)

ReleaseCapture()

CoreExport void ReleaseCapture

(

)

RestoreCapture()

CoreExport void RestoreCapture

(

)

SetMouseWindProcCallback()

CoreExport void SetMouseWindProcCallback ( WNDPROC  pMouseWindProc )

inline

        { mpMouseWindProc = pMouseWindProc; }

GetMouseWindProcCallback()

WNDPROC GetMouseWindProcCallback ( ) const

inline

        { return mpMouseWindProc; }

GetMouseProc()

CoreExport MouseCallBack* GetMouseProc

(

int

button

)

To get a mouse callback when the button index was indicated by SetMouseProc function.

Parameters

button

The button index maps one mouse button.

Returns

a mouse callback corresponding to the given button index. If an invalid button index is given, the corresponding mouse callback will be NULL.

Friends And Related Function Documentation

MouseManagerStateInterface

friend class MouseManagerStateInterface

friend

MouseOverride

friend class MouseOverride

friend