/*****************************************************************************
 * evt_input.hpp
 *****************************************************************************
 * Copyright (C) 2003 the VideoLAN team
 * $Id: 2ae83d61515617ade4b24bd53e5ca2c0ff9ca15c $
 *
 * Authors: Cyril Deguet     <asmax@via.ecp.fr>
 *          Olivier Teulière <ipkiss@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#ifndef EVT_INPUT_HPP
#define EVT_INPUT_HPP

#include "evt_generic.hpp"

/// Base class for mouse and key events
class EvtInput: public EvtGeneric
{
public:
    virtual ~EvtInput() { }

    /// Masks for modifier keys
    static const int
        kModNone, kModAlt, kModShift, kModCtrl, kModMeta, kModCmd;

    /// Get the modifiers
    int getMod() const { return m_mod; }

protected:
    EvtInput( intf_thread_t *pIntf, int mod = kModNone );

    /// Add the modifier to the event string
    void addModifier( string &rEvtString ) const;

private:
    /// Modifiers (special key(s) pressed during the mouse event)
    int m_mod;
};

#endif
