slideshow/source/inc/shapesubset.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_SHAPESUBSET_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_SHAPESUBSET_HXX
  22
  23 #include "subsettableshapemanager.hxx"
  24 #include "doctreenode.hxx"
  25
  26 #include <memory>
  27
  28 namespace slideshow::internal
  29     {
  30         class ShapeSubset;
  31         typedef ::std::shared_ptr< ShapeSubset > ShapeSubsetSharedPtr;
  32
  33         /* Definition of ShapeSubset class */
  34
  35         /** Subset RAII wrapper for shapes.
  36
  37             This class wraps the plain Shape with a wrapper for subset
  38             functionality. Subsetting can be turned on and off. Note
  39             that the reason to have shape subsetting RAII implemented
  40             separately (i.e. not within the DrawShape) was that
  41             subsetting (and de-subsetting) needs the
  42             SubsettableShapeManager. And holding that at the DrawShape
  43             creates one heck of a circular reference.
  44          */
  45         class ShapeSubset
  46         {
  47         public:
  48             /** Create a subset directly from a Shape.
  49
  50                 @param rOriginalShape
  51                 Original shape to subset
  52
  53                 @param rTreeNode
  54                 Subset this object should represent
  55
  56                 @param rShapeManager
  57                 Manager object, where subsets are
  58                 registered/unregistered
  59              */
  60             ShapeSubset( AttributableShapeSharedPtr              xOriginalShape,
  61                          const DocTreeNode&                      rTreeNode,
  62                          SubsettableShapeManagerSharedPtr        xSubsetManager );
  63
  64             /** Create a subset from another subset.
  65
  66                 Note: if you want this subset to subtract from the
  67                 passed subset reference (and not from the original,
  68                 unsubsetted shape), the passed subset must be enabled
  69                 (enableSubsetShape() must have been called)
  70
  71                 @param rOriginalSubset
  72                 Original subset, which to subset again.
  73
  74                 @param rTreeNode
  75                 Subset of the original subset
  76              */
  77             ShapeSubset( const ShapeSubsetSharedPtr&        rOriginalSubset,
  78                          const DocTreeNode&                 rTreeNode );
  79
  80             /** Create full set for the given shape.
  81
  82                 @param rOriginalShape
  83                 Original shape, which will be represented as a whole
  84                 by this object
  85              */
  86             ShapeSubset( AttributableShapeSharedPtr        xOriginalShape,
  87                          SubsettableShapeManagerSharedPtr  xShapeManager );
  88
  89             ~ShapeSubset();
  90
  91             // For a rationale for this hacky combination of user-provided dtor, defaulted copy
  92             // ctor, and deleted copy assignment op, see the "TODO(Q1)" comment in
  93             // CloningNodeCreator (slideshow/source/engine/animationnodes/animationnodefactory.cxx):
  94             ShapeSubset(ShapeSubset const &) = default;
  95             void operator =(ShapeSubset const &) = delete;
  96
  97             /** Get the actual subset shape.
  98
  99                 If the subset is currently revoked, this method
 100                 returns the original shape.
 101              */
 102             AttributableShapeSharedPtr const &  getSubsetShape() const;
 103
 104             /** Enable the subset shape.
 105
 106                 This method enables the subset. That means, on
 107                 successful completion of this method, the original
 108                 shape will cease to show the subset range, and
 109                 getSubsetShape() will return a valid shape.
 110              */
 111             void            enableSubsetShape();
 112
 113             /** Disable the subset shape.
 114
 115                 This method revokes the subset from the original
 116                 shape. That means, the original shape will again show
 117                 the hidden range.
 118              */
 119             void            disableSubsetShape();
 120
 121             /** Query whether this subset actually is none, but
 122                 contains the whole original shape's content
 123              */
 124             bool isFullSet() const;
 125
 126             /** Query subset this object represents
 127              */
 128             const DocTreeNode& getSubset() const;
 129
 130         private:
 131             // default copy/assignment are okay
 132             //ShapeSubset(const ShapeSubset&);
 133             //ShapeSubset& operator=( const ShapeSubset& );
 134
 135             AttributableShapeSharedPtr       mpOriginalShape;
 136             AttributableShapeSharedPtr       mpSubsetShape;
 137             DocTreeNode                      maTreeNode;
 138             SubsettableShapeManagerSharedPtr mpShapeManager;
 139         };
 140
 141 }
 142
 143 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_SHAPESUBSET_HXX
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */