74c379e76a8fa4b66198ec08de76eaafdbb3f1c3
[blender.git] / intern / ghost / intern / GHOST_EventPrinter.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/intern/GHOST_EventPrinter.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_EventPrinter class.
32  */
33
34 #ifndef _GHOST_EVENT_PRINTER_H_
35 #define _GHOST_EVENT_PRINTER_H_
36
37 #include "GHOST_IEventConsumer.h"
38
39 #include "STR_String.h"
40
41 /**
42  * An Event consumer that prints all the events to standard out.
43  * Really useful when debugging.
44  */
45 class GHOST_EventPrinter : public GHOST_IEventConsumer
46 {
47 public:
48         /**
49          * Prints all the events received to std out.
50          * @param event The event that can be handled or not.
51          * @return Indication as to whether the event was handled.
52          */
53         virtual bool processEvent(GHOST_IEvent* event);
54
55 protected:
56         /**
57          * Converts GHOST key code to a readable string.
58          * @param key The GHOST key code to convert.
59          * @param str The GHOST key code converted to a readable string.
60          */
61         void    getKeyString(GHOST_TKey key, STR_String& str) const;
62 };
63
64 #endif // _GHOST_EVENT_PRINTER_H_
65