1 ///@file Canvas user defined event
3 // Copyright (C) 2014 Thomas Geymayer <tomgey@gmail.com>
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Library General Public
7 // License as published by the Free Software Foundation; either
8 // version 2 of the License, or (at your option) any later version.
10 // This library 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 GNU
13 // Library General Public License for more details.
15 // You should have received a copy of the GNU Library General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 #ifndef CANVAS_CUSTOM_EVENT_HXX_
20 #define CANVAS_CUSTOM_EVENT_HXX_
22 #include <simgear/canvas/CanvasEvent.hxx>
23 #include <simgear/structure/map.hxx>
37 * @param type_str Event type name (if name does not exist yet it will
38 * be registered as new event type)
39 * @param data Optional user data stored in event
41 CustomEvent( std::string const& type_str,
43 StringMap const& data = StringMap() );
47 * @param type_id Event type id
48 * @param data Optional user data stored in event
50 CustomEvent( int type_id,
52 StringMap const& data = StringMap() );
57 void setDetail(StringMap const& data);
62 StringMap const& getDetail() const { return detail; }
64 virtual bool canBubble() const { return bubbles; }
66 StringMap detail; //<! user data map
71 } // namespace simgear
73 #endif /* CANVAS_CUSTOM_EVENT_HXX_ */