summaryrefslogtreecommitdiff
path: root/src/gui/widgets/browserbox.h
blob: 7278bb593dfc6b46e38c3973c8e7646daea1a5c3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*
 *  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/>.
 */

#ifndef BROWSERBOX_H
#define BROWSERBOX_H

#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;    /**< Where link is placed */
    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::string text;
    gcn::Font *font;
};

struct TextRow
{
    std::string text;
    std::vector<LinePart> parts;
    std::vector<BrowserLink> links;
    int width = 0;
    int height = 0;
};

/**
 * A simple browser box able to handle links and forward events to the
 * parent conteiner.
 */
class BrowserBox : public gcn::Widget,
                   public gcn::MouseListener
{
    public:
        enum Mode
        {
            AUTO_SIZE,
            AUTO_WRAP       /**< Maybe it needs a fix or to be redone. */
        };

        BrowserBox(Mode mode = AUTO_SIZE);
        ~BrowserBox() override;

        /**
         * Sets the handler for links.
         */
        void setLinkHandler(LinkHandler *handler) { mLinkHandler = handler; }

        /**
         * Sets the Highlight mode for links.
         */
        void setHighlightMode(unsigned int mode) { mHighlightMode = mode; }

        /**
         * Sets the wrap indent for the browser box.
         */
        void setWrapIndent(int indent) { mWrapIndent = indent; }

        /**
         * Sets whether the font will use a shadow for text.
         */
        void setShadowedText(bool shadows) { mShadows = shadows; }

        /**
         * Sets whether the font will use a shadow for text.
         */
        void setOutlinedText(bool outline) { mOutline = outline; }

        /**
         * Sets the maximum numbers of rows in the browser box. 0 = no limit.
         */
        void setMaxRows(unsigned maxRows) { mMaxRows = maxRows; }

        /**
         * Disable links & user defined colors to be used in chat input.
         */
        void disableLinksAndUserColors() { mUseLinksAndUserColors = false; }

        /**
         * Adds a text row to the browser.
         */
        void addRow(const std::string &row);

        /**
         * Remove all rows.
         */
        void clearRows();

        /**
         * Handles mouse actions.
         */
        void mousePressed(gcn::MouseEvent &event) override;
        void mouseMoved(gcn::MouseEvent &event) override;
        void mouseExited(gcn::MouseEvent &event) override;

        /**
         * Draws the browser box.
         */
        void draw(gcn::Graphics *graphics) override;

        /**
         * Overridden to avoid drawing the default frame.
         */
        void drawFrame(gcn::Graphics *) override {}

        /**
         * BrowserBox colors.
         *
         * NOTES (by Javila):
         *  - color values is "0x" prefix followed by HTML color style.
         *  - we can add up to 10 different colors: [0..9].
         *  - not all colors will be fine with all backgrounds due transparent
         *    windows and widgets. So, I think it's better keep BrowserBox
         *    opaque (white background) by default.
         */
        enum
        {
            RED = 0xff0000,         /**< Color 1 */
            GREEN = 0x009000,       /**< Color 2 */
            BLUE = 0x0000ff,        /**< Color 3 */
            ORANGE = 0xe0980e,      /**< Color 4 */
            YELLOW = 0xf1dc27,      /**< Color 5 */
            PINK = 0xff00d8,        /**< Color 6 */
            PURPLE = 0x8415e2,      /**< Color 7 */
            GRAY = 0x919191,        /**< Color 8 */
            BROWN = 0x8e4c17        /**< Color 9 */
        };

        /**
         * Highlight modes for links.
         * This can be used for a bitmask.
         */
        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;
        Mode mMode;
        unsigned int mHighlightMode = UNDERLINE | BACKGROUND;
        int mWrapIndent = 0;
        bool mShadows = false;
        bool mOutline = false;
        bool mUseLinksAndUserColors = true;
        std::optional<BrowserLink> mHoveredLink;
        unsigned int mMaxRows = 0;
        int mLastLayoutWidth = 0;
        Timer mLayoutTimer;
};

#endif