Event.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \brief Default events used with application framework.
22 
23  \details These are default event classes that can be sent by the application framework.
24  Event classes can contain anything as members, such as pointers, instances or any information that can be usefull
25  for the application. These may be classes as simple as possible with public members to facilitate the access.
26 
27  \note Events MAY NOT gets the ownership of its internal pointers.
28 */
29 
30 /*!
31  \file Event.h
32 
33  \brief Contains a base class for application events.
34 */
35 
36 #ifndef __TERRALIB_QT_AF_EVENTS_INTERNAL_EVENT_H
37 #define __TERRALIB_QT_AF_EVENTS_INTERNAL_EVENT_H
38 
39 namespace te
40 {
41  namespace qt
42  {
43  namespace af
44  {
45  namespace evt
46  {
47  /*!
48  \struct Event
49 
50  \brief A base class for application events.
51 
52  This is the type of event that components and plugins may
53  use to notify changes in the application state.
54 
55  One must specialize this class in order to notify specific events.
56 
57  \ingroup af
58  */
59  struct Event
60  {
61  /*!
62  \brief Constructor.
63  */
64 
65  Event(const int& id)
66  {
67  m_id = id;
68  }
69 
70  int m_id; //!< Identifier.
71  };
72  }
73  } // end namespace af
74  } // end namespace qt
75 } // end namespace te
76 
77 #endif // __TERRALIB_QT_AF_EVENTS_INTERNAL_EVENT_H
78 
Event(const int &id)
Constructor.
Definition: Event.h:65
A base class for application events.
Definition: Event.h:59
int m_id
Identifier.
Definition: Event.h:70
URI C++ Library.