File: mouse.h

package info (click to toggle)
clanlib 0.5.4-1-6
  • links: PTS
  • area: main
  • in suites: woody
  • size: 10,320 kB
  • ctags: 10,893
  • sloc: cpp: 76,056; xml: 3,281; sh: 2,961; perl: 1,204; asm: 837; makefile: 775
file content (70 lines) | stat: -rw-r--r-- 1,955 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*
	$Id: mouse.h,v 1.7 2001/09/22 15:52:12 plasmoid Exp $

	------------------------------------------------------------------------
	ClanLib, the platform independent game SDK.

	This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
	version 2. See COPYING for details.

	For a total list of contributers see CREDITS.

	See http://www.clanlib.org
	------------------------------------------------------------------------
*/

//! clanDisplay="Input"
//! header=display.h

#ifndef header_mouse
#define header_mouse

#include "inputdevice.h"
#include "key.h"
#include "../../signals.h"

//: Mouse interface in ClanLib.
//- <p>CL_Mouse extends the CL_InputDevice with functionality only useful
//- to mice.</p>
class CL_Mouse : public CL_InputDevice
{
public:
//! Construction:
	//: Mouse Destructor
	virtual ~CL_Mouse() { return; }

//! Attributes:
	//- <p>Returns - Returns the x position of the mouse in range from
	//- [ 0 - CL_Display::get_height() ]. </p>
	static int get_x(); 

	//- <p>Returns - Returns the y position of the mouse in range from
	//- [ 0 - CL_Display::get_height() ]. </p>
	static int get_y();

	//- <p>Returns - Returns true if the left mouse button is pressed,
	//- else false is returned.</p>
	static bool left_pressed();

	//- <p>Returns - Returns true if the middle mouse button is pressed,
	//- else false is returned.</p>
	static bool middle_pressed();

	//- <p>Returns - Returns true if the right mouse button is pressed,
	//- else false is returned.</p>
	static bool right_pressed();

//! Signals:
	//: Signal signaled upon mouse move.
	static CL_Signal_v2<int, int> sig_move;

	//: Signal signaled upon button press.
	//: The CL_Key contains coordinates as well as button code.
	static CL_Signal_v1<const CL_Key &> sig_button_press;

	//: Signal signaled upon button release.
	//: The CL_Key contains coordinates as well as button code.
	static CL_Signal_v1<const CL_Key &> sig_button_release;
};

#endif