Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: 5f72aa1141c3f13dd4fc56b42ed1ab7c5ed874e3 (plain)
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
71
72
73
74
/*
   client/control.h
   This file is part of the Osirion project and is distributed under
   the terms and conditions of the GNU General Public License version 2
*/

#ifndef __INCLUDED_CLIENT_CONTROL_H__
#define __INCLUDED_CLIENT_CONTROL_H__

#include <string>

namespace client
{

/** 
 * @brief a client key control.
 * A Control maps commands to key names
 */
class Control
{
public:
	Control(const char *name, const char *command, const char * keyname = 0);
	~Control();

	/**
	 * @brief name of this control
	 * */
	inline const std::string &name() const
	{
		return _name;
	}

	/**
	 * @brief the command executed by this control
	 */ 
	inline const std::string &command() const
	{
		return _command;
	}
	
	/**
	 * @brief the currently assigned to this control.
	 * */
	inline const std::string &keyname() const
	{
		return _keyname;
	}
	
	/**
	 * @brief the default key assigned to this control.
	 * */
	inline const std::string &defaultkeyname() const
	{
		return _defaultkeyname;
	}
	
	/**
	 * @brief assign a key to this control
	 * */
	inline void set_keyname(const std::string &keyname)
	{
		_keyname.assign(keyname);
	}
	
private:
	std::string _name;
	std::string _command;
	std::string _keyname;
	std::string _defaultkeyname;
};

} // namespace client

#endif // __INCLUDED_CLIENT_CONTROL_H__