slideshow/source/inc/subsettableshapemanager.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: subsettableshapemanager.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_SUBSETTABLESHAPEMANAGER_HXX
  32 #define INCLUDED_SLIDESHOW_SUBSETTABLESHAPEMANAGER_HXX
  33
  34 #include "shapemanager.hxx"
  35 #include "intrinsicanimationeventhandler.hxx"
  36 #include <boost/shared_ptr.hpp>
  37
  38 /* Definition of SubsettableShapeManager interface */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44         class DocTreeNode;
  45         class AttributableShape;
  46
  47         /** SubsettableShapeManager interface
  48
  49             Implementers of this interface manage creation and
  50             revocation of shape subsets. Shape subsets are shapes that
  51             represent (and animate) only parts of an original's shape
  52             content.
  53          */
  54         class SubsettableShapeManager : public ShapeManager
  55         {
  56         public:
  57             /** Query a subset of the given original shape
  58
  59                 This method queries a new (but not necessarily unique)
  60                 shape, which displays only the given subset of the
  61                 original one. Calling this method multiple times with
  62                 the same original shape and DocTreeNode content always
  63                 returns the same shape.
  64
  65                 Requesting a subset from an original shape leads to
  66                 the original shape ceasing to display the subsetted
  67                 content. In other words, shape content is always
  68                 displayed in exactly one shape.
  69
  70                 @param rOrigShape
  71                 The shape the subset is to be created for
  72
  73                 @param rSubsetShape
  74                 The subset to display in the generated shape.
  75              */
  76             virtual boost::shared_ptr<AttributableShape> getSubsetShape(
  77                 const boost::shared_ptr<AttributableShape>& rOrigShape,
  78                 const DocTreeNode&                          rTreeNode ) = 0;
  79
  80             /** Revoke a previously queried subset shape.
  81
  82                 With this method, a previously requested subset shape
  83                 is revoked again. If the last client revokes a given
  84                 subset, it will cease to be displayed, and the
  85                 original shape will again show the subset data.
  86
  87                 @param rOrigShape
  88                 The shape the subset was created from
  89
  90                 @param rSubsetShape
  91                 The subset created from rOrigShape
  92              */
  93             virtual void revokeSubset(
  94                 const boost::shared_ptr<AttributableShape>& rOrigShape,
  95                 const boost::shared_ptr<AttributableShape>& rSubsetShape ) = 0;
  96
  97             // Evil hackish way of getting intrinsic animation slide-wise
  98
  99             /** Register an event handler that will be called when
 100                 user paint parameters change.
 101
 102                 @param rHandler
 103                 Handler to call when a shape listener changes
 104             */
 105             virtual void addIntrinsicAnimationHandler( const IntrinsicAnimationEventHandlerSharedPtr& rHandler ) = 0;
 106             virtual void removeIntrinsicAnimationHandler( const IntrinsicAnimationEventHandlerSharedPtr& rHandler ) = 0;
 107
 108             /** Notify that shape-intrinsic animations are now enabled.
 109
 110                 @return true, if this event was processed by
 111                 anybody. If false is returned, no handler processed
 112                 this event (and probably, nothing will happen at all)
 113             */
 114             virtual bool notifyIntrinsicAnimationsEnabled() = 0;
 115
 116             /** Notify that shape-intrinsic animations are now disabled.
 117
 118                 @return true, if this event was processed by
 119                 anybody. If false is returned, no handler processed
 120                 this event (and probably, nothing will happen at all)
 121             */
 122             virtual bool notifyIntrinsicAnimationsDisabled() = 0;
 123         };
 124
 125         typedef ::boost::shared_ptr< SubsettableShapeManager > SubsettableShapeManagerSharedPtr;
 126     }
 127 }
 128
 129 #endif /* INCLUDED_SLIDESHOW_SUBSETTABLESHAPEMANAGER_HXX */