/*
* 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 .
*/
#ifndef BROWSERBOX_H
#define BROWSERBOX_H
#include
#include
#include
#include
#include
class LinkHandler;
struct LayoutContext;
struct BrowserLink
{
int x1 = 0, x2 = 0, y1 = 0, y2 = 0; /**< Where link is placed */
std::string link;
std::string caption;
bool contains(int x, int y) const
{
return x >= x1 && x < x2 && y >= y1 && y < y2;
}
};
struct LinePart
{
int x;
int y;
gcn::Color color;
std::string text;
};
struct TextRow
{
std::string text;
std::vector parts;
std::vector 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:
BrowserBox(unsigned int 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 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;
/**
* Draws the browser box.
*/
void draw(gcn::Graphics *graphics) override;
void maybeRelayoutText();
/**
* BrowserBox modes.
*/
enum
{
AUTO_SIZE,
AUTO_WRAP /**< Maybe it needs a fix or to be redone. */
};
/**
* 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
{
UNDERLINE = 1,
BACKGROUND = 2
};
private:
void relayoutText();
void layoutTextRow(TextRow &row, LayoutContext &context);
void updateHoveredLink(int x, int y);
std::deque mTextRows;
LinkHandler *mLinkHandler = nullptr;
unsigned int mMode;
unsigned int mHighlightMode = UNDERLINE | BACKGROUND;
bool mShadows = false;
bool mOutline = false;
bool mUseLinksAndUserColors = true;
std::optional mHoveredLink;
unsigned int mMaxRows = 0;
int mLastLayoutWidth = 0;
int mLastLayoutTime = -1;
};
#endif