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