Files
libreoffice/slideshow/source/inc/shapesubset.hxx
Rüdiger Timm aa0a205e7c INTEGRATION: CWS presentationengine01 (1.1.2); FILE ADDED
2004/11/15 11:58:38 thb 1.1.2.4: #102922# Fixed various text effect issues, all revolving around the fact that subsetting can be recursive - engine must be able to subset an already subsetted shape
2004/10/08 20:08:18 thb 1.1.2.3: #i34997# Fixed several node state inconsistencies, which led to start/end activities not correctly updating the shapes; added proper updating behaviour to LayerManager (several display-changing cases were missing); fixed SLIDEWIPE for shape transitions; improved docs and structure slightly
2004/08/19 17:31:25 thb 1.1.2.2: #110496# Converted concrete shape class to interface, to support different shape flavours (actual trigger was the need to have video/sound objects). Fixed a problem for shape repaint, where instead of the correctly transformed bound rect the original shape bounds where taken
2004/08/11 15:56:01 thb 1.1.2.1: Initial revision
2004-11-26 18:20:20 +00:00

183 lines
6.5 KiB
C++

/*************************************************************************
*
* $RCSfile: shapesubset.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: rt $ $Date: 2004-11-26 19:20:20 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _SLIDESHOW_SHAPESUBSET_HXX
#define _SLIDESHOW_SHAPESUBSET_HXX
#include <attributableshape.hxx>
#include <layermanager.hxx>
#include <doctreenode.hxx>
#ifndef BOOST_SHARED_PTR_HPP_INCLUDED
#include <boost/shared_ptr.hpp>
#endif
namespace presentation
{
namespace internal
{
class ShapeSubset;
typedef ::boost::shared_ptr< ShapeSubset > ShapeSubsetSharedPtr;
/* Definition of ShapeSubset class */
/** Subset RAII wrapper for shapes.
This class wraps the plain Shape with a wrapper for subset
functionality. Subsetting can be turned on and off. Note
that the reason to have shape subsetting RAII implemented
separately (i.e. not within the DrawShape) was that
subsetting (and de-subsetting) needs the LayerManager. And
holding that at the DrawShape creates one heck of a
circular reference.
*/
class ShapeSubset
{
public:
/** Create a subset directly from a Shape.
@param rOriginalShape
Original shape to subset
@param rTreeNode
Subset this object should represent
@param rLayerManager
Manager object, where subsets are
registered/unregistered
*/
ShapeSubset( const AttributableShapeSharedPtr& rOriginalShape,
const DocTreeNode& rTreeNode,
const LayerManagerSharedPtr& rLayerManager );
/** Create a subset from another subset.
Note: if you want this subset to subtract from the
passed subset reference (and not from the original,
unsubsetted shape), the passed subset must be enabled
(enableSubsetShape() must have been called)
@param rOriginalSubset
Original subset, which to subset again.
@param rTreeNode
Subset of the original subset
*/
ShapeSubset( const ShapeSubsetSharedPtr& rOriginalSubset,
const DocTreeNode& rTreeNode );
/** Create full set for the given shape.
@param rOriginalShape
Original shape, which will be represented as a whole
by this object
*/
ShapeSubset( const AttributableShapeSharedPtr& rOriginalShape,
const LayerManagerSharedPtr& rLayerManager );
~ShapeSubset();
/** Get the actual subset shape.
If the subset is currently revoked, this method
returns the original shape.
*/
AttributableShapeSharedPtr getSubsetShape() const;
/** Enable the subset shape.
This method enables the subset. That means, on
successful completion of this method, the original
shape will cease to show the subset range, and
getSubsetShape() will return a valid shape.
@return true, if subsetting was successfully enabled.
*/
bool enableSubsetShape();
/** Disable the subset shape.
This method revokes the subset from the original
shape. That means, the original shape will again show
the hidden range.
*/
void disableSubsetShape();
/** Query whether this subset actually is none, but
contains the whole original shape's content
*/
bool isFullSet() const;
private:
// default copy/assignment are okay
//ShapeSubset(const ShapeSubset&);
//ShapeSubset& operator=( const ShapeSubset& );
AttributableShapeSharedPtr mpOriginalShape;
AttributableShapeSharedPtr mpSubsetShape;
DocTreeNode maTreeNode;
LayerManagerSharedPtr mpLayerManager;
};
}
}
#endif /* _SLIDESHOW_SHAPESUBSET_HXX */