summaryrefslogtreecommitdiff
path: root/slideshow/source/inc/event.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'slideshow/source/inc/event.hxx')
-rw-r--r--slideshow/source/inc/event.hxx16
1 files changed, 8 insertions, 8 deletions
diff --git a/slideshow/source/inc/event.hxx b/slideshow/source/inc/event.hxx
index 8acd93c0d108..dfc8ca1965c5 100644
--- a/slideshow/source/inc/event.hxx
+++ b/slideshow/source/inc/event.hxx
@@ -1,7 +1,7 @@
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
+ *
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
@@ -46,30 +46,30 @@ public:
#endif
/** Execute the event.
-
+
@return true, if event was successfully executed.
*/
virtual bool fire() = 0;
-
+
/** Query whether this event is still charged, i.e. able
to fire.
-
+
Inactive events are ignored by the normal event
containers (EventQueue, UserEventQueue etc.), and no
explicit fire() is called upon them.
-
+
@return true, if this event has already been fired.
*/
virtual bool isCharged() const = 0;
-
+
/** Query the activation time instant this event shall be
fired, if it was inserted at instant nCurrentTime into
the queue.
-
+
@param nCurrentTime
The time from which the activation time is to be
calculated from.
-
+
@return the time instant in seconds, on which this
event is to be fired.
*/