?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
update dev300-m58
[ooovba.git] / slideshow / source / inc / shapeattributelayer.hxx
blobe73f7e3cf924aa9dfc2d0d0210e606e5ebb25dac
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: shapeattributelayer.hxx,v $
10 * $Revision: 1.8.30.1 $
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_SHAPEATTRIBUTELAYER_HXX
32 #define INCLUDED_SLIDESHOW_SHAPEATTRIBUTELAYER_HXX
33
34 #include <com/sun/star/drawing/FillStyle.hpp>
35 #include <com/sun/star/drawing/LineStyle.hpp>
36 #include <com/sun/star/awt/FontSlant.hpp>
37
38 #include <basegfx/vector/b2dsize.hxx>
39 #include <basegfx/point/b2dpoint.hxx>
40 #include <basegfx/range/b2drectangle.hxx>
41 #include <basegfx/polygon/b2dpolypolygon.hxx>
42
43 #include "state.hxx"
44 #include "rgbcolor.hxx"
45
46 #include <stack>
47 #include <boost/shared_ptr.hpp>
48
49
50 namespace slideshow
51 {
52 namespace internal
53 {
54 class ShapeAttributeLayer;
55
56 typedef ::boost::shared_ptr< ShapeAttributeLayer > ShapeAttributeLayerSharedPtr;
57
58 /** Encapsulates all modifiable attributes of a shape.
59
60 This class holds all modifiable attributes of a shape, and
61 at the same time provides means to layer attributes on top
62 of each other..
63
64 And yes, there's a reason why we even pass bools and ints
65 by const reference. Namely, that makes the set* methods
66 differ only in the value type, which greatly reduces
67 template variability (e.g. in AnimationFactory).
68 */
69 class ShapeAttributeLayer
70 {
71 public:
72 /** Create a ShapeAttributeLayer instance, with all
73 attributes set to default.
74
75 Furthermore, this constructor gets a pointer to a
76 child layer, which is used as the fallback (or the
77 base value) for all attributes
78
79 @param rChildLayer
80 Layer below this one
81
82 @attention
83 This method is only supposed to be called from Shape objects
84 */
85 explicit ShapeAttributeLayer( const ShapeAttributeLayerSharedPtr& rChildLayer );
86
87 // Children management methods
88 //------------------------------------------------------------------
89
90 /** Revoke the given layer.
91
92 This method revokes the given layer from this object
93 or one of the children. That is, if this object does
94 have children, and the given layer is no direct child,
95 it is recursively passed to the children for removal.
96
97 @return true, if removal was successful.
98
99 @attention
100 This method is only supposed to be called from Shape objects
101 */
102 bool revokeChildLayer( const ShapeAttributeLayerSharedPtr& rChildLayer );
103
104 /** Query the child layer of this object.
105
106 @attention
107 This method is only supposed to be called from Shape objects
108 */
109 ShapeAttributeLayerSharedPtr getChildLayer() const;
110
111 /** Set the additive mode for possible child attributes
112
113 This method sets the additive mode for child
114 attributes. That is the way underlying attribute
115 layers are combined with this one (i.e. to overrule
116 lower layers, or how to combine the values). The
117 default is
118 ::com::sun::star::animations::AnimationAdditiveMode::BASE,
119 which means, take the value of the underlying layers,
120 or from the model shape itself.
121
122 @param nMode
123 Must be one of
124 ::com::sun::star::animations::AnimationAdditiveMode.
125 */
126 void setAdditiveMode( sal_Int16 nMode );
127
128 // Attribute methods
129 //------------------------------------------------------------------
130
131 /** Query whether the width attribute is valid.
132 */
133 bool isWidthValid() const;
134 /** Query the current width of the shape
135 */
136 double getWidth() const;
137 /** Set the new width of the shape
138
139 @param rNewWidth
140 A negative width mirrors the shape.
141 */
142 void setWidth( const double& rNewWidth );
143
144 /** Query whether the height attribute is valid.
145 */
146 bool isHeightValid() const;
147 /** Query the current height of the shape
148 */
149 double getHeight() const;
150 /** Set the new height of the shape
151
152 @param rNewHeight
153 A negative height mirrors the shape.
154 */
155 void setHeight( const double& rNewHeight );
156
157 /** Set the new size of the shape
158
159 @param rNewSize
160 A negative size mirrors the shape.
161 */
162 void setSize( const ::basegfx::B2DSize& rNewSize );
163
164 /** Query whether the x position attribute is valid
165 */
166 bool isPosXValid() const;
167 /** Query the current x position of the shape.
168
169 The current x position of the shape is always relative
170 to the <em>center</em> of the shape (in contrast to
171 the Shape::getBounds() and Shape::getUpdateArea()
172 methods).
173 */
174 double getPosX() const;
175 /** Set the new x position of the shape
176
177 The current x position of the shape is always relative
178 to the <em>center</em> of the shape (in contrast to
179 the Shape::getBounds() and Shape::getUpdateArea()
180 methods).
181 */
182 void setPosX( const double& rNewX );
183
184 /** Query whether the y position attribute is valid
185 */
186 bool isPosYValid() const;
187 /** Query the current y position of the shape
188
189 The current y position of the shape is always relative
190 to the <em>center</em> of the shape (in contrast to
191 the Shape::getBounds() and Shape::getUpdateArea()
192 methods).
193 */
194 double getPosY() const;
195 /** Set the new y position of the shape
196
197 The current y position of the shape is always relative
198 to the <em>center</em> of the shape (in contrast to
199 the Shape::getBounds() and Shape::getUpdateArea()
200 methods).
201 */
202 void setPosY( const double& rNewY );
203
204 /** Set the new position of the shape
205
206 The current position of the shape is always relative
207 to the <em>center</em> of the shape (in contrast to
208 the Shape::getBounds() and Shape::getUpdateArea()
209 methods).
210 */
211 void setPosition( const ::basegfx::B2DPoint& rNewPos );
212
213 /** Query whether the rotation angle attribute is valid
214 */
215 bool isRotationAngleValid() const;
216 /** Query the current rotation angle of the shape
217
218 @return the rotation angle in degrees.
219 */
220 double getRotationAngle() const;
221 /** Set the new rotation angle of the shape
222
223 @param rNewAngle
224 New rotation angle in degrees.
225 */
226 void setRotationAngle( const double& rNewAngle );
227
228 /** Query whether the shear x angle attribute is valid
229 */
230 bool isShearXAngleValid() const;
231 /** Query the current shear angle at the x axis of the shape
232
233 @return the shear angle in degrees.
234 */
235 double getShearXAngle() const;
236 /** Set the new shear angle at the x axis of the shape
237
238 @param rNewAngle
239 New shear angle in radians.
240 */
241 void setShearXAngle( const double& rNewAngle );
242
243 /** Query whether the shear y angle attribute is valid
244 */
245 bool isShearYAngleValid() const;
246 /** Query the current shear angle at the y axis of the shape
247
248 @return the shear angle in degrees.
249 */
250 double getShearYAngle() const;
251 /** Set the new shear angle at the y axis of the shape
252
253 @param rNewAngle
254 New shear angle in radians.
255 */
256 void setShearYAngle( const double& rNewAngle );
257
258 /** Query whether the alpha attribute is valid
259 */
260 bool isAlphaValid() const;
261 /** Query the current alpha value of the shape
262 */
263 double getAlpha() const;
264 /** Set the new alpha value of the shape
265
266 @param rNewValue
267 New alpha value, must be in the [0,1] range
268 */
269 void setAlpha( const double& rNewValue );
270
271 /** Query whether the clip attribute is valid
272 */
273 bool isClipValid() const;
274 /** Query the current clip polygon of the shape
275 */
276 ::basegfx::B2DPolyPolygon getClip() const;
277 /** Set the new clip polygon of the shape
278
279 @param rNewClip
280 New clip polygon, is interpreted in shape view coordinates, but
281 relative to the shape (i.e. the origin of the shape coincides
282 with the origin of the clip polygon).
283 */
284 void setClip( const ::basegfx::B2DPolyPolygon& rNewClip );
285
286 /** Query whether the dim color attribute is valid
287
288 The dim color globally 'dims' the shape towards that
289 color
290 */
291 bool isDimColorValid() const;
292 /** Get the dim color for the whole shape.
293 */
294 RGBColor getDimColor() const;
295 /** Set the dim color globally for the whole shape.
296 */
297 void setDimColor( const RGBColor& nNewColor );
298
299 /** Query whether the fill color attribute is valid
300 */
301 bool isFillColorValid() const;
302 /** Get the fill color for the whole shape.
303
304 If there's no unique fill color, the color from the
305 first filled polygon is returned.
306 */
307 RGBColor getFillColor() const;
308 /** Set the fill color globally for the whole shape.
309 */
310 void setFillColor( const RGBColor& nNewColor );
311
312 /** Query whether the line color attribute is valid
313 */
314 bool isLineColorValid() const;
315 /** Get the line color for the whole shape.
316
317 If there's no unique line color, the color from the
318 first line is returned.
319 */
320 RGBColor getLineColor() const;
321 /** Set the line color globally for the whole shape.
322 */
323 void setLineColor( const RGBColor& nNewColor );
324
325 /** Query whether the fill mode attribute is valid
326 */
327 bool isFillStyleValid() const;
328 /** Get the current fill mode for polygon fillings.
329
330 @returns the current style
331 */
332 sal_Int16 getFillStyle() const;
333 /** Changes polygon fillings.
334 */
335 void setFillStyle( const sal_Int16& rStyle );
336
337 /** Query whether the line mode attribute is valid
338 */
339 bool isLineStyleValid() const;
340 /** Get the current line mode for line drawing.
341
342 @returns the current line style
343 */
344 sal_Int16 getLineStyle() const;
345 /** Set line style for the whole shape
346 */
347 void setLineStyle( const sal_Int16& rStyle );
348
349 /** Query whether the visibility state attribute is valid
350 */
351 bool isVisibilityValid() const;
352 /** Get the current shape visibility.
353
354 @returns true for visible, false for invisible.
355 */
356 bool getVisibility() const;
357 /** Set the shape visibility
358 */
359 void setVisibility( const bool& bVisible );
360
361 /** Query whether the char color attribute is valid
362 */
363 bool isCharColorValid() const;
364 /** Get the text color for the whole shape.
365
366 If there's no unique text color, the color from the
367 first text drawn is returned.
368 */
369 RGBColor getCharColor() const;
370 /** Set the text color globally for the whole shape.
371 */
372 void setCharColor( const RGBColor& nNewColor );
373
374 /** Query whether the char rotation angle attribute is valid
375 */
376 bool isCharRotationAngleValid() const;
377 /** Query the current text rotation angle of the shape
378
379 @return the text rotation angle in degrees.
380 */
381 double getCharRotationAngle() const;
382 /** Set the new text rotation angle of the shape
383
384 @param rNewAngle
385 New text rotation angle in degrees.
386 */
387 void setCharRotationAngle( const double& rNewAngle );
388
389 /** Query whether the char weight attribute is valid
390 */
391 bool isCharWeightValid() const;
392 /** Get the current char weight value for the whole shape.
393
394 @returns the value for the char weight. The value must
395 be out of the ::com::sun::star::awt::FontWeight
396 constant group.
397 */
398 double getCharWeight() const;
399 /** Set the char weight globally for the whole shape.
400
401 The value must be out of the
402 ::com::sun::star::awt::FontWeight constant group.
403 */
404 void setCharWeight( const double& rStyle );
405
406 /** Query whether the underline mode attribute is valid
407 */
408 bool isUnderlineModeValid() const;
409 /** Get the current text underline status for the whole shape.
410
411 If there is no unique underline status, false is returned.
412
413 @returns true for underlined text, false for normal.
414 */
415 sal_Int16 getUnderlineMode() const;
416 /** Set the underline status globally for the whole shape
417 */
418 void setUnderlineMode( const sal_Int16& bUnderline );
419
420 /** Query whether the font family attribute is valid
421 */
422 bool isFontFamilyValid() const;
423 /** Get the current text font family for the whole shape.
424
425 If there is no unique font family, the font family of
426 the first text of the shape is returned.
427 */
428 ::rtl::OUString getFontFamily() const;
429 /** Set the text font family name globally for the whole shape
430 */
431 void setFontFamily( const ::rtl::OUString& rName );
432
433 /** Query whether the italic mode attribute is valid
434 */
435 bool isCharPostureValid() const;
436 /** Get the current text italic style for the whole shape.
437
438 @returns the italic style. The value returned is one
439 of the ::com::sun::star::awt::FontSlant enums
440 */
441 sal_Int16 getCharPosture() const;
442 /** Set the italic style globally for the whole shape.
443
444 The value must be one of the
445 ::com::sun::star::awt::FontSlant enums.
446 */
447 void setCharPosture( const sal_Int16& rStyle );
448
449 /** Query whether the char scaling attribute is valid
450 */
451 bool isCharScaleValid() const;
452 /** Query the current char scaling attribute globally for
453 the shape.
454
455 The char scaling changes the scale of the whole shape
456 text (uniformely, i.e. both in x and in y direction).
457 */
458 double getCharScale() const;
459 /** Set the new char scale globally for the shape
460
461 @param rNewScale
462 New char scale
463 */
464 void setCharScale( const double& rNewScale );
465
466 // State change query methods
467 // ==========================
468
469 State::StateId getTransformationState() const;
470 State::StateId getClipState() const;
471 State::StateId getAlphaState() const;
472 State::StateId getPositionState() const;
473 State::StateId getContentState() const;
474 State::StateId getVisibilityState() const;
475
476 private:
477 // default copy/assignment operator is okay
478 // ShapeAttributeLayer(const ShapeAttributeLayer&);
479 // ShapeAttributeLayer& operator=( const ShapeAttributeLayer& );
480
481 bool haveChild() const { return mpChild; }
482 void updateStateIds();
483
484 template< typename T > T calcValue( const T& rCurrValue,
485 bool bThisInstanceValid,
486 bool (ShapeAttributeLayer::*pIsValid)() const,
487 T (ShapeAttributeLayer::*pGetValue)() const ) const;
488
489 ShapeAttributeLayerSharedPtr mpChild; // may be NULL
490
491 ::basegfx::B2DSize maSize;
492 ::basegfx::B2DPoint maPosition;
493 ::basegfx::B2DPolyPolygon maClip;
494
495 ::rtl::OUString maFontFamily;
496
497 double mnRotationAngle;
498 double mnShearXAngle;
499 double mnShearYAngle;
500 double mnAlpha;
501 double mnCharRotationAngle;
502 double mnCharScale;
503 double mnCharWeight;
504
505 ::com::sun::star::drawing::FillStyle meFillStyle;
506 ::com::sun::star::drawing::LineStyle meLineStyle;
507 ::com::sun::star::awt::FontSlant meCharPosture;
508 sal_Int16 mnUnderlineMode;
509
510 RGBColor maDimColor;
511 RGBColor maFillColor;
512 RGBColor maLineColor;
513 RGBColor maCharColor;
514
515 State::StateId mnTransformationState;
516 State::StateId mnClipState;
517 State::StateId mnAlphaState;
518 State::StateId mnPositionState;
519 State::StateId mnContentState;
520 State::StateId mnVisibilityState;
521
522 sal_Int16 mnAdditiveMode;
523
524 bool mbVisibility : 1;
525
526 bool mbWidthValid : 1;
527 bool mbHeightValid : 1;
528 bool mbPosXValid : 1;
529 bool mbPosYValid : 1;
530 bool mbClipValid : 1;
531
532 bool mbFontFamilyValid : 1;
533
534 bool mbRotationAngleValid : 1;
535 bool mbShearXAngleValid : 1;
536 bool mbShearYAngleValid : 1;
537
538 bool mbAlphaValid : 1;
539
540 bool mbCharRotationAngleValid: 1;
541 bool mbCharScaleValid : 1;
542
543 bool mbDimColorValid : 1;
544 bool mbFillColorValid : 1;
545 bool mbLineColorValid : 1;
546 bool mbCharColorValid : 1;
547
548 bool mbFillStyleValid : 1;
549 bool mbLineStyleValid : 1;
550 bool mbCharWeightValid : 1;
551 bool mbUnderlineModeValid : 1;
552 bool mbCharPostureValid : 1;
553 bool mbVisibilityValid : 1;
554 };
555
556 }
557 }
558
559 #endif /* INCLUDED_SLIDESHOW_SHAPEATTRIBUTELAYER_HXX */
vba interoperability for OOo