ManaPlus
basiccontainer.h
Go to the documentation of this file.
1 /*
2  * The ManaPlus Client
3  * Copyright (C) 2011-2019 The ManaPlus Developers
4  * Copyright (C) 2019-2021 Andrei Karas
5  *
6  * This file is part of The ManaPlus Client.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 /* _______ __ __ __ ______ __ __ _______ __ __
23  * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
24  * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
25  * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
26  * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
27  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
28  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
29  *
30  * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
31  *
32  *
33  * Per Larsson a.k.a finalman
34  * Olof Naessén a.k.a jansem/yakslem
35  *
36  * Visit: http://guichan.sourceforge.net
37  *
38  * License: (BSD)
39  * Redistribution and use in source and binary forms, with or without
40  * modification, are permitted provided that the following conditions
41  * are met:
42  * 1. Redistributions of source code must retain the above copyright
43  * notice, this list of conditions and the following disclaimer.
44  * 2. Redistributions in binary form must reproduce the above copyright
45  * notice, this list of conditions and the following disclaimer in
46  * the documentation and/or other materials provided with the
47  * distribution.
48  * 3. Neither the name of Guichan nor the names of its contributors may
49  * be used to endorse or promote products derived from this software
50  * without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
58  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
59  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
60  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
61  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
62  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63  */
64 
65 #ifndef GUI_WIDGETS_BASICCONTAINER_H
66 #define GUI_WIDGETS_BASICCONTAINER_H
67 
68 #include "gui/widgets/widget.h"
69 
71 
80  public WidgetDeathListener
81 {
82  public:
83  explicit BasicContainer(const Widget2 *restrict const widget) :
84  Widget(widget),
86  mWidgets(),
88  { }
89 
91 
92 
95  ~BasicContainer() override;
96 
108  void showWidgetPart(Widget *restrict const widget,
109  const Rect &restrict area) restrict2 override;
110 
111  // Inherited from Widget
112 
113  void moveToTop(Widget *const widget) restrict2 override;
114 
115  void moveToBottom(Widget *const widget) restrict2 override;
116 
118 
120 
122 
123  void logic() restrict2 override;
124 
125  void setFocusHandler(FocusHandler *restrict const focusHandler)
127 
128  void setInternalFocusHandler(FocusHandler *const restrict focusHandler)
129  restrict2;
130 
132 
133  // Inherited from WidgetDeathListener
134 
135  void death(const Event &restrict event) restrict2 override;
136 
137  Widget *findFirstWidget(const std::set<Widget*> &restrict list)
138  restrict2;
139 
146  void add(Widget *const widget) restrict2;
147 
154  virtual void remove(Widget *const restrict widget) restrict2;
155 
161  virtual void clear() restrict2;
162 
163  protected:
169  virtual void drawChildren(Graphics *const restrict graphics)
170  restrict2 A_NONNULL(2);
171 
172  virtual void safeDrawChildren(Graphics *const restrict graphics)
173  restrict2 A_NONNULL(2);
174 
179  virtual void logicChildren() restrict2;
180 
185 
189  typedef WidgetList::iterator WidgetListIterator;
190 
194  typedef WidgetList::const_iterator WidgetListConstIterator;
195 
199  typedef WidgetList::reverse_iterator WidgetListReverseIterator;
200 
204  typedef WidgetList::const_reverse_iterator WidgetListCReverseIterator;
205 
210 
212 };
213 
214 #endif // GUI_WIDGETS_BASICCONTAINER_H
void moveToBottom(Widget *const widget)
virtual void safeDrawChildren(Graphics *const graphics)
std::vector< Widget * > WidgetList
virtual void logicChildren()
Widget * findFirstWidget(const std::set< Widget * > &list)
WidgetList::iterator WidgetListIterator
WidgetList mWidgets
Widget * getWidgetAt(int x, int y)
void showWidgetPart(Widget *const widget, const Rect &area)
WidgetList::const_reverse_iterator WidgetListCReverseIterator
void moveToTop(Widget *const widget)
BasicContainer(const Widget2 *const widget)
void setInternalFocusHandler(FocusHandler *const focusHandler)
virtual void remove(Widget *const widget)
void setFocusHandler(FocusHandler *const focusHandler)
WidgetList::reverse_iterator WidgetListReverseIterator
WidgetList mLogicWidgets
WidgetList::const_iterator WidgetListConstIterator
void add(Widget *const widget)
void death(const Event &event)
virtual void clear()
virtual void drawChildren(Graphics *const graphics)
Definition: event.h:79
Definition: rect.h:74
Definition: widget.h:99
#define restrict
Definition: localconsts.h:165
#define restrict2
Definition: localconsts.h:166
#define override
Definition: localconsts.h:47
#define A_WARN_UNUSED
Definition: localconsts.h:161
#define notfinal
Definition: localconsts.h:261
#define A_NONNULL(...)
Definition: localconsts.h:168
#define A_DELETE_COPY(func)
Definition: localconsts.h:53
#define STD_VECTOR
Definition: vector.h:30