slideshow/source/inc/hyperlinkhandler.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_HYPERLINKHANDLER_HXX
  21 #define INCLUDED_SLIDESHOW_HYPERLINKHANDLER_HXX
  22
  23 #include <boost/shared_ptr.hpp>
  24
  25
  26 /* Definition of EventHandler interface */
  27
  28 namespace slideshow
  29 {
  30     namespace internal
  31     {
  32
  33         /** Interface for handling hyperlink clicks.
  34
  35             Classes implementing this interface can be added to an
  36             EventMultiplexer object, and are called from there to
  37             handle hyperlink events.
  38          */
  39         class HyperlinkHandler
  40         {
  41         public:
  42             /** Handle the event.
  43
  44                 @param rLink
  45                 The actual hyperlink URI
  46
  47                 @return true, if this handler has successfully
  48                 processed the event. When this method returns false,
  49                 possibly other, less prioritized handlers are called,
  50                 too.
  51              */
  52             virtual bool handleHyperlink( OUString const& rLink ) = 0;
  53
  54         protected:
  55             ~HyperlinkHandler() {}
  56         };
  57
  58         typedef ::boost::shared_ptr< HyperlinkHandler > HyperlinkHandlerSharedPtr;
  59
  60     }
  61 }
  62
  63 #endif /* INCLUDED_SLIDESHOW_HYPERLINKHANDLER_HXX */
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */