Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/actionevent.hpp @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_ACTIONEVENT_HPP
45 #define GCN_ACTIONEVENT_HPP
46
47 #include "guichan/event.hpp"
48 #include "guichan/platform.hpp"
49
50 #include <string>
51
52 namespace gcn
53 {
54 class Widget;
55
56 /**
57 * Represents an action event. An action event is an event
58 * that can be fired by a widget whenever an action has occured.
59 * What exactly an action is is up to the widget that fires
60 * the action event. An example is a Button which fires an action
61 * event as soon as the Button is clicked, another example is
62 * TextField which fires an action event as soon as the enter
63 * key is pressed.
64 *
65 * Any object can listen for actions from widgets by implementing
66 * the ActionListener interface.
67 *
68 * If you have implement a widget of your own it's a good idea to
69 * let the widget fire action events whenever you feel an action
70 * has occured so action listeners of the widget can be informed
71 * of the state of the widget.
72 *
73 * @see Widget::addActionListener, Widget::removeActionListener,
74 * Widget::distributeActionEvent
75 * @author Olof Naessén
76 * @since 0.6.0
77 */
78 class GCN_CORE_DECLSPEC ActionEvent: public Event
79 {
80 public:
81
82 /**
83 * Constructor.
84 *
85 * @param source The source widget of the event.
86 * @param id An identifier of the event.
87 */
88 ActionEvent(Widget* source, const std::string& id);
89
90 /**
91 * Destructor.
92 */
93 virtual ~ActionEvent();
94
95 /**
96 * Gets the identifier of the event. An identifier can
97 * be used to distinguish from two actions from the same
98 * widget or to let many widgets fire the same widgets
99 * that should be treated equally.
100 *
101 * @return The identifier of the event.
102 */
103 const std::string& getId() const;
104
105 protected:
106 /**
107 * Holds the identifier of the event.
108 */
109 std::string mId;
110 };
111 }
112
113 #endif // GCN_ACTIONEVENT_HPP
114