Canvas: Support for preventDefault() on Events.

[simgear.git] / simgear / canvas / events / CustomEvent.hxx

diff --git a/simgear/canvas/events/CustomEvent.hxx b/simgear/canvas/events/CustomEvent.hxx
index cb48becc2f7af48a84ec2ce53790d7b070d358ff..524f4e67a549207b2bb94250ecbbc244b75d7ae0 100644 (file)
--- a/simgear/canvas/events/CustomEvent.hxx
+++ b/simgear/canvas/events/CustomEvent.hxx
@@ -1,4 +1,5 @@
-///@file Canvas user defined event
+///@file
+/// Canvas user defined event
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -27,6 +28,10 @@ namespace simgear
 namespace canvas
 {
 
+  /**
+   * User defined event (optionally carrying additional context information or
+   * data).
+   */
   class CustomEvent:
     public Event
   {
@@ -39,6 +44,7 @@ namespace canvas
        * @param data        Optional user data stored in event
        */
       CustomEvent( std::string const& type_str,
+                   bool bubbles = false,
                    StringMap const& data = StringMap() );
 
       /**
@@ -47,6 +53,7 @@ namespace canvas
        * @param data        Optional user data stored in event
        */
       CustomEvent( int type_id,
+                   bool bubbles = false,
                    StringMap const& data = StringMap() );
 
       /**