CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

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.

void Move (int x, int y)
 Set mouse cursor position.

void Show ()
 Increment mouse pointer visibility counter.

void Hide ()
 Decrement mouse visibility counter.

bool SetCursor (csMouseCursorID ID)
 Set cursor by ID number; returns false if no cursor with this ID found.

void Setup ()
 Called by csApp when textures has been loaded.

void SetVirtualPosition (int x, int y)
 Set "virtual" mouse position, i.e. show cursor at a different location.


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 69 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 120 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 130 of file csmouse.h.

void csMouse::Show   [inline]
 

Increment mouse pointer visibility counter.

When counter == 0, mouse is visible.

Definition at line 116 of file csmouse.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18