slideshow/source/inc/eventhandler.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef INCLUDED_SLIDESHOW_EVENTHANDLER_HXX
  30 #define INCLUDED_SLIDESHOW_EVENTHANDLER_HXX
  31
  32 #include <boost/shared_ptr.hpp>
  33
  34
  35 /* Definition of EventHandler interface */
  36
  37 namespace slideshow
  38 {
  39     namespace internal
  40     {
  41
  42         /** Interface for event handling objects.
  43
  44             Classes implementing this interface can be added to an
  45             EventMultiplexer object, and are called from there to
  46             handle events.
  47          */
  48         class EventHandler
  49         {
  50         public:
  51             virtual ~EventHandler() {}
  52
  53             /** Handle the event.
  54
  55                 @return true, if this handler has successfully
  56                 processed the event. When this method returns false,
  57                 possibly other, less prioritized handlers are called,
  58                 too.
  59              */
  60             virtual bool handleEvent() = 0;
  61         };
  62
  63         typedef ::boost::shared_ptr< EventHandler > EventHandlerSharedPtr;
  64
  65     }
  66 }
  67
  68 #endif /* INCLUDED_SLIDESHOW_EVENTHANDLER_HXX */
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */