KeyInterface.hh 6.85 KB
 Jan Möbius committed Aug 05, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper *  Jan Möbius committed Jan 26, 2011 4 * Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen *  Jan Möbius committed Nov 25, 2010 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 * www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * *  Jan Möbius committed Aug 05, 2009 33 34 35 \*===========================================================================*/ /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 36 37 38 39 40 * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * *  Jan Möbius committed Aug 05, 2009 41 \*===========================================================================*/  Jan Möbius committed Aug 29, 2008 42 43 44 45 46 47 48  #ifndef KEYINTERFACE_HH #define KEYINTERFACE_HH #include  Jan Möbius committed Mar 15, 2011 49 50 51 52 53 54 55 56 57 58 59 60 61 62  /** \file KeyInterface.hh * * Interface for receiving keyboard events inside your plugin.\ref keyInterfacePage */ /** \brief Keyboard Event Interface * * \ref keyInterfacePage "Detailed description" * \n * * Using this interface you can react on key events. */  Jan Möbius committed Aug 29, 2008 63 class KeyInterface {  Dirk Wilden committed Sep 17, 2008 64 65 66 67 68 69 70 71  signals: /** \brief Register a key-combination for your plugin * * To obtain key events from the viewer for a certain key-combination, you have * to register that combination first * * @param _key the key that should be registered * @param _modifiers the keyboard modifiers  Jan Möbius committed Mar 15, 2011 72 73  * @param _description a short description about the functionality (Will be used in the Options Widget) * @param _multiUse can the key additionally be registered by another plugin (You could make a key exclusive by this)  Dirk Wilden committed Sep 17, 2008 74  */  Jan Möbius committed Mar 15, 2011 75  virtual void registerKey(int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse = false) {};  Dirk Wilden committed Sep 17, 2008 76 77  public slots :  Jan Möbius committed Aug 29, 2008 78 79 80  /** \brief Key Event from Main App *  Jan Möbius committed Mar 15, 2011 81 82  * This slot is called if a key event occurred in the Viewer * @param _event Key event  Jan Möbius committed Aug 29, 2008 83  */  Jan Möbius committed Mar 15, 2011 84  virtual void slotKeyEvent( QKeyEvent* _event ) {};  Jan Möbius committed Aug 29, 2008 85 86 87  /** \brief Key Release Event from Main App *  Jan Möbius committed Mar 15, 2011 88 89  * This slot is called if a key release event occurred in the Viewer * @param _event Key event  Jan Möbius committed Aug 29, 2008 90  */  Jan Möbius committed Mar 15, 2011 91  virtual void slotKeyReleaseEvent( QKeyEvent* _event ) {};  Jan Möbius committed Aug 29, 2008 92 93 94 95 96 97 98 99  public : /// Destructor virtual ~KeyInterface() {}; };  Jan Möbius committed Mar 15, 2011 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171  /** \page keyInterfacePage Key Interface \image html keyInterface.png \n Using this interface you can react on key events. You first have to register a key (or key combination) with KeyInterface::registerKey(). Note that the log widget will contain a warning if you register a key twice or it is occupied by another plugin. For each registered key your KeyInterface::slotKeyEvent() will be triggered when the key was pressed and the slot KeyInterface::slotKeyReleaseEvent() when the key was released. Both slots get the QKeyEvent and will contain all the modifiers that were active when the event occurred. In OpenFlippers options tab you can view all registered keys and reassign them. The events will be mapped, such that the plugins still receive the right combination. Therefore the mapping will be completely invisible to them. See our tutorial \ref ex3 for an example of how to use mouse and keyboard events within a plugin. To use the KeyInterface:
\code // In your plugin initialization register the keys you want to get. void ExamplePlugin::initializePlugin() { // Register keys emit registerKey(Qt::Key_W, Qt::NoModifier, "Rotate object down"); emit registerKey(Qt::Key_A, Qt::NoModifier, "Rotate object left"); emit registerKey(Qt::Key_D, Qt::NoModifier, "Rotate object right"); emit registerKey(Qt::Key_S, Qt::NoModifier, "Rotate object up"); } // Called when one of the registered Keys is pressed. void MouseAndKeyPlugin::slotKeyEvent( QKeyEvent* _event ) { // Check if it's really the right key if ( _event->modifiers() == Qt::NoModifier ) { // Switch pressed keys switch (_event->key()) { case Qt::Key_W: // Move forward break; case Qt::Key_A: // Move left break; case Qt::Key_D: // Move right break; case Qt::Key_S: // Move backward break; default: break; } } } \endcode */  Dirk Wilden committed Sep 17, 2008 172 Q_DECLARE_INTERFACE(KeyInterface,"OpenFlipper.KeyInterface/1.1")  Jan Möbius committed Aug 29, 2008 173 174  #endif // KEYINTERFACE_HH