git.sesse.net Git - vlc/blob - modules/gui/skins2/events/evt_key.hpp

   1 /*****************************************************************************
   2  * evt_key.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef EVT_KEY_HPP
  26 #define EVT_KEY_HPP
  27
  28 #include "evt_input.hpp"
  29
  30
  31 /// Class for keyboard events
  32 class EvtKey: public EvtInput
  33 {
  34     public:
  35         enum ActionType_t
  36         {
  37             kDown,
  38             kUp
  39         };
  40
  41         EvtKey( intf_thread_t *pIntf, int key, ActionType_t action,
  42                 int mod = kModNone ):
  43             EvtInput( pIntf, mod ), m_key( key ), m_action( action ) {}
  44         virtual ~EvtKey() {}
  45
  46         /// Return the type of event
  47         virtual const string getAsString() const;
  48
  49         int getKey() const { return m_key; }
  50
  51     private:
  52         /// The concerned key, stored according to the '#define's in vlc_keys.h
  53         /// but without the modifiers (which are stored in EvtInput)
  54         int m_key;
  55         /// Type of action
  56         ActionType_t m_action;
  57 };
  58
  59
  60 #endif