path: root/src/gui/gui.h

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana 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/>.
 */

#ifndef GUI_H
#define GUI_H

#include "guichanfwd.h"

#include <guichan/gui.hpp>

class TextInput;
class Graphics;
class GuiConfigListener;
class ImageSet;
class SDLInput;

/**
 * \defgroup GUI Core GUI related classes (widgets)
 */

/**
 * \defgroup Interface User interface related classes (windows, dialogs)
 */

/**
 * Cursors are in graphic order from left to right.
 * CURSOR_POINTER should be left untouched.
 */
enum class Cursor {
    POINTER = 0,
    RESIZE_ACROSS,
    RESIZE_DOWN,
    RESIZE_DOWN_LEFT,
    RESIZE_DOWN_RIGHT,
    FIGHT,
    PICKUP,
    TALK,
    ACTION,
    LEFT,
    UP,
    RIGHT,
    DOWN,
};

/**
 * Main GUI class.
 *
 * \ingroup GUI
 */
class Gui : public gcn::Gui
{
    public:
        Gui(Graphics *screen);

        ~Gui() override;

        /**
         * Performs logic of the GUI. Overridden to track mouse pointer
         * activity.
         */
        void logic() override;

        /**
         * Draws the whole Gui by calling draw functions down in the
         * Gui hierarchy. It also draws the mouse pointer.
         */
        void draw() override;

        /**
         * Called when the application window has been resized.
         *
         * Returns whether the top widget changed size.
         */
        bool videoResized(int width, int height);

        gcn::FocusHandler *getFocusHandler() const
        { return mFocusHandler; }

        /**
         * Return game font.
         */
        gcn::Font *getFont() const
        { return mGuiFont; }

        /**
         * Return the Font used for "Info Particles", i.e. ones showing, what
         * you picked up, etc.
         */
        gcn::Font *getInfoParticleFont() const
        { return mInfoParticleFont; }

        /**
         * Sets whether a custom cursor should be rendered.
         */
        void setUseCustomCursor(bool customCursor);

        /**
         * Sets which cursor should be used.
         */
        void setCursorType(Cursor index)
        { mCursorType = index; }

    protected:
        void handleMouseMoved(const gcn::MouseInput &mouseInput) override;
        void handleTextInput(const TextInput &textInput);

    private:
        GuiConfigListener *mConfigListener;
        gcn::Font *mGuiFont;                  /**< The global GUI font */
        gcn::Font *mInfoParticleFont;         /**< Font for Info Particles*/
        bool mCustomCursor = false;           /**< Show custom cursor */
        ImageSet *mMouseCursors = nullptr;    /**< Mouse cursor images */
        float mMouseCursorAlpha = 1.0f;
        int mMouseInactivityTimer = 0;
        Cursor mCursorType = Cursor::POINTER;
};

extern Gui *gui;                              /**< The GUI system */
extern SDLInput *guiInput;                    /**< GUI input */

/**
 * Bolded text font
 */
extern gcn::Font *boldFont;

/**
 * Monospaced text font
 */
extern gcn::Font *monoFont;

#endif // GUI_H