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