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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
/*
* The Mana World
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World 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.
*
* The Mana World 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 The Mana World; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id$
*/
#ifndef _TMW_WINDOW_H__
#define _TMW_WINDOW_H__
#include <guichan/widgets/window.hpp>
#include <guichan/widgetlistener.hpp>
#include "../guichanfwd.h"
class ConfigListener;
class GCContainer;
class ImageRect;
class ResizeGrip;
class WindowContainer;
class Image;
/**
* A window. This window can be dragged around and has a title bar. Windows are
* invisible by default.
*
* \ingroup GUI
*/
class Window : public gcn::Window, gcn::WidgetListener
{
public:
friend class WindowConfigListener;
/**
* Constructor. Initializes the title to the given text and hooks
* itself into the window container.
*
* @param caption The initial window title, "Window" by default.
* @param modal Block input to other windows.
* @param parent The parent window. This is the window standing above
* this one in the window hiearchy. When reordering,
* a window will never go below its parent window.
*/
Window(const std::string &caption = "Window", bool modal = false,
Window *parent = NULL);
/**
* Destructor.
*/
~Window();
/**
* Sets the window container to be used by new windows.
*/
static void setWindowContainer(WindowContainer *windowContainer);
/**
* Draws the window.
*/
void draw(gcn::Graphics *graphics);
/**
* Adds a widget to the window.
*/
void add(gcn::Widget *wi, bool delChild = true);
/**
* Adds a widget to the window and also specifices its position.
*/
void add(gcn::Widget *w, int x, int y, bool delChild = true);
/**
* Sets the size of this window.
*/
void setContentSize(int width, int height);
/**
* Sets the location relative to the given widget.
*/
void setLocationRelativeTo(gcn::Widget *widget);
/**
* Sets whether or not the window can be resized.
*/
void setResizable(bool resize);
/**
* Called whenever the widget changes size.
*/
void widgetResized(const gcn::Event &event);
/**
* Sets whether or not the window has a close button.
*/
void setCloseButton(bool flag);
/**
* Returns whether the window can be resized.
*/
bool isResizable();
/**
* Sets the minimum width of the window.
*/
void setMinWidth(unsigned int width);
/**
* Sets the minimum height of the window.
*/
void setMinHeight(unsigned int height);
/**
* Sets the maximum width of the window.
*/
void setMaxWidth(unsigned int width);
/**
* Sets the minimum height of the window.
*/
void setMaxHeight(unsigned int height);
/**
* Sets flag to show a title or not.
*/
void setShowTitle(bool flag)
{ mShowTitle = flag; }
/**
* Sets whether the window is sticky. A sticky window will not have
* its visibility set to false on a general setVisible(false) call.
*/
void setSticky(bool sticky);
/**
* Returns whether the window is sticky.
*/
bool isSticky();
/**
* Overloads window setVisible by Guichan to allow sticky window
* handling.
*/
void setVisible(bool visible);
/**
* Returns the parent window.
*
* @return The parent window or <code>NULL</code> if there is none.
*/
Window*
getParentWindow() { return mParent; }
/**
* Schedule this window for deletion. It will be deleted at the start
* of the next logic update.
*/
void scheduleDelete();
/**
* Starts window resizing when appropriate.
*/
void mousePressed(gcn::MouseEvent &event);
/**
* Implements window resizing and makes sure the window is not
* dragged/resized outside of the screen.
*/
void mouseDragged(gcn::MouseEvent &event);
/**
* Implements custom cursor image changing context, based on mouse
* relative position.
*/
void mouseMoved(gcn::MouseEvent &event);
/**
* When the mouse button has been let go, this ensures that the mouse
* custom cursor is restored back to it's standard image.
*/
void mouseReleased(gcn::MouseEvent &event);
/**
* When the mouse leaves the window this ensures that the custom cursor
* is restored back to it's standard image.
*/
void mouseExited(gcn::MouseEvent &event);
/**
* Sets the name of the window. This is not the window title.
*/
void
setWindowName(const std::string &name) { mWindowName = name; }
/**
* Returns the name of the window. This is not the window title.
*/
const std::string&
getWindowName() { return mWindowName; }
/**
* Reads the position (and the size for resizable windows) in the
* configuration based on the given string.
* Uses the default values when config values are missing.
* Don't forget to set these default values and resizable before
* calling this function.
*/
virtual void loadWindowState();
/**
* Set the default win pos and size.
* (which can be different of the actual ones.)
*/
virtual void setDefaultSize(int defaultX, int defaultY,
int defaultWidth, int defaultHeight);
/**
* Reset the win pos and size to default. Don't forget to set defaults
* first.
*/
virtual void resetToDefaultSize();
enum ResizeHandles
{
TOP = 0x01,
RIGHT = 0x02,
BOTTOM = 0x04,
LEFT = 0x08
};
protected:
/**
* Determines if the mouse is in a resize area and returns appropriate
* resize handles. Also initializes drag offset in case the resize
* grip is used.
*
* @see ResizeHandles
*/
int getResizeHandles(gcn::MouseEvent &event);
GCContainer *mChrome; /**< Contained container */
ResizeGrip *mGrip; /**< Resize grip */
Window *mParent; /**< The parent window */
std::string mWindowName; /**< Name of the window */
bool mShowTitle; /**< Window has a title bar */
bool mModal; /**< Window is modal */
bool mCloseButton; /**< Window has a close button */
bool mSticky; /**< Window resists minimization */
int mMinWinWidth; /**< Minimum window width */
int mMinWinHeight; /**< Minimum window height */
int mMaxWinWidth; /**< Maximum window width */
int mMaxWinHeight; /**< Maximum window height */
int mDefaultX; /**< Default window X position */
int mDefaultY; /**< Default window Y position */
int mDefaultWidth; /**< Default window width */
int mDefaultHeight; /**< Default window height */
/** The window container windows add themselves to. */
static WindowContainer *windowContainer;
/**
* The config listener that listens to changes relevant to all windows.
*/
static ConfigListener *windowConfigListener;
static int mouseResize; /**< Active resize handles */
static int instances; /**< Number of Window instances */
static ImageRect border; /**< The window border and background */
static Image *closeImage; /**< Close Button Image */
/**
* The width of the resize border. Is independent of the actual window
* border width, and determines mostly the size of the corner area
* where two borders are moved at the same time.
*/
static const int resizeBorderWidth = 10;
};
#endif
|
