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