imouselistener.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_EVENTCHANNEL_IMOUSELISTENER_H
#define FIFE_EVENTCHANNEL_IMOUSELISTENER_H

// Standard C++ library includes
//

// 3rd party library includes
//

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "eventchannel/base/ilistener.h"

namespace FIFE {

    class MouseEvent;

    class IMouseListener : public IListener {
    public:
        virtual void mouseEntered(MouseEvent& evt) = 0;

        virtual void mouseExited(MouseEvent& evt) = 0;

        virtual void mousePressed(MouseEvent& evt) = 0;

        virtual void mouseReleased(MouseEvent& evt) = 0;

        virtual void mouseClicked(MouseEvent& evt) = 0;

        virtual void mouseWheelMovedUp(MouseEvent& evt) = 0;

        virtual void mouseWheelMovedDown(MouseEvent& evt) = 0;

        virtual void mouseWheelMovedRight(MouseEvent& evt) = 0;

        virtual void mouseWheelMovedLeft(MouseEvent& evt) = 0;

        virtual void mouseMoved(MouseEvent& evt) = 0;

        virtual void mouseDragged(MouseEvent& evt) = 0;

        virtual bool isGlobalListener() const { return m_global; }

        virtual void setGlobalListener(bool global) { m_global = global; }

        virtual ~IMouseListener() {}

    protected:
        IMouseListener() { m_global = false; }

    private:
        bool m_global;
    };

} //FIFE

#endif