slideshow/source/inc/hyperlinkarea.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hyperlinkarea.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_HYPERLINKAREA_HXX
  32 #define INCLUDED_SLIDESHOW_HYPERLINKAREA_HXX
  33
  34 #include <boost/shared_ptr.hpp>
  35 #include <vector>
  36 #include <utility>
  37
  38 namespace rtl {
  39     class OUString;
  40 }
  41 namespace basegfx {
  42     class B2DRange;
  43 }
  44
  45 /* Definition of HyperlinkArea interface */
  46
  47 namespace slideshow
  48 {
  49     namespace internal
  50     {
  51         /** HyperlinkArea interface
  52
  53             Implementers of this interface provide information for
  54             hyperlink sensitive areas.
  55          */
  56         class HyperlinkArea
  57         {
  58         public:
  59             typedef std::pair< ::basegfx::B2DRange,
  60                                ::rtl::OUString >    HyperlinkRegion;
  61
  62             typedef std::vector<HyperlinkRegion>    HyperlinkRegions;
  63
  64             /** Request hyperlink-sensitive areas.
  65
  66                 @return a vector of hyperlink-sensitive areas, plus
  67                 the URI associated to them.
  68              */
  69             virtual HyperlinkRegions getHyperlinkRegions() const = 0;
  70
  71             /** Retrieve priority of link area
  72
  73                 @return the priority of the link area. Link areas with
  74                 higher priority will receive hyperlink clicks in favor
  75                 of areas with less priority, if they cover the same
  76                 place on screen.
  77              */
  78             virtual double getHyperlinkPriority() const = 0;
  79
  80             /** Functor struct, for area ordering
  81
  82                 This defines a strict weak ordering of areas, sort key
  83                 is the object ptr value. Most typical use is for
  84                 associative containers holding areas.
  85              */
  86             struct lessThanArea
  87             {
  88                 // make functor adaptable (to boost::bind)
  89                 typedef bool result_type;
  90
  91                 bool operator()(const boost::shared_ptr< HyperlinkArea >& rLHS,
  92                                 const boost::shared_ptr< HyperlinkArea >& rRHS) const
  93                 {
  94                     const double nPrioL( rLHS->getHyperlinkPriority() );
  95                     const double nPrioR( rRHS->getHyperlinkPriority() );
  96
  97                     // if prios are equal, tie-break on ptr value
  98                     return nPrioL == nPrioR ? rLHS.get() < rRHS.get() : nPrioL < nPrioR;
  99                 }
 100             };
 101        };
 102
 103         typedef boost::shared_ptr< HyperlinkArea > HyperlinkAreaSharedPtr;
 104     }
 105 }
 106
 107 #endif /* INCLUDED_SLIDESHOW_HYPERLINKAREA_HXX */