WndEvent.h

Go to the documentation of this file.

// -*- C++ -*-
/* GG is a GUI for SDL and OpenGL.
   Copyright (C) 2003 T. Zachary Laine

   This library 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 2.1
   of the License, or (at your option) any later version.
   
   This library 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 Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA

   If you do not wish to comply with the terms of the LGPL please
   contact the author as other terms are available for a fee.
    
   Zach Laine
   whatwasthataddress@hotmail.com */

#ifndef _GG_WndEvent_h_
#define _GG_WndEvent_h_

#include <GG/Base.h>
#include <GG/Exception.h>
#include <GG/Flags.h>

#include <map>


namespace GG {

class Timer;
class Wnd;

// Adpated from SDLKey enum in SDL_keysym.h of the SDL library.
GG_FLAG_TYPE(ModKey);
extern GG_API const ModKey MOD_KEY_NONE;         
extern GG_API const ModKey MOD_KEY_LSHIFT;       
extern GG_API const ModKey MOD_KEY_RSHIFT;       
extern GG_API const ModKey MOD_KEY_LCTRL;        
extern GG_API const ModKey MOD_KEY_RCTRL;        
extern GG_API const ModKey MOD_KEY_LALT;         
extern GG_API const ModKey MOD_KEY_RALT;         
extern GG_API const ModKey MOD_KEY_LMETA;        
extern GG_API const ModKey MOD_KEY_RMETA;        
extern GG_API const ModKey MOD_KEY_NUM;          
extern GG_API const ModKey MOD_KEY_CAPS;         
extern GG_API const ModKey MOD_KEY_MODE;         
extern GG_API const Flags<ModKey> MOD_KEY_CTRL;  
extern GG_API const Flags<ModKey> MOD_KEY_SHIFT; 
extern GG_API const Flags<ModKey> MOD_KEY_ALT;   
extern GG_API const Flags<ModKey> MOD_KEY_META;  

class GG_API WndEvent
{
public:
    enum EventType {
        LButtonDown,
        LDrag,
        LButtonUp,
        LClick,
        LDoubleClick,
        MButtonDown,
        MDrag,
        MButtonUp,
        MClick,
        MDoubleClick,
        RButtonDown,
        RDrag,
        RButtonUp,
        RClick,
        RDoubleClick,
        MouseEnter,
        MouseHere,
        MouseLeave,
        MouseWheel,
        DragDropEnter,
        DragDropHere,
        DragDropLeave,
        KeyPress,
        KeyRelease,
        GainingFocus,
        LosingFocus,
        TimerFiring
    };

    WndEvent(EventType type, const Pt& pt, Flags<ModKey> mod_keys);

    WndEvent(EventType type, const Pt& pt, const Pt& move, Flags<ModKey> mod_keys);

    WndEvent(EventType type, const Pt& pt, int move, Flags<ModKey> mod_keys);

    WndEvent(EventType type, const Pt& pt, const std::map<Wnd*, Pt>& drag_drop_wnds, Flags<ModKey> mod_keys);

    WndEvent(EventType type, Key key, Flags<ModKey> mod_keys);

    WndEvent(EventType type, int ticks, Timer* timer);

    explicit WndEvent(EventType type);

    EventType                 Type() const;         
    const Pt&                 Point() const;        
    Key                       GetKey() const;       
    Flags<ModKey>             ModKeys() const;      
    const Pt&                 DragMove() const;     
    int                       WheelMove() const;    
    const std::map<Wnd*, Pt>& DragDropWnds() const; 
    int                       Ticks() const;        
    Timer*                    GetTimer() const;     

private:
    EventType          m_type;
    Pt                 m_point;
    Key                m_key;
    Flags<ModKey>      m_mod_keys;
    Pt                 m_drag_move;
    int                m_wheel_move;
    std::map<Wnd*, Pt> m_drag_drop_wnds;
    int                m_ticks;
    Timer*             m_timer;
};

} // namespace GG

#endif

---