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
|
/*
* The ManaPlus Client
* Copyright (C) 2011-2019 The ManaPlus Developers
*
* This file is part of The ManaPlus 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/>.
*/
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naessén a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GUI_WIDGETS_BASICCONTAINER_H
#define GUI_WIDGETS_BASICCONTAINER_H
#include "gui/widgets/widget.h"
#include "listeners/widgetdeathlistener.h"
/**
* A base class for containers. The class implements the most
* common things for a container. If you are implementing a
* container, consider inheriting from this class.
*
* @see Container
*/
class BasicContainer notfinal : public Widget,
public WidgetDeathListener
{
public:
explicit BasicContainer(const Widget2 *restrict const widget) :
Widget(widget),
WidgetDeathListener(),
mWidgets(),
mLogicWidgets()
{ }
A_DELETE_COPY(BasicContainer)
/**
* Destructor
*/
~BasicContainer() override;
/**
* Shows a certain part of a widget in the basic container.
* Used when widgets want a specific part to be visible in
* its parent. An example is a TextArea that wants a specific
* part of its text to be visible when a TextArea is a child
* of a ScrollArea.
*
* @param widget The widget whom wants a specific part of
* itself to be visible.
* @param area The rectangle to be visible.
*/
void showWidgetPart(Widget *restrict const widget,
const Rect &restrict area) restrict2 override;
// Inherited from Widget
void moveToTop(Widget *const widget) restrict2 override;
void moveToBottom(Widget *const widget) restrict2 override;
Rect getChildrenArea() restrict2 override A_WARN_UNUSED;
void focusNext() restrict2 override;
void focusPrevious() restrict2 override;
void logic() restrict2 override;
void setFocusHandler(FocusHandler *restrict const focusHandler)
restrict2 override;
void setInternalFocusHandler(FocusHandler *const restrict focusHandler)
restrict2;
Widget *getWidgetAt(int x, int y) restrict2 override A_WARN_UNUSED;
// Inherited from WidgetDeathListener
void death(const Event &restrict event) restrict2 override;
Widget *findFirstWidget(const std::set<Widget*> &restrict list)
restrict2;
/**
* Adds a widget to the basic container.
*
* @param widget The widget to add.
* @see remove, clear
*/
void add(Widget *const widget) restrict2;
/**
* Removes a widget from the basic container.
*
* @param widget The widget to remove.
* @see add, clear
*/
virtual void remove(Widget *const restrict widget) restrict2;
/**
* Clears the basic container from all widgets.
*
* @see remove, clear
*/
virtual void clear() restrict2;
protected:
/**
* Draws the children widgets of the basic container.
*
* @param graphics A graphics object to draw with.
*/
virtual void drawChildren(Graphics *const restrict graphics)
restrict2 A_NONNULL(2);
virtual void safeDrawChildren(Graphics *const restrict graphics)
restrict2 A_NONNULL(2);
/**
* Calls logic for the children widgets of the basic
* container.
*/
virtual void logicChildren() restrict2;
/**
* Typedef.
*/
typedef STD_VECTOR<Widget *> WidgetList;
/**
* Typedef.
*/
typedef WidgetList::iterator WidgetListIterator;
/**
* Typedef.
*/
typedef WidgetList::const_iterator WidgetListConstIterator;
/**
* Typedef.
*/
typedef WidgetList::reverse_iterator WidgetListReverseIterator;
/**
* Typedef.
*/
typedef WidgetList::const_reverse_iterator WidgetListCReverseIterator;
/**
* Holds all widgets of the basic container.
*/
WidgetList mWidgets;
WidgetList mLogicWidgets;
};
#endif // GUI_WIDGETS_BASICCONTAINER_H
|
