xref: /AOO41X/main/slideshow/source/inc/eventhandler.hxx (revision aaef562f9b4401da6d8a910634bb68eaaacb4ebd)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef INCLUDED_SLIDESHOW_EVENTHANDLER_HXX
25 #define INCLUDED_SLIDESHOW_EVENTHANDLER_HXX
26 
27 #include <boost/shared_ptr.hpp>
28 
29 
30 /* Definition of EventHandler interface */
31 
32 namespace slideshow
33 {
34     namespace internal
35     {
36 
37         /** Interface for event handling objects.
38 
39             Classes implementing this interface can be added to an
40             EventMultiplexer object, and are called from there to
41             handle events.
42          */
43         class EventHandler
44         {
45         public:
~EventHandler()46             virtual ~EventHandler() {}
47 
48             /** Handle the event.
49 
50                 @return true, if this handler has successfully
51                 processed the event. When this method returns false,
52                 possibly other, less prioritized handlers are called,
53                 too.
54              */
55             virtual bool handleEvent() = 0;
56         };
57 
58         typedef ::boost::shared_ptr< EventHandler > EventHandlerSharedPtr;
59 
60     }
61 }
62 
63 #endif /* INCLUDED_SLIDESHOW_EVENTHANDLER_HXX */
64