Public API Reference

                 

---

csMouse Class Reference
[Crystal Space Windowing System]

This class handles mouse pointer and generates mouse events. More...

#include <csmouse.h>

List of all members.

Public Methods
bool	HandleEvent (iEvent &Event)
	Handle a event and return true if processed. More...
void	Move (int x, int y)
	Set mouse cursor position. More...
void	Show ()
	Increment mouse pointer visibility counter. More...
void	Hide ()
	Decrement mouse visibility counter. More...
bool	SetCursor (csMouseCursorID ID)
	Set cursor by ID number; returns false if no cursor with this ID found. More...
void	Setup ()
	Called by csApp when textures has been loaded. More...
void	SetVirtualPosition (int x, int y)
	Set "virtual" mouse position, i.e. show cursor at a different location. More...
Friends
class	csMousePointer
class	csApp
class	csGraphicsPipeline

---

Detailed Description

This class handles mouse pointer and generates mouse events.

Usually there is only one object of this class in each csApp object.

Definition at line 67 of file csmouse.h.

---

Member Function Documentation

bool csMouse::HandleEvent (  iEvent &    Event )

Handle a event and return true if processed.

void csMouse::Hide (    )  [inline]

Decrement mouse visibility counter. Definition at line 118 of file csmouse.h.

void csMouse::Move (  int    x, int    y )

Set mouse cursor position.

bool csMouse::SetCursor (  csMouseCursorID    ID )

Set cursor by ID number; returns false if no cursor with this ID found.

void csMouse::Setup (    )

Called by csApp when textures has been loaded.

void csMouse::SetVirtualPosition (  int    x, int    y )  [inline]

Set "virtual" mouse position, i.e. show cursor at a different location. Definition at line 128 of file csmouse.h.

void csMouse::Show (    )  [inline]

Increment mouse pointer visibility counter. When counter == 0, mouse is visible. Definition at line 114 of file csmouse.h.

---

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

• csmouse.h

---