focushandler.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  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
 *  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, see <http://www.gnu.org/licenses/>.
 */
 
/*      _______   __   __   __   ______   __   __   _______   __   __
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
 *
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
 *
 *
 * Per Larsson a.k.a finalman
 * Olof Naessén a.k.a jansem/yakslem
 *
 * Visit: http://guichan.sourceforge.net
 *
 * License: (BSD)
 * 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 Guichan 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 THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
 * OWNER OR 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 GUI_FOCUSHANDLER_H
#define GUI_FOCUSHANDLER_H
 
#include "utils/vector.h"
 
#include <list>
 
#include "localconsts.h"
 
class Event;
class Widget;
 
class FocusHandler final
{
    public:
        FocusHandler();
 
        A_DELETE_COPY(FocusHandler)
 
        
        void requestFocus(const Widget *const widget);
 
        void requestModalFocus(Widget *const widget);
 
        void requestModalMouseInputFocus(Widget *const widget);
 
        void releaseModalFocus(Widget *const widget);
 
        void releaseModalMouseInputFocus(const Widget *const widget);
 
        bool isFocused(const Widget *const widget) const;
 
        Widget* getFocused() const A_WARN_UNUSED;
 
        Widget* getModalFocused() const A_WARN_UNUSED;
 
        Widget* getModalMouseInputFocused() const A_WARN_UNUSED;
 
        void focusNext();
 
        void focusPrevious();
 
        void add(Widget *const widget);
 
        void remove(Widget *const widget);
 
        void focusNone();
 
        void tabNext();
 
        void tabPrevious();
 
        Widget* getDraggedWidget() const A_WARN_UNUSED;
 
        void setDraggedWidget(Widget *const draggedWidget);
 
        Widget* getLastWidgetWithMouse() const A_WARN_UNUSED;
 
        void setLastWidgetWithMouse(Widget *const lastWidgetWithMouse);
 
        Widget* getLastWidgetWithModalFocus() const A_WARN_UNUSED;
 
        void setLastWidgetWithModalFocus(Widget *const widget);
 
        Widget* getLastWidgetWithModalMouseInputFocus() const A_WARN_UNUSED;
 
        void setLastWidgetWithModalMouseInputFocus(Widget *const widget);
 
        Widget* getLastWidgetPressed() const A_WARN_UNUSED;
 
        void setLastWidgetPressed(Widget *const lastWidgetPressed);
 
    private:
        void checkForWindow() const;
 
        static void distributeFocusLostEvent(const Event& focusEvent);
 
        static void distributeFocusGainedEvent(const Event& focusEvent);
 
        typedef STD_VECTOR<Widget*> WidgetVector;
 
        typedef WidgetVector::iterator WidgetIterator;
 
        WidgetVector mWidgets;
 
        Widget* mFocusedWidget;
 
        Widget* mModalFocusedWidget;
 
        Widget* mModalMouseInputFocusedWidget;
 
        Widget* mDraggedWidget;
 
        Widget* mLastWidgetWithMouse;
 
        Widget* mLastWidgetWithModalFocus;
 
        Widget* mLastWidgetWithModalMouseInputFocus;
 
        Widget* mLastWidgetPressed;
 
        std::list<Widget*> mModalStack;
};
 
#endif  // GUI_FOCUSHANDLER_H