browserbox.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *  Copyright (C) 2009  Aethyra Development Team
 *
 *  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/>.
 */
 
#pragma once
 
#include "utils/time.h"
 
#include <guichan/mouselistener.hpp>
#include <guichan/widget.hpp>
 
#include <deque>
#include <optional>
#include <vector>
 
class LinkHandler;
struct LayoutContext;
 
struct BrowserLink
{
    gcn::Rectangle rect;    
    std::string link;
    std::string caption;
 
    bool contains(int x, int y) const
    {
        return rect.isPointInRect(x, y);
    }
};
 
struct LinePart
{
    int x;
    int y;
    gcn::Color color;
    std::optional<gcn::Color> outlineColor;
    std::string text;
    gcn::Font *font;
};
 
struct TextRow
{
    std::string text;
    std::vector<LinePart> parts;
    std::vector<BrowserLink> links;
    int width = 0;
    int height = 0;
};
 
class BrowserBox : public gcn::Widget,
                   public gcn::MouseListener
{
    public:
        enum Mode
        {
            AUTO_SIZE,
            AUTO_WRAP       
        };
 
        BrowserBox(Mode mode = AUTO_SIZE);
        ~BrowserBox() override;
 
        void setLinkHandler(LinkHandler *handler) { mLinkHandler = handler; }
 
        void setPalette(int palette) { mPalette = palette; }
 
        void setHighlightMode(unsigned int mode) { mHighlightMode = mode; }
 
        void setWrapIndent(int indent) { mWrapIndent = indent; }
 
        void setShadowedText(bool shadows) { mShadows = shadows; }
 
        void setOutlinedText(bool outline) { mOutline = outline; }
 
        void setMaxRows(unsigned maxRows) { mMaxRows = maxRows; }
 
        void disableLinksAndUserColors() { mUseLinksAndUserColors = false; }
 
        void setEnableKeys(bool enable) { mEnableKeys = enable; }
 
        void addRows(std::string_view rows);
 
        void addRow(std::string_view row);
 
        void clearRows();
 
        void mousePressed(gcn::MouseEvent &event) override;
        void mouseMoved(gcn::MouseEvent &event) override;
        void mouseExited(gcn::MouseEvent &event) override;
 
        void draw(gcn::Graphics *graphics) override;
 
        void drawFrame(gcn::Graphics *) override {}
 
        enum LinkHighlightMode
        {
            UNDERLINE  = 1,
            BACKGROUND = 2
        };
 
    private:
        void relayoutText();
        void layoutTextRow(TextRow &row, LayoutContext &context);
        void updateHoveredLink(int x, int y);
        void maybeRelayoutText();
 
        std::deque<TextRow> mTextRows;
 
        LinkHandler *mLinkHandler = nullptr;
        int mPalette = 0;
        Mode mMode;
        unsigned int mHighlightMode = UNDERLINE | BACKGROUND;
        int mWrapIndent = 0;
        bool mShadows = false;
        bool mOutline = false;
        bool mUseLinksAndUserColors = true;
        bool mEnableKeys = false;
        std::optional<BrowserLink> mHoveredLink;
        unsigned int mMaxRows = 0;
        int mLastLayoutWidth = 0;
        Timer mLayoutTimer;
};