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
|
/*
* The Mana Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 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 <http://www.gnu.org/licenses/>.
*/
#ifndef POPUP_H
#define POPUP_H
#include "configuration.h"
#include "guichanfwd.h"
#include "gui/widgets/container.h"
#include <guichan/mouselistener.hpp>
class Skin;
class WindowContainer;
/**
* A light version of the Window class. Particularly suited for popup type
* functionality that doesn't need to be resized or moved around by the mouse
* once created, but only needs to display some simple content, like a static
* message.
*
* Popups, in general, shouldn't also need to update their content once
* created, although this is not an explicit requirement to use the popup
* class.
*
* \ingroup GUI
*/
class Popup : public Container, public gcn::MouseListener
{
public:
/**
* Constructor. Initializes the title to the given text and hooks
* itself into the popup container.
*
* @param name A human readable name for the popup. Only useful for
* debugging purposes.
* @param skin The location where the Popup's skin XML can be found.
*/
Popup(const std::string &name = "",
const std::string &skin = "window.xml");
/**
* Destructor. Deletes all the added widgets.
*/
~Popup();
/**
* Sets the window container to be used by new popups.
*/
static void setWindowContainer(WindowContainer *windowContainer);
/**
* Changes the popup's skin to use the skin defined in the saved
* configuration file.
*/
void loadPopupConfiguration();
/**
* Currently only saves the skin used by the popup so that when the
* client is reloaded, it can use the saved skin.
*/
void savePopupConfiguration();
/**
* Draws the popup.
*/
void draw(gcn::Graphics *graphics);
/**
* Sets the size of this popup.
*/
void setContentSize(int width, int height);
/**
* Sets the location relative to the given widget.
*/
void setLocationRelativeTo(gcn::Widget *widget);
void mouseMoved(gcn::MouseEvent &event);
/**
* Sets the minimum width of the popup.
*/
void setMinWidth(int width);
int getMinWidth() const { return mMinWidth; }
/**
* Sets the minimum height of the popup.
*/
void setMinHeight(int height);
int getMinHeight() const { return mMinHeight; }
/**
* Sets the maximum width of the popup.
*/
void setMaxWidth(int width);
int getMaxWidth() const { return mMaxWidth; }
/**
* Sets the minimum height of the popup.
*/
void setMaxHeight(int height);
int getMaxHeight() const { return mMaxHeight; }
/**
* Gets the padding of the popup. The padding is the distance between
* the popup border and the content.
*
* @return The padding of the popup.
* @see setPadding
*/
int getPadding() const { return mPadding; }
void setPadding(int padding) { mPadding = padding; }
/**
* Sets the name of the popup. This is only useful for debug purposes.
*/
void setPopupName(const std::string &name)
{ mPopupName = name; }
const std::string &getPopupName() const
{ return mPopupName; }
/**
* Schedule this popup for deletion. It will be deleted at the start
* of the next logic update.
*/
void scheduleDelete();
// Inherited from BasicContainer
virtual gcn::Rectangle getChildrenArea();
/**
* Sets the location to display the popup. Tries to horizontally center
* the popup and provide a vertical buffer between the given point and
* the popup. Prevents the popup from extending off-screen, if
* possible.
*/
void position(int x, int y);
private:
std::string mPopupName; /**< Name of the popup */
std::string mDefaultSkinPath; /**< Default skin path for this popup */
int mMinWidth; /**< Minimum popup width */
int mMinHeight; /**< Minimum popup height */
int mMaxWidth; /**< Maximum popup width */
int mMaxHeight; /**< Maximum popup height */
int mPadding; /**< Holds the padding of the popup. */
Skin *mSkin; /**< Skin in use by this popup */
};
#endif
|
