1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_SLIDESHOW_SHAPESUBSET_HXX
#define INCLUDED_SLIDESHOW_SHAPESUBSET_HXX
#include "attributableshape.hxx"
#include "subsettableshapemanager.hxx"
#include "doctreenode.hxx"
#include <boost/shared_ptr.hpp>
namespace slideshow
{
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
SubsettableShapeManager. 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 rShapeManager
Manager object, where subsets are
registered/unregistered
*/
ShapeSubset( const AttributableShapeSharedPtr& rOriginalShape,
const DocTreeNode& rTreeNode,
const SubsettableShapeManagerSharedPtr& rSubsetManager );
/** 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 SubsettableShapeManagerSharedPtr& rShapeManager );
~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;
/** Query subset this object represents
*/
DocTreeNode getSubset() const;
private:
// default copy/assignment are okay
//ShapeSubset(const ShapeSubset&);
//ShapeSubset& operator=( const ShapeSubset& );
AttributableShapeSharedPtr mpOriginalShape;
AttributableShapeSharedPtr mpSubsetShape;
DocTreeNode maTreeNode;
SubsettableShapeManagerSharedPtr mpShapeManager;
};
}
}
#endif /* INCLUDED_SLIDESHOW_SHAPESUBSET_HXX */
|
