_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

focushandler.h
Go to the documentation of this file.
1 /* _______ __ __ __ ______ __ __ _______ __ __
2  * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3  * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4  * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5  * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8  *
9  * Copyright (c) 2004, 2005 darkbits Js_./
10  * Per Larsson a.k.a finalman _RqZ{a<^_aa
11  * Olof Naess�n a.k.a jansem/yakslem _asww7!uY`> )\a//
12  * _Qhm`] _f "'c 1!5m
13  * Visit: http://guichan.darkbits.org )Qk<P ` _: :+' .' "{[
14  * .)j(] .d_/ '-( P . S
15  * License: (BSD) <Td/Z <fP"5(\"??"\a. .L
16  * Redistribution and use in source and _dV>ws?a-?' ._/L #'
17  * binary forms, with or without )4d[#7r, . ' )d`)[
18  * modification, are permitted provided _Q-5'5W..j/?' -?!\)cam'
19  * that the following conditions are met: j<<WP+k/);. _W=j f
20  * 1. Redistributions of source code must .$%w\/]Q . ."' . mj$
21  * retain the above copyright notice, ]E.pYY(Q]>. a J@\
22  * this list of conditions and the j(]1u<sE"L,. . ./^ ]{a
23  * following disclaimer. 4'_uomm\. )L);-4 (3=
24  * 2. Redistributions in binary form must )_]X{Z('a_"a7'<a"a, ]"[
25  * reproduce the above copyright notice, #}<]m7`Za??4,P-"'7. ).m
26  * this list of conditions and the ]d2e)Q(<Q( ?94 b- LQ/
27  * following disclaimer in the <B!</]C)d_, '(<' .f. =C+m
28  * documentation and/or other materials .Z!=J ]e []('-4f _ ) -.)m]'
29  * provided with the distribution. .w[5]' _[ /.)_-"+? _/ <W"
30  * 3. Neither the name of Guichan nor the :$we` _! + _/ . j?
31  * names of its contributors may be used =3)= _f (_yQmWW$#( "
32  * to endorse or promote products derived - W, sQQQQmZQ#Wwa]..
33  * from this software without specific (js, \[QQW$QWW#?!V"".
34  * prior written permission. ]y:.<\.. .
35  * -]n w/ ' [.
36  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT )/ )/ !
37  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY < (; sac , '
38  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, ]^ .- %
39  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF c < r
40  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR aga< <La
41  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 5% )P'-3L
42  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR _bQf` y`..)a
43  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, ,J?4P'.P"_(\?d'.,
44  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES _Pa,)!f/<[]/ ?"
45  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT _2-..:. .r+_,.. .
46  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, ?a.<%"' " -'.a_ _,
47  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ^
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
49  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
50  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
51  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
52  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53  */
54 
55 #ifndef GCN_FOCUSHANDLER_HPP
56 #define GCN_FOCUSHANDLER_HPP
57 
58 #include <vector>
59 
60 #include "guichan/platform.h"
61 #include "guichan/widget.h"
62 
63 namespace gcn
64 {
65  class Widget;
66 
81  {
82  public:
83 
87  FocusHandler();
88 
92  virtual ~FocusHandler() { };
93 
100  virtual void requestFocus(Widget* widget);
101 
105  virtual void setFocus(Widget* widget);
106 
112  virtual void requestDrag(Widget* widget);
113 
121  virtual void requestModalFocus(Widget* widget);
122 
129  virtual void releaseModalFocus(Widget* widget);
130 
137  virtual Widget* getFocused() const;
138 
145  virtual Widget* getDragged() const;
146 
153  virtual Widget* getModalFocused() const;
154 
160  virtual void focusNext();
161 
167  virtual void focusPrevious();
168 
175  virtual bool hasFocus(const Widget* widget) const;
176 
183  virtual bool isDragged(const Widget* widget) const;
184 
190  virtual void add(Widget* widget);
191 
197  virtual void remove(Widget* widget);
198 
202  virtual void focusNone();
203 
208  virtual void tabNext();
209 
214  virtual void tabPrevious();
215 
219  virtual void applyChanges();
220 
224  virtual void dragNone();
225 
229  virtual void checkHotKey(const KeyInput &keyInput);
230 
231  protected:
232  typedef std::vector<Widget*> WidgetVector;
233  typedef WidgetVector::iterator WidgetIterator;
235 
241  };
242 }
243 
244 #endif // end GCN_FOCUSHANDLER_HPP
gcn::FocusHandler::~FocusHandler
virtual ~FocusHandler()
Definition: focushandler.h:92
GCN_CORE_DECLSPEC
#define GCN_CORE_DECLSPEC
Definition: platform.h:59
gcn::FocusHandler::WidgetVector
std::vector< Widget * > WidgetVector
Definition: focushandler.h:232
gcn::FocusHandler
Definition: focushandler.h:80
gcn::FocusHandler::mDraggedWidget
Widget * mDraggedWidget
Definition: focushandler.h:237
gcn::KeyInput
Definition: keyinput.h:67
gcn
Definition: cliprectangle.cpp:61
gcn::FocusHandler::mToBeFocused
Widget * mToBeFocused
Definition: focushandler.h:238
gcn::FocusHandler::WidgetIterator
WidgetVector::iterator WidgetIterator
Definition: focushandler.h:233
widget.h
gcn::FocusHandler::mFocusedWidget
Widget * mFocusedWidget
Definition: focushandler.h:236
gcn::FocusHandler::mWidgets
WidgetVector mWidgets
Definition: focushandler.h:234
platform.h
gcn::FocusHandler::mModalFocusedWidget
Widget * mModalFocusedWidget
Definition: focushandler.h:240
gcn::FocusHandler::mToBeDragged
Widget * mToBeDragged
Definition: focushandler.h:239
gcn::Widget
Definition: widget.h:93
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.