scummvm/gui/dialog.h
Bastien Bouclet 4d0bb753e4 GUI: Remove the ThemeItem draw queues
Drawing nows happens directly when the Dialog or Widget draw methods are
called. This makes it easy to debug why a particular low level draw
method was called, by inspecting the call stack.

This replaces the notion of "buffering" by two independant ways to
control what is drawn and where:
- The active layer is used to select whether the foreground or
  background part of the dialogs are rendered by the draw calls.
- The active surface is used to select if the draw calls affect the back
  buffer or the screen.

The foreground layer of the active dialog is drawn directly to the
screen. Its background layer is drawn to the back buffer. This way
widgets can restore the back buffer in order to update without having to
redraw the dialog's background.

Dialogs lower in the dialog stack are drawn entirely to the back buffer.
2018-03-12 11:46:04 +01:00

125 lines
3.4 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.
*
*/
#ifndef GUI_DIALOG_H
#define GUI_DIALOG_H
#include "common/scummsys.h"
#include "common/str.h"
#include "common/keyboard.h"
#include "gui/object.h"
#include "gui/ThemeEngine.h"
#ifdef ENABLE_KEYMAPPER
namespace Common {
struct Event;
}
#endif
namespace GUI {
class EventRecorder;
class Widget;
// Some "common" commands sent to handleCommand()
enum {
kCloseCmd = 'clos',
kOKCmd = 'ok '
};
class Dialog : public GuiObject {
friend class GuiManager;
friend class EventRecorder;
friend class Tooltip;
protected:
Widget *_mouseWidget;
Widget *_focusedWidget;
Widget *_dragWidget;
Widget *_tickleWidget;
bool _visible;
ThemeEngine::DialogBackground _backgroundType;
private:
int _result;
public:
Dialog(int x, int y, int w, int h);
Dialog(const Common::String &name);
virtual int runModal();
bool isVisible() const { return _visible; }
void releaseFocus();
void setFocusWidget(Widget *widget);
Widget *getFocusWidget() { return _focusedWidget; }
void setTickleWidget(Widget *widget) { _tickleWidget = widget; }
void unSetTickleWidget() { _tickleWidget = NULL; }
Widget *getTickleWidget() { return _tickleWidget; }
virtual void reflowLayout();
virtual void lostFocus();
virtual void receivedFocus(int x = -1, int y = -1) { if (x >= 0 && y >= 0) handleMouseMoved(x, y, 0); }
protected:
virtual void open();
virtual void close();
/** Recursively mark all the widgets in this dialog as dirty so they are redrawn */
void markWidgetsAsDirty();
/** Draw the dialog in its entirety (background and widgets) */
virtual void drawDialog(DrawLayer layerToDraw);
/** Draw only the dialog's widgets */
void drawWidgets();
virtual void handleTickle(); // Called periodically (in every guiloop() )
virtual void handleMouseDown(int x, int y, int button, int clickCount);
virtual void handleMouseUp(int x, int y, int button, int clickCount);
virtual void handleMouseWheel(int x, int y, int direction);
virtual void handleKeyDown(Common::KeyState state);
virtual void handleKeyUp(Common::KeyState state);
virtual void handleMouseMoved(int x, int y, int button);
virtual void handleCommand(CommandSender *sender, uint32 cmd, uint32 data);
#ifdef ENABLE_KEYMAPPER
virtual void handleOtherEvent(Common::Event evt);
#endif
Widget *findWidget(int x, int y); // Find the widget at pos x,y if any
Widget *findWidget(const char *name);
void removeWidget(Widget *widget);
void setDefaultFocusedWidget();
void setResult(int result) { _result = result; }
int getResult() const { return _result; }
};
} // End of namespace GUI
#endif