slideshow/source/inc/shapemanager.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: shapemanager.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_SHAPEMANAGER_HXX
  32 #define INCLUDED_SLIDESHOW_SHAPEMANAGER_HXX
  33
  34 #include "disposable.hxx"
  35 #include <com/sun/star/uno/Reference.hxx>
  36 #include <boost/shared_ptr.hpp>
  37
  38 namespace com {  namespace sun { namespace star { namespace drawing {
  39     class XShape;
  40 } } } }
  41
  42 /* Definition of ShapeManager interface */
  43
  44 namespace slideshow
  45 {
  46     namespace internal
  47     {
  48         class HyperlinkArea;
  49         class AnimatableShape;
  50         class Shape;
  51
  52         /** ShapeManager interface
  53
  54             Implementers of this interface manage appearance and
  55             animation of slideshow shapes.
  56          */
  57         class ShapeManager : public Disposable
  58         {
  59         public:
  60             /** Notify the ShapeManager that the given Shape starts an
  61                 animation now.
  62
  63                 This method enters animation mode for the Shape. If
  64                 the shape is already in animation mode, the call is
  65                 counted, and the shape only leaves animation mode
  66                 after a corresponding number of leaveAnimationMode()
  67                 calls.
  68              */
  69             virtual void enterAnimationMode( const boost::shared_ptr<AnimatableShape>& rShape ) = 0;
  70
  71             /** Notify the ShapeManager that the given Shape is no
  72                 longer animated.
  73
  74                 When called a corresponding number of times as
  75                 enterAnimationMode() for a given shape, this methods
  76                 ends animation mode for the given Shape. It is illegal
  77                 to call this method more often than
  78                 enterAnimationMode().
  79              */
  80             virtual void leaveAnimationMode( const boost::shared_ptr<AnimatableShape>& rShape ) = 0;
  81
  82             /** Notify that a shape needs an update
  83
  84                 This method notifies the ShapeManager that a shape
  85                 update is necessary. Use this if e.g. a running
  86                 animation changed the shape appearance.
  87
  88                 @param rShape
  89                 Shape which needs an update
  90              */
  91             virtual void notifyShapeUpdate( const boost::shared_ptr<Shape>& rShape ) = 0;
  92
  93             /** Lookup a Shape from an XShape model object
  94
  95                 This method looks up the internal shape map for one
  96                 representing the given XShape.
  97
  98                 @param xShape
  99                 The XShape object, for which the representing Shape
 100                 should be looked up.
 101              */
 102             virtual boost::shared_ptr<Shape> lookupShape(
 103                 ::com::sun::star::uno::Reference<
 104                     ::com::sun::star::drawing::XShape > const & xShape ) const = 0;
 105
 106             /** Register given shape as a hyperlink target
 107
 108                 @param rArea
 109                 Hyperlink sensitive area. Will participate in
 110                 hyperlink region lookup. Must be in absolute user
 111                 space coordinates.
 112              */
 113             virtual void addHyperlinkArea( const boost::shared_ptr<HyperlinkArea>& rArea ) = 0;
 114
 115             /** Unregister given shape as a hyperlink target
 116
 117                 @param rArea
 118                 Hyperlink sensitive area. Will cease to participate in
 119                 hyperlink region lookup.
 120              */
 121             virtual void removeHyperlinkArea( const boost::shared_ptr<HyperlinkArea>& rArea ) = 0;
 122         };
 123
 124         typedef ::boost::shared_ptr< ShapeManager > ShapeManagerSharedPtr;
 125     }
 126 }
 127
 128 #endif /* INCLUDED_SLIDESHOW_SHAPEMANAGER_HXX */