mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-11 11:45:21 +00:00
d6695e180c
With help of Tanoku tooltips were switched from widgets to dialogs which helped to fix nasty bug with background not being restored. Although it is basically a hack around inconsistent font backbuffering in our GUI code, for the time being it is feasible. The patch was extended with way to specify tooltip background in the theme file. svn-id: r51217
342 lines
11 KiB
C++
342 lines
11 KiB
C++
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* 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 (at your option) 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, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* $URL$
|
|
* $Id$
|
|
*/
|
|
|
|
#ifndef GUI_WIDGET_H
|
|
#define GUI_WIDGET_H
|
|
|
|
#include "common/scummsys.h"
|
|
#include "common/str.h"
|
|
#include "common/str-array.h"
|
|
#include "common/keyboard.h"
|
|
#include "graphics/surface.h"
|
|
#include "gui/object.h"
|
|
#include "gui/ThemeEngine.h"
|
|
|
|
namespace GUI {
|
|
|
|
class Dialog;
|
|
|
|
enum {
|
|
WIDGET_ENABLED = 1 << 0,
|
|
WIDGET_INVISIBLE = 1 << 1,
|
|
WIDGET_HILITED = 1 << 2,
|
|
WIDGET_BORDER = 1 << 3,
|
|
//WIDGET_INV_BORDER = 1 << 4,
|
|
WIDGET_CLEARBG = 1 << 5,
|
|
WIDGET_WANT_TICKLE = 1 << 7,
|
|
WIDGET_TRACK_MOUSE = 1 << 8,
|
|
// Retain focus on mouse up. By default widgets lose focus on mouseup,
|
|
// but some widgets might want to retain it - widgets where you enter
|
|
// text, for instance
|
|
WIDGET_RETAIN_FOCUS = 1 << 9,
|
|
// Usually widgets would lock mouse input when the user pressed the
|
|
// left mouse button till the user releases it.
|
|
// The PopUpWidget for example does not want this behavior, since the
|
|
// mouse down will open up a new dialog which silently eats the mouse
|
|
// up event for its own purposes.
|
|
WIDGET_IGNORE_DRAG = 1 << 10
|
|
};
|
|
|
|
enum {
|
|
kStaticTextWidget = 'TEXT',
|
|
kEditTextWidget = 'EDIT',
|
|
kButtonWidget = 'BTTN',
|
|
kCheckboxWidget = 'CHKB',
|
|
kRadiobuttonWidget = 'RDBT',
|
|
kSliderWidget = 'SLDE',
|
|
kListWidget = 'LIST',
|
|
kScrollBarWidget = 'SCRB',
|
|
kPopUpWidget = 'POPU',
|
|
kTabWidget = 'TABW',
|
|
kGraphicsWidget = 'GFXW',
|
|
kContainerWidget = 'CTNR'
|
|
};
|
|
|
|
enum {
|
|
kCaretBlinkTime = 300
|
|
};
|
|
|
|
/* Widget */
|
|
class Widget : public GuiObject {
|
|
friend class Dialog;
|
|
protected:
|
|
uint32 _type;
|
|
GuiObject *_boss;
|
|
Widget *_next;
|
|
uint16 _id;
|
|
bool _hasFocus;
|
|
ThemeEngine::WidgetStateInfo _state;
|
|
const char *_tooltip;
|
|
|
|
private:
|
|
uint16 _flags;
|
|
|
|
public:
|
|
static Widget *findWidgetInChain(Widget *start, int x, int y);
|
|
static Widget *findWidgetInChain(Widget *start, const char *name);
|
|
|
|
public:
|
|
Widget(GuiObject *boss, int x, int y, int w, int h, const char *tooltip = 0);
|
|
Widget(GuiObject *boss, const Common::String &name, const char *tooltip = 0);
|
|
virtual ~Widget();
|
|
|
|
void init();
|
|
void resize(int x, int y, int w, int h);
|
|
|
|
void setNext(Widget *w) { _next = w; }
|
|
Widget *next() { return _next; }
|
|
|
|
virtual int16 getAbsX() const { return _x + _boss->getChildX(); }
|
|
virtual int16 getAbsY() const { return _y + _boss->getChildY(); }
|
|
|
|
virtual void setPos(int x, int y) { _x = x; _y = y; }
|
|
virtual void setSize(int w, int h) { _w = w; _h = h; }
|
|
|
|
virtual void handleMouseDown(int x, int y, int button, int clickCount) {}
|
|
virtual void handleMouseUp(int x, int y, int button, int clickCount) {}
|
|
virtual void handleMouseEntered(int button) {}
|
|
virtual void handleMouseLeft(int button) {}
|
|
virtual void handleMouseMoved(int x, int y, int button) {}
|
|
virtual void handleMouseWheel(int x, int y, int direction) {}
|
|
virtual bool handleKeyDown(Common::KeyState state) { return false; } // Return true if the event was handled
|
|
virtual bool handleKeyUp(Common::KeyState state) { return false; } // Return true if the event was handled
|
|
virtual void handleTickle() {}
|
|
|
|
void draw();
|
|
void receivedFocus() { _hasFocus = true; receivedFocusWidget(); }
|
|
void lostFocus() { _hasFocus = false; lostFocusWidget(); }
|
|
virtual bool wantsFocus() { return false; }
|
|
|
|
void setFlags(int flags);
|
|
void clearFlags(int flags);
|
|
int getFlags() const { return _flags; }
|
|
|
|
void setEnabled(bool e);
|
|
bool isEnabled() const;
|
|
|
|
void setVisible(bool e);
|
|
bool isVisible() const;
|
|
|
|
uint8 parseHotkey(const Common::String &label);
|
|
Common::String cleanupHotkey(const Common::String &label);
|
|
|
|
const char *getTooltip() const { return _tooltip; }
|
|
|
|
protected:
|
|
void updateState(int oldFlags, int newFlags);
|
|
|
|
virtual void drawWidget() = 0;
|
|
|
|
virtual void receivedFocusWidget() {}
|
|
virtual void lostFocusWidget() {}
|
|
|
|
virtual Widget *findWidget(int x, int y) { return this; }
|
|
|
|
void releaseFocus() { assert(_boss); _boss->releaseFocus(); }
|
|
|
|
// By default, delegate unhandled commands to the boss
|
|
void handleCommand(CommandSender *sender, uint32 cmd, uint32 data) { assert(_boss); _boss->handleCommand(sender, cmd, data); }
|
|
};
|
|
|
|
/* StaticTextWidget */
|
|
class StaticTextWidget : public Widget {
|
|
protected:
|
|
Common::String _label;
|
|
Graphics::TextAlign _align;
|
|
public:
|
|
StaticTextWidget(GuiObject *boss, int x, int y, int w, int h, const Common::String &text, Graphics::TextAlign align, const char *tooltip = 0);
|
|
StaticTextWidget(GuiObject *boss, const Common::String &name, const Common::String &text, const char *tooltip = 0);
|
|
void setValue(int value);
|
|
void setLabel(const Common::String &label);
|
|
const Common::String &getLabel() const { return _label; }
|
|
void setAlign(Graphics::TextAlign align);
|
|
Graphics::TextAlign getAlign() const { return _align; }
|
|
|
|
protected:
|
|
void drawWidget();
|
|
};
|
|
|
|
/* ButtonWidget */
|
|
class ButtonWidget : public StaticTextWidget, public CommandSender {
|
|
friend class Dialog; // Needed for the hotkey handling
|
|
protected:
|
|
uint32 _cmd;
|
|
uint8 _hotkey;
|
|
public:
|
|
ButtonWidget(GuiObject *boss, int x, int y, int w, int h, const Common::String &label, const char *tooltip = 0, uint32 cmd = 0, uint8 hotkey = 0);
|
|
ButtonWidget(GuiObject *boss, const Common::String &name, const Common::String &label, const char *tooltip = 0, uint32 cmd = 0, uint8 hotkey = 0);
|
|
|
|
void setCmd(uint32 cmd) { _cmd = cmd; }
|
|
uint32 getCmd() const { return _cmd; }
|
|
|
|
void handleMouseUp(int x, int y, int button, int clickCount);
|
|
void handleMouseEntered(int button) { setFlags(WIDGET_HILITED); draw(); }
|
|
void handleMouseLeft(int button) { clearFlags(WIDGET_HILITED); draw(); }
|
|
|
|
protected:
|
|
void drawWidget();
|
|
};
|
|
|
|
/* CheckboxWidget */
|
|
class CheckboxWidget : public ButtonWidget {
|
|
protected:
|
|
bool _state;
|
|
public:
|
|
CheckboxWidget(GuiObject *boss, int x, int y, int w, int h, const Common::String &label, const char *tooltip = 0, uint32 cmd = 0, uint8 hotkey = 0);
|
|
CheckboxWidget(GuiObject *boss, const Common::String &name, const Common::String &label, const char *tooltip = 0, uint32 cmd = 0, uint8 hotkey = 0);
|
|
|
|
void handleMouseUp(int x, int y, int button, int clickCount);
|
|
virtual void handleMouseEntered(int button) { setFlags(WIDGET_HILITED); draw(); }
|
|
virtual void handleMouseLeft(int button) { clearFlags(WIDGET_HILITED); draw(); }
|
|
|
|
void setState(bool state);
|
|
void toggleState() { setState(!_state); }
|
|
bool getState() const { return _state; }
|
|
|
|
protected:
|
|
void drawWidget();
|
|
};
|
|
|
|
class RadiobuttonWidget;
|
|
|
|
class RadiobuttonGroup : public CommandSender {
|
|
public:
|
|
RadiobuttonGroup(GuiObject *boss, uint32 cmd = 0);
|
|
~RadiobuttonGroup() {}
|
|
|
|
void addButton(RadiobuttonWidget *button) { _buttons.push_back(button); }
|
|
Common::Array<RadiobuttonWidget *> getButtonList() const { return _buttons; }
|
|
|
|
void setValue(int state);
|
|
int getValue() const { return _value; }
|
|
|
|
void setEnabled(bool ena);
|
|
|
|
void setCmd(uint32 cmd) { _cmd = cmd; }
|
|
uint32 getCmd() const { return _cmd; }
|
|
|
|
protected:
|
|
Common::Array<RadiobuttonWidget *> _buttons;
|
|
int _value;
|
|
uint32 _cmd;
|
|
};
|
|
|
|
/* RadiobuttonWidget */
|
|
class RadiobuttonWidget : public ButtonWidget {
|
|
protected:
|
|
bool _state;
|
|
int _value;
|
|
|
|
public:
|
|
RadiobuttonWidget(GuiObject *boss, int x, int y, int w, int h, RadiobuttonGroup *group, int value, const Common::String &label, const char *tooltip = 0, uint8 hotkey = 0);
|
|
RadiobuttonWidget(GuiObject *boss, const Common::String &name, RadiobuttonGroup *group, int value, const Common::String &label, const char *tooltip = 0, uint8 hotkey = 0);
|
|
|
|
void handleMouseUp(int x, int y, int button, int clickCount);
|
|
virtual void handleMouseEntered(int button) { setFlags(WIDGET_HILITED); draw(); }
|
|
virtual void handleMouseLeft(int button) { clearFlags(WIDGET_HILITED); draw(); }
|
|
|
|
void setState(bool state, bool setGroup = true);
|
|
void toggleState() { setState(!_state); }
|
|
bool getState() const { return _state; }
|
|
int getValue() const { return _value; }
|
|
|
|
protected:
|
|
void drawWidget();
|
|
|
|
RadiobuttonGroup *_group;
|
|
};
|
|
|
|
/* SliderWidget */
|
|
class SliderWidget : public Widget, public CommandSender {
|
|
protected:
|
|
uint32 _cmd;
|
|
int _value, _oldValue;
|
|
int _valueMin, _valueMax;
|
|
bool _isDragging;
|
|
uint _labelWidth;
|
|
public:
|
|
SliderWidget(GuiObject *boss, int x, int y, int w, int h, const char *tooltip = 0, uint32 cmd = 0);
|
|
SliderWidget(GuiObject *boss, const Common::String &name, const char *tooltip = 0, uint32 cmd = 0);
|
|
|
|
void setCmd(uint32 cmd) { _cmd = cmd; }
|
|
uint32 getCmd() const { return _cmd; }
|
|
|
|
void setValue(int value) { _value = value; }
|
|
int getValue() const { return _value; }
|
|
|
|
void setMinValue(int value) { _valueMin = value; }
|
|
int getMinValue() const { return _valueMin; }
|
|
void setMaxValue(int value) { _valueMax = value; }
|
|
int getMaxValue() const { return _valueMax; }
|
|
|
|
void handleMouseMoved(int x, int y, int button);
|
|
void handleMouseDown(int x, int y, int button, int clickCount);
|
|
void handleMouseUp(int x, int y, int button, int clickCount);
|
|
void handleMouseEntered(int button) { setFlags(WIDGET_HILITED); draw(); }
|
|
void handleMouseLeft(int button) { clearFlags(WIDGET_HILITED); draw(); }
|
|
void handleMouseWheel(int x, int y, int direction);
|
|
|
|
protected:
|
|
void drawWidget();
|
|
|
|
int valueToPos(int value);
|
|
int posToValue(int pos);
|
|
int valueToBarWidth(int value);
|
|
};
|
|
|
|
/* GraphicsWidget */
|
|
class GraphicsWidget : public Widget {
|
|
public:
|
|
GraphicsWidget(GuiObject *boss, int x, int y, int w, int h, const char *tooltip = 0);
|
|
GraphicsWidget(GuiObject *boss, const Common::String &name, const char *tooltip = 0);
|
|
~GraphicsWidget();
|
|
|
|
void setGfx(const Graphics::Surface *gfx);
|
|
void setGfx(int w, int h, int r, int g, int b);
|
|
|
|
void useAlpha(int alpha) { _alpha = alpha; }
|
|
void useThemeTransparency(bool enable) { _transparency = enable; }
|
|
|
|
protected:
|
|
void drawWidget();
|
|
|
|
Graphics::Surface _gfx;
|
|
int _alpha;
|
|
bool _transparency;
|
|
};
|
|
|
|
/* ContainerWidget */
|
|
class ContainerWidget : public Widget {
|
|
public:
|
|
ContainerWidget(GuiObject *boss, int x, int y, int w, int h);
|
|
ContainerWidget(GuiObject *boss, const Common::String &name);
|
|
|
|
protected:
|
|
void drawWidget();
|
|
};
|
|
|
|
} // End of namespace GUI
|
|
|
|
#endif
|