diff options
Diffstat (limited to 'slideshow/source/inc/usereventqueue.hxx')
| -rw-r--r-- | slideshow/source/inc/usereventqueue.hxx | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/slideshow/source/inc/usereventqueue.hxx b/slideshow/source/inc/usereventqueue.hxx index bef6ccc824ce..c1d1f6cfbad2 100644 --- a/slideshow/source/inc/usereventqueue.hxx +++ b/slideshow/source/inc/usereventqueue.hxx @@ -2,7 +2,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 @@ -53,14 +53,14 @@ class MouseEnterHandler; class MouseLeaveHandler; /** This class schedules user-activated events. - + This class registeres at the EventMultiplexer and fires events registered for certain user actions. Note that all events will not be fired immediately after the user action occured, but always added to the EventQueue (and fired the next time that queue is processed). Which is actually a feature. - + Conceptually, an event is an object that typically is fired only once. After that, the event is exhausted, and should be discarded. Therefore, all events registered on @@ -71,11 +71,11 @@ class UserEventQueue : private ::boost::noncopyable { public: /** Create a user event queue - + @param rEventMultiplexer The slideshow-global event source, where this class registeres its event handlers. - + @param rEventQueue Reference to the main event queue. Since we hold this object by plain reference, it must live longer than we @@ -92,22 +92,22 @@ public: EventQueue& rEventQueue, CursorManager& rCursorManager ); ~UserEventQueue(); - + /** Query whether there are any events still pending. */ bool isEmpty() const; - + /** Clear all registered events. - + This method clears all registered, but not-yet-executed events. This comes in handy when force-ending a slide, to avoid interference with the next slide's event registration. */ void clear(); - + /** Set advance on click behaviour. - + @param bAdvanceOnClick When true, a click somewhere on the slide will also generate next effect event. In this case, it is @@ -115,28 +115,28 @@ public: i.e. the shape need not be hit by the mouse. */ void setAdvanceOnClick( bool bAdvanceOnClick ); - + /** Register an event that will be fired when the slide is just shown. - + Note that <em>all</em> registered events will be fired when the slide start occurs. This is in contrast to the mouse events below. */ void registerSlideStartEvent( const EventSharedPtr& rEvent ); - + /** Register an event that will be fired when the slide is about to vanish. - + Note that <em>all</em> registered events will be fired when the slide end occurs. This is in contrast to the mouse events below. */ void registerSlideEndEvent( const EventSharedPtr& rEvent ); - + /** Register an event that will be fired when the given animation node starts. - + Note that <em>all</em> registered events will be fired when the animation start occurs. This is in contrast to the mouse events below. @@ -145,10 +145,10 @@ public: const EventSharedPtr& rEvent, const ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode>& xNode ); - + /** Register an event that will be fired when the given animation node ends its active duration. - + Note that <em>all</em> registered events will be fired when the animation end occurs. This is in contrast to the mouse events below. @@ -157,10 +157,10 @@ public: const EventSharedPtr& rEvent, const ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode>& xNode ); - + /** Register an event that will be fired when audio output stopped for the given animation node. - + Note that <em>all</em> registered events will be fired when the audio stopping occurs. This is in contrast to the mouse events below. @@ -169,9 +169,9 @@ public: const EventSharedPtr& rEvent, const ::com::sun::star::uno::Reference< ::com::sun::star::animations::XAnimationNode>& xNode ); - + /** Register an event that is fired when a shape is clicked - + For every mouse click, only one of the events registered here is fired. The order of fired events is the order of registration, i.e. the first event @@ -180,7 +180,7 @@ public: */ void registerShapeClickEvent( const EventSharedPtr& rEvent, const ShapeSharedPtr& rShape ); - + /** Registes an event that is fired when the current effects(s) are skipped, .e.g. when the left mouse button is pressed. Then, all registered events are fired and removed from this @@ -196,16 +196,16 @@ public: void registerSkipEffectEvent( EventSharedPtr const& pEvent, const bool bSkipTriggersNextEffect); - + /** Registes an event that is fired when the current effects(s) are rewound, .e.g. when the right mouse button is pressed. Then, all registered events are fired and removed from this queue. */ void registerRewindEffectEvent( EventSharedPtr const& rEvent ); - + /** Register an event that is fired to show the next event - + For every next effect event, only one of the events registered here is fired. The order of fired events is the order of registration, i.e. the first event @@ -218,10 +218,10 @@ public: not be hit by the mouse. */ void registerNextEffectEvent( const EventSharedPtr& rEvent ); - + /** Register an event that is fired on a double mouse click on a shape - + For every mouse double click, only one of the events registered here is fired. The order of fired events is the order of registration, i.e. the first event @@ -232,9 +232,9 @@ public: */ void registerShapeDoubleClickEvent( const EventSharedPtr& rEvent, const ShapeSharedPtr& rShape ); - + /** Register an event that is fired on a double mouse click - + For every mouse double click, only one of the events registered here is fired. The order of fired events is the order of registration, i.e. the first event @@ -244,10 +244,10 @@ public: the mouse. */ void registerDoubleClickEvent( const EventSharedPtr& rEvent ); - + /** Register an event that is fired when the mouse enters the area of the given shape - + For every enter, only one of the events registered here is fired. The order of fired events is the order of registration, i.e. the first event registered will @@ -256,10 +256,10 @@ public: */ void registerMouseEnterEvent( const EventSharedPtr& rEvent, const ShapeSharedPtr& rShape ); - + /** Register an event that is fired when the mouse leaves the area of the given shape - + For every leave, only one of the events registered here is fired. The order of fired events is the order of registration, i.e. the first event registered will @@ -277,29 +277,29 @@ public: private: /** Generically register an event on one of the handlers. - + If the handler is not yet created, do that and register it via the Functor */ - template< typename Handler, typename Functor > + template< typename Handler, typename Functor > void registerEvent( ::boost::shared_ptr< Handler >& rHandler, const EventSharedPtr& rEvent, const Functor& rRegistrationFunctor ); - + /** Generically register an event on one of the handlers. - + If the handler is not yet created, do that and register it via the Functor. This version of the registerEvent method takes an additional parameter rArg, which is passed as the second argument to rHandler's addEvent() method. */ - template< typename Handler, typename Arg, typename Functor > + template< typename Handler, typename Arg, typename Functor > void registerEvent( ::boost::shared_ptr< Handler >& rHandler, const EventSharedPtr& rEvent, const Arg& rArg, const Functor& rRegistrationFunctor ); - + EventMultiplexer& mrMultiplexer; EventQueue& mrEventQueue; CursorManager& mrCursorManager; @@ -317,7 +317,7 @@ private: ::boost::shared_ptr<ClickEventHandler> mpDoubleClickEventHandler; ::boost::shared_ptr<MouseEnterHandler> mpMouseEnterHandler; ::boost::shared_ptr<MouseLeaveHandler> mpMouseLeaveHandler; - + bool mbAdvanceOnClick; }; |