2 /// Canvas user defined event
4 // Copyright (C) 2014 Thomas Geymayer <tomgey@gmail.com>
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Library General Public
8 // License as published by the Free Software Foundation; either
9 // version 2 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Library General Public License for more details.
16 // You should have received a copy of the GNU Library General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 #ifndef CANVAS_CUSTOM_EVENT_HXX_
21 #define CANVAS_CUSTOM_EVENT_HXX_
23 #include <simgear/canvas/CanvasEvent.hxx>
24 #include <simgear/structure/map.hxx>
32 * User defined event (optionally carrying additional context information or
42 * @param type_str Event type name (if name does not exist yet it will
43 * be registered as new event type)
44 * @param data Optional user data stored in event
46 CustomEvent( std::string const& type_str,
48 StringMap const& data = StringMap() );
52 * @param type_id Event type id
53 * @param data Optional user data stored in event
55 CustomEvent( int type_id,
57 StringMap const& data = StringMap() );
62 void setDetail(StringMap const& data);
67 StringMap const& getDetail() const { return detail; }
69 virtual bool canBubble() const { return bubbles; }
71 StringMap detail; //<! user data map
76 } // namespace simgear
78 #endif /* CANVAS_CUSTOM_EVENT_HXX_ */