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
|
/* 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 SHERLOCK_TATTOO_WIDGET_BASE_H
#define SHERLOCK_TATTOO_WIDGET_BASE_H
#include "common/scummsys.h"
#include "common/rect.h"
#include "common/str-array.h"
#include "sherlock/surface.h"
namespace Sherlock {
class SherlockEngine;
class ImageFile;
namespace Tattoo {
class WidgetBase {
protected:
SherlockEngine *_vm;
Common::Rect _bounds;
Common::Rect _oldBounds;
Surface _surface;
bool _outsideMenu;
bool _scroll;
/**
* Used by descendent classes to split up long text for display across multiple lines
*/
Common::String splitLines(const Common::String &str, Common::StringArray &lines, int maxWidth, uint maxLines);
/**
* Ensure that menu is drawn entirely on-screen
*/
void restrictToScreen();
/**
* Draw a window frame around the dges of the passed surface
*/
void makeInfoArea(Surface &s);
/**
* Draw a window frame around the widget's surface
*/
void makeInfoArea();
/**
* Draw the scrollbar for the dialog
*/
void drawScrollBar(int index, int pageSize, int count);
/**
* Handles any events when the mouse is on the scrollbar
*/
void handleScrollbarEvents(int index, int pageSize, int count);
/**
* Handle drawing the background on the area the widget is going to cover
*/
virtual void drawBackground();
public:
WidgetBase(SherlockEngine *vm);
virtual ~WidgetBase() {}
/**
* Erase any previous display of the widget on the screen
*/
virtual void erase();
/**
* Update the display of the widget on the screen
*/
virtual void draw();
/**
* Used by some descendents to check for keys to mouse the mouse within the dialog
*/
void checkTabbingKeys(int numOptions);
/**
* Summon the window
*/
virtual void summonWindow();
/**
* Close a currently active menu
*/
virtual void banishWindow();
/**
* Handle event processing
*/
virtual void handleEvents() {}
};
} // End of namespace Tattoo
} // End of namespace Sherlock
#endif
|
