94 lines
2.8 KiB
C++
94 lines
2.8 KiB
C++
///@file
|
|
/// Canvas user defined event
|
|
//
|
|
// Copyright (C) 2014 Thomas Geymayer <tomgey@gmail.com>
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Library General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 2 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Library General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Library General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
#ifndef CANVAS_CUSTOM_EVENT_HXX_
|
|
#define CANVAS_CUSTOM_EVENT_HXX_
|
|
|
|
#include <simgear/canvas/CanvasEvent.hxx>
|
|
#include <simgear/structure/map.hxx>
|
|
|
|
namespace simgear
|
|
{
|
|
namespace canvas
|
|
{
|
|
|
|
/**
|
|
* User defined event (optionally carrying additional context information or
|
|
* data).
|
|
*/
|
|
class CustomEvent:
|
|
public Event
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* @brief Construct a user defined event from a type string
|
|
*
|
|
* @param type_str Event type name (if name does not exist yet it will
|
|
* be registered as new event type)
|
|
* @param bubbles If this event should take part in the bubbling phase
|
|
* @param data Optional user data stored in event
|
|
*/
|
|
CustomEvent( std::string const& type_str,
|
|
bool bubbles = false,
|
|
StringMap const& data = StringMap() );
|
|
|
|
/**
|
|
* @brief Construct a user defined event from a (previously registered)
|
|
* type id
|
|
*
|
|
* @see getOrRegisterType()
|
|
*
|
|
* @param type_id Event type id
|
|
* @param bubbles If this event should take part in the bubbling phase
|
|
* @param data Optional user data stored in event
|
|
*/
|
|
CustomEvent( int type_id,
|
|
bool bubbles = false,
|
|
StringMap const& data = StringMap() );
|
|
|
|
CustomEvent* clone(int type = 0) const override;
|
|
|
|
/**
|
|
* Set user data
|
|
*/
|
|
void setDetail(StringMap const& data);
|
|
|
|
/**
|
|
* Get user data
|
|
*/
|
|
StringMap const& getDetail() const { return detail; }
|
|
|
|
/**
|
|
* Get whether this event supports bubbling.
|
|
*
|
|
* @see #bubbles
|
|
* @see CustomEvent()
|
|
*/
|
|
bool canBubble() const override { return bubbles; }
|
|
|
|
StringMap detail; //!< User data map
|
|
bool bubbles; //!< Whether the event supports bubbling
|
|
};
|
|
|
|
} // namespace canvas
|
|
} // namespace simgear
|
|
|
|
#endif /* CANVAS_CUSTOM_EVENT_HXX_ */
|