KeyInterface.hh 5.04 KB
 Jan Möbius committed Aug 05, 2009 1 2 3 /*===========================================================================*\ * * * OpenFlipper *  Jan Möbius committed Jun 17, 2010 4  * Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen *  Jan Möbius committed Aug 05, 2009 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  * 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 . * * * \*===========================================================================*/ /*===========================================================================*\ * * * $Revision$ * * $Author$ * * $Date$ * * * \*===========================================================================*/  Jan Möbius committed Aug 29, 2008 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62  // // C++ Interface: Basic Interface for keyboard events received from the examiner widget // // Description: // // // Author: Jan Moebius , (C) 2007 #ifndef KEYINTERFACE_HH #define KEYINTERFACE_HH #include /** \brief Interface class for plugins which have to react on keyboard events *  Dirk Wilden committed Sep 17, 2008 63 64 65 66  * Using this interface you can react on key events. You first have to register * a key (or key combination). For each registered key you will receive a keyEvent when * the key was pressed and a keyReleaseEvent when the key was released. *  Mike Kremer committed Mar 26, 2009 67 68 69  * See our tutorial \ref ex3 for an example of how to use mouse and keyboard events * within a plugin. *  Dirk Wilden committed Sep 17, 2008 70  */  Jan Möbius committed Aug 29, 2008 71 class KeyInterface {  Dirk Wilden committed Sep 17, 2008 72 73 74 75 76 77 78 79 80  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 * @param _description a short description about the functionality  Dirk Wilden committed Sep 17, 2008 81  * @param _multiUse can the key additionally be registered by another plugin  Dirk Wilden committed Sep 17, 2008 82  */  Dirk Wilden committed Sep 30, 2008 83  virtual void registerKey(int /*_key*/, Qt::KeyboardModifiers /*_modifiers*/, QString /*_description*/, bool /*_multiUse*/ = false) {};  Dirk Wilden committed Sep 17, 2008 84 85  public slots :  Jan Möbius committed Aug 29, 2008 86 87 88 89 90 91  /** \brief Key Event from Main App * * This slot is called if a key event occured in the Viewer * @param _event Keyevent */  Dirk Wilden committed Sep 30, 2008 92  virtual void slotKeyEvent( QKeyEvent* /*_event*/ ) {};  Jan Möbius committed Aug 29, 2008 93 94 95 96 97 98  /** \brief Key Release Event from Main App * * This slot is called if a key release event occured in the Viewer * @param _event Keyevent */  Dirk Wilden committed Sep 30, 2008 99  virtual void slotKeyReleaseEvent( QKeyEvent* /*_event*/ ) {};  Jan Möbius committed Aug 29, 2008 100 101 102 103 104 105 106 107  public : /// Destructor virtual ~KeyInterface() {}; };  Dirk Wilden committed Sep 17, 2008 108 Q_DECLARE_INTERFACE(KeyInterface,"OpenFlipper.KeyInterface/1.1")  Jan Möbius committed Aug 29, 2008 109 110  #endif // KEYINTERFACE_HH