/*
 * Copyright (C) 2007 Pleyo.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Pleyo nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY PLEYO AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL PLEYO OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef BIINPUTEVENT_H_
#define BIINPUTEVENT_H_

#include "kjs/wk_config.h"
#include "BIEvent.h"

namespace BAL {

    class BIWindowEvent;
    class BIInputEvent;
    class BIKeyboardEvent;
    class BIMouseEvent;
    class BIWheelEvent;
    
    /**
    * @brief the BIInputEvent
    *
    * The input event, base class of three interfaces, for
    * keyboard, mouse and wheel.
    * 
    * @see BIEvent, BIEventLoop, BIKeyboardEvent, BIMouseEvent, BIWheelEvent
    */
    class BIInputEvent : public BIEvent {
        public:
        // this is mandatory
            /**
            * BIInputEvent destructor
            */
            virtual ~BIInputEvent() {};

            /**
            * clone a BIInputEvent
            */
            virtual BIEvent* clone() const = 0;
            
            /**
            * get the InputEvent
            */
            virtual BIInputEvent* queryIsInputEvent() { return this; };
    
            /**
            * test if the shift is pressed
            */
            virtual bool shiftKey() const = 0;
            /**
            * test if the ctrl is pressed
            */
            virtual bool ctrlKey() const = 0;
            /**
            * test if the alt is pressed
            */
            virtual bool altKey() const = 0;
            /**
            * test if a metaKey is pressed
            */
            virtual bool metaKey() const = 0;
   };
}

#endif // BIINPUTEVENT_H
