source: GTP/trunk/Lib/Geom/OgreStuff/include/CEGUI/CEGUIEventArgs.h @ 1809

Revision 1809, 2.6 KB checked in by gumbau, 18 years ago (diff)
Line 
1/************************************************************************
2        filename:       CEGUIEventArgs.h
3        created:        21/2/2004
4        author:         Paul D Turner
5       
6        purpose:        Defines base EventArgs class used with event signalling
7*************************************************************************/
8/*************************************************************************
9    Crazy Eddie's GUI System (http://www.cegui.org.uk)
10    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
11
12    This library is free software; you can redistribute it and/or
13    modify it under the terms of the GNU Lesser General Public
14    License as published by the Free Software Foundation; either
15    version 2.1 of the License, or (at your option) any later version.
16
17    This library is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20    Lesser General Public License for more details.
21
22    You should have received a copy of the GNU Lesser General Public
23    License along with this library; if not, write to the Free Software
24    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25*************************************************************************/
26#ifndef _CEGUIEventArgs_h_
27#define _CEGUIEventArgs_h_
28
29#include "CEGUIBase.h"
30
31
32// Start of CEGUI namespace section
33namespace CEGUI
34{
35/*!
36\brief
37        Base class used as the argument to all subscribers Event object.
38
39        The base EventArgs class does not contain any useful information, it is intended
40        to be specialised for each type of event that can be generated by objects within
41        the system.  The use of this base class allows all event subscribers to have the
42        same function signature.
43
44        The \a handled field is used to signal whether an event was actually handled or not.  While
45        the event system does not look at this value, code at a higher level can use it to determine
46        how far to propagate an event.
47*/
48class CEGUIEXPORT EventArgs
49{
50public:
51        /*************************************************************************
52                Construction
53        *************************************************************************/
54        EventArgs(void) : handled(false) {}
55        virtual ~EventArgs(void) {}
56
57
58        /*************************************************************************
59                Data members
60        *************************************************************************/
61        bool    handled;                //!< handlers should set this to true if they handled the event, or false otherwise.
62};
63
64} // End of  CEGUI namespace section
65
66#endif  // end of guard _CEGUIEventArgs_h_
Note: See TracBrowser for help on using the repository browser.