Canvas: Support for preventDefault() on Events.

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

diff --git a/simgear/canvas/events/DeviceEvent.hxx b/simgear/canvas/events/DeviceEvent.hxx
index 8fc366a37cf0f75c964def7c86b846ea56ae4053..14d2aa4dd8f0f6b1ddc9393c321e2a764d4fbe5f 100644 (file)
--- a/simgear/canvas/events/DeviceEvent.hxx
+++ b/simgear/canvas/events/DeviceEvent.hxx
@@ -1,4 +1,5 @@
-///@file Input device event (keyboard/mouse)
+///@file
+/// Input device event (keyboard/mouse)
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -35,14 +36,25 @@ namespace canvas
     public Event
   {
     public:
+      /// Default initialization (no active keyboard modifier).
       DeviceEvent();
+
+      /// Initialize from an OpenSceneGraph event.
       DeviceEvent(const osgGA::GUIEventAdapter& ea);
 
+      /// Get mask of active keyboard modifiers at the time of the event.
       int getModifiers() const { return modifiers; }
 
+      /// Get if a Ctrl modifier was active.
       bool ctrlKey() const;
+
+      /// Get if a Shift modifier was active.
       bool shiftKey() const;
+
+      /// Get if an Alt modifier was active.
       bool altKey() const;
+
+      /// Get if a Meta modifier was active.
       bool metaKey() const;
 
     protected: