KoShape.h 44.9 KB
Newer Older
Thomas Zander's avatar
Thomas Zander committed
1
/* This file is part of the KDE project
2
   Copyright (C) 2006-2008 Thorsten Zachmann <zachmann@kde.org>
C. Boemann's avatar
C. Boemann committed
3
   Copyright (C) 2006, 2008 C. Boemann <cbo@boemann.dk>
4
   Copyright (C) 2006-2010 Thomas Zander <zander@kde.org>
5
   Copyright (C) 2007-2009,2011 Jan Hambrecht <jaham@gmx.net>
Thomas Zander's avatar
Thomas Zander committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

Thomas Zander's avatar
Thomas Zander committed
23 24
#ifndef KOSHAPE_H
#define KOSHAPE_H
Thomas Zander's avatar
Thomas Zander committed
25

26
#include "KoFlake.h"
27
#include "KoConnectionPoint.h"
28

29
#include <QSharedPointer>
30
#include <QSet>
31
#include <QMetaType>
Thomas Zander's avatar
Thomas Zander committed
32

33 34
#include <KoXmlReaderForward.h>

35
#include "kritaflake_export.h"
36

Thomas Zander's avatar
Thomas Zander committed
37 38 39
class QPainter;
class QRectF;
class QPainterPath;
40
class QTransform;
Thomas Zander's avatar
Thomas Zander committed
41 42

class KoShapeContainer;
43
class KoShapeStrokeModel;
44
class KoShapeUserData;
45
class KoViewConverter;
46
class KoShapeApplicationData;
47
class KoShapeSavingContext;
48
class KoShapeLoadingContext;
49
class KoGenStyle;
50
class KoShapeShadow;
51
class KoShapePrivate;
52
class KoFilterEffectStack;
53
class KoSnapData;
54
class KoClipPath;
55
class KoClipMask;
56
class KoShapePaintingContext;
57
class KoShapeAnchor;
58
class KoBorder;
59
struct KoInsets;
60
class KoShapeBackground;
61

Thomas Zander's avatar
Thomas Zander committed
62 63

/**
64
 *
65
 * Base class for all flake shapes. Shapes extend this class
Thomas Zander's avatar
Thomas Zander committed
66 67 68
 * to allow themselves to be manipulated. This class just represents
 * a graphical shape in the document and can be manipulated by some default
 * tools in this library.
69
 *
70
 * Due to the limited responsibility of this class, the extending object
Thomas Zander's avatar
Thomas Zander committed
71
 * can have any data backend and is responsible for painting itself.
72
 *
73
 * We strongly suggest that any extending class will use a Model View
Thomas Zander's avatar
Thomas Zander committed
74
 * Controller (MVC) design where the View part is all in this class, as well
75
 * as the one that inherits from this one.  This allows the data that rests
Thomas Zander's avatar
Thomas Zander committed
76
 * in the model to be reused in different parts of the document. For example
77
 * by having two flake objects that show that same data. Or each showing a section of it.
78
 *
79 80 81 82 83
 * The KoShape data is completely in postscript-points (pt) (see KoUnit
 * for conversion methods to and from points).
 * This image will explain the real-world use of the shape and its options.
 * <img src="../flake_shape_coords.png" align=center><br>
 *  The Rotation center can be returned with absolutePosition()
84
 *
85
 * <p>Flake objects can be created in three ways:
86 87 88 89 90
 * <ul>
 *   <li>a simple new KoDerivedFlake(),
 *   <li>through an associated tool,
 *   <li>through a factory
 * </ul>
91
 *
Thomas Zander's avatar
Thomas Zander committed
92 93 94 95 96 97 98 99 100 101 102 103 104
 * <h1>Shape interaction notifications</h1>
 * We had several notification methods that allow your shape to be notified of changes in other
 * shapes positions or rotation etc.
 * <ol><li>The most general is KoShape::shapeChanged().<br>
 * a virtual method that you can use to check various changed to your shape made by tools or otherwise.</li>
 * <li>for shape hierarchies the parent may receive a notification when a child was modified.
 *  This is done though KoShapeContainerModel::childChanged()</li>
 * <li>any shape that is at a similar position as another shape there is collision detection.
 * You can register your shape to be sensitive to any changes like moving or whatever to
 * <b>other</b> shapes that intersect yours.
 * Such changes will then be notified to your shape using the method from (1) You should call
 * KoShape::setCollisionDetection(bool) to enable this.
 * </ol>
Thomas Zander's avatar
Thomas Zander committed
105
 */
106
class KRITAFLAKE_EXPORT KoShape
Thomas Zander's avatar
Thomas Zander committed
107 108
{
public:
109 110 111
    /// Used by shapeChanged() to select which change was made
    enum ChangeType {
        PositionChanged, ///< used after a setPosition()
112
        RotationChanged, ///< used after a setRotation()
Thomas Zander's avatar
Thomas Zander committed
113
        ScaleChanged,   ///< used after a scale()
Thomas Zander's avatar
Thomas Zander committed
114
        ShearChanged,   ///< used after a shear()
115
        SizeChanged,    ///< used after a setSize()
116
        GenericMatrixChange,    ///< used after the matrix was changed without knowing which property explicitly changed
117
        ParentChanged,   ///< used after a setParent()
118
        CollisionDetected, ///< used when another shape moved in our boundingrect
119
        Deleted, ///< the shape was deleted
120
        StrokeChanged, ///< the shapes stroke has changed
121
        BackgroundChanged, ///< the shapes background has changed
122
        ShadowChanged, ///< the shapes shadow has changed
123
        BorderChanged, ///< the shapes border has changed
124 125
        ParameterChanged, ///< the shapes parameter has changed (KoParameterShape only)
        ContentChanged, ///< the content of the shape changed e.g. a new image inside a pixmap/text change inside a textshape
126
        TextRunAroundChanged, ///< used after a setTextRunAroundSide()
Jan Hambrecht's avatar
Jan Hambrecht committed
127
        ChildChanged, ///< a child of a container was changed/removed. This is propagated to all parents
128 129
        ConnectionPointChanged, ///< a connection point has changed
        ClipPathChanged ///< the shapes clip path has changed
130 131
    };

132 133 134 135 136
    /// The behavior text should do when intersecting this shape.
    enum TextRunAroundSide {
        BiggestRunAroundSide,   ///< Run other text around the side that has the most space
        LeftRunAroundSide,      ///< Run other text around the left side of the frame
        RightRunAroundSide,     ///< Run other text around the right side of the frame
137
        EnoughRunAroundSide,      ///< Run other text dynamically around both sides of the shape, provided there is sufficient space left
138 139 140 141 142
        BothRunAroundSide,      ///< Run other text around both sides of the shape
        NoRunAround,            ///< The text will be completely avoiding the frame by keeping the horizontal space that this frame occupies blank.
        RunThrough              ///< The text will completely ignore the frame and layout as if it was not there
    };

143 144 145 146 147 148 149
    /// The behavior text should do when intersecting this shape.
    enum TextRunAroundContour {
        ContourBox,     /// Run other text around a bounding rect of the outline
        ContourFull,   ///< Run other text around also on the inside
        ContourOutside   ///< Run other text around only on the outside
    };

150 151 152
    /**
     * TODO
     */
153
    enum RunThroughLevel {
154 155 156 157
        Background,
        Foreground
    };

Thomas Zander's avatar
Thomas Zander committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171
    /**
     * @brief Constructor
     */
    KoShape();

    /**
     * @brief Destructor
     */
    virtual ~KoShape();

    /**
     * @brief Paint the shape
     * The class extending this one is responsible for painting itself.  Since we do not
     * assume the shape is square the paint must also clear its background if it will draw
172
     * something transparent on top.
Thomas Zander's avatar
Thomas Zander committed
173 174 175 176
     * This can be done with a method like:
     * <code>
       painter.fillRect(converter.normalToView(QRectF(QPointF(0.0,0.0), size())), background());</code>
     * Or equavalent for non-square objects.
177 178
     * Do note that a shape's top-left is always at coordinate 0,0. Even if the shape itself is rotated
     * or translated.
Thomas Zander's avatar
Thomas Zander committed
179 180 181
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
     * @see applyConversion()
182
     * @param paintcontext the painting context.
Thomas Zander's avatar
Thomas Zander committed
183
     */
184
    virtual void paint(QPainter &painter, const KoViewConverter &converter, KoShapePaintingContext &paintcontext) = 0;
Thomas Zander's avatar
Thomas Zander committed
185

186 187 188 189 190 191 192 193 194
    /**
     * @brief Paint the shape's border
     * This is a helper function that could be called from the paint() method of all shapes. 
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
     * @see applyConversion()
     */
    virtual void paintBorder(QPainter &painter, const KoViewConverter &converter);

195 196 197 198 199 200
    /**
     * Load a shape from odf
     *
     * @param context the KoShapeLoadingContext used for loading
     * @param element element which represents the shape in odf
     *
201
     * @return false if loading failed
202
     */
203
    virtual bool loadOdf(const KoXmlElement &element, KoShapeLoadingContext &context) = 0;
204

205
    /**
206
     * @brief store the shape data as ODF XML.
Thomas Zander's avatar
fix dox  
Thomas Zander committed
207
     * This is the method that will be called when saving a shape as a described in
208
     * OpenDocument 9.2 Drawing Shapes.
Thorsten Zachmann's avatar
Thorsten Zachmann committed
209
     * @see saveOdfAttributes
210
     */
211
    virtual void saveOdf(KoShapeSavingContext &context) const = 0;
212 213

    /**
214 215 216 217 218 219
     * This method can be used while saving the shape as ODF to add the data
     * stored on this shape to the current element.
     *
     * @param context the context for the current save.
     * @param attributes a number of OdfAttribute items to state which attributes to save.
     * @see saveOdf
220
     */
221
    void saveOdfAttributes(KoShapeSavingContext &context, int attributes) const;
222

Thorsten Zachmann's avatar
Thorsten Zachmann committed
223 224 225 226
    /**
     * This method can be used while saving the shape as Odf to add common child elements
     *
     * The office:event-listeners and draw:glue-point are saved.
227
     * @param context the context for the current save.
Thorsten Zachmann's avatar
Thorsten Zachmann committed
228
     */
229
    void saveOdfCommonChildElements(KoShapeSavingContext &context) const;
Thorsten Zachmann's avatar
Thorsten Zachmann committed
230

231 232 233 234 235 236 237 238 239
    /**
     * This method can be used to save contour data from the clipPath()
     *
     * The draw:contour-polygon or draw:contour-path elements are saved.
     * @param context the context for the current save.
     * @param originalSize the original size of the unscaled image.
     */
    void saveOdfClipContour(KoShapeSavingContext &context, const QSizeF &originalSize) const;

Thomas Zander's avatar
Thomas Zander committed
240 241 242 243 244 245 246
    /**
     * @brief Scale the shape using the zero-point which is the top-left corner.
     * @see position()
     *
     * @param sx scale in x direction
     * @param sy scale in y direction
     */
Thomas Zander's avatar
Thomas Zander committed
247
    void scale(qreal sx, qreal sy);
Thomas Zander's avatar
Thomas Zander committed
248 249

    /**
250
     * @brief Rotate the shape (relative)
Thomas Zander's avatar
Thomas Zander committed
251
     *
252
     * The shape will be rotated from the current rotation using the center of the shape using the size()
Thomas Zander's avatar
Thomas Zander committed
253
     *
254
     * @param angle change the angle of rotation increasing it with 'angle' degrees
Thomas Zander's avatar
Thomas Zander committed
255
     */
256
    void rotate(qreal angle);
Thomas Zander's avatar
Thomas Zander committed
257 258 259

    /**
     * Return the current rotation in degrees.
260
     * It returns NaN if the shape has a shearing or scaling transformation applied.
Thomas Zander's avatar
Thomas Zander committed
261
     */
262
    qreal rotation() const;
Thomas Zander's avatar
Thomas Zander committed
263 264 265 266 267 268 269 270 271

    /**
     * @brief Shear the shape
     * The shape will be sheared using the zero-point which is the top-left corner.
     * @see position()
     *
     * @param sx shear in x direction
     * @param sy shear in y direction
     */
Thomas Zander's avatar
Thomas Zander committed
272
    void shear(qreal sx, qreal sy);
Thomas Zander's avatar
Thomas Zander committed
273 274 275 276

    /**
     * @brief Resize the shape
     *
277
     * @param size the new size of the shape.  This is different from scaling as
Jan Hambrecht's avatar
Jan Hambrecht committed
278
     * scaling is a so called secondary operation which is comparable to zooming in
Thomas Zander's avatar
Thomas Zander committed
279 280
     * instead of changing the size of the basic shape.
     * Easiest example of this difference is that using this method will not distort the
281
     * size of pattern-fills and strokes.
Thomas Zander's avatar
Thomas Zander committed
282
     */
283
    virtual void setSize(const QSizeF &size);
Thomas Zander's avatar
Thomas Zander committed
284 285 286 287

    /**
     * @brief Get the size of the shape in pt.
     *
Thorsten Zachmann's avatar
Thorsten Zachmann committed
288 289
     * The size is in shape coordinates.
     *
Inge Wallin's avatar
Inge Wallin committed
290
     * @return the size of the shape as set by setSize()
Thomas Zander's avatar
Thomas Zander committed
291
     */
Thomas Zander's avatar
Thomas Zander committed
292
    virtual QSizeF size() const;
Thomas Zander's avatar
Thomas Zander committed
293 294 295 296 297 298

    /**
     * @brief Set the position of the shape in pt
     *
     * @param position the new position of the shape
     */
299
    virtual void setPosition(const QPointF &position);
Thomas Zander's avatar
Thomas Zander committed
300 301 302 303 304 305

    /**
     * @brief Get the position of the shape in pt
     *
     * @return the position of the shape
     */
306
    QPointF position() const;
Thomas Zander's avatar
Thomas Zander committed
307 308 309 310 311 312

    /**
     * @brief Check if the shape is hit on position
     * @param position the position where the user clicked.
     * @return true when it hits.
     */
313
    virtual bool hitTest(const QPointF &position) const;
Thomas Zander's avatar
Thomas Zander committed
314 315 316 317

    /**
     * @brief Get the bounding box of the shape
     *
318
     * This includes the line width and the shadow of the shape
Thomas Zander's avatar
Thomas Zander committed
319 320 321
     *
     * @return the bounding box of the shape
     */
322
    virtual QRectF boundingRect() const;
Thomas Zander's avatar
Thomas Zander committed
323 324 325

    /**
     * @brief Add a connector point to the shape
326
     *
Thomas Zander's avatar
Thomas Zander committed
327 328 329
     * A connector is a place on the shape that allows a graphical connection to be made
     * using a line, for example.
     *
330
     * @param point the connection point to add
331
     * @return the id of the new connection point
Thomas Zander's avatar
Thomas Zander committed
332
     */
333
    int addConnectionPoint(const KoConnectionPoint &point);
334

335
    /**
336
     * Sets data of connection point with specified id.
337 338
     *
     * The position of the connector is restricted to the bounding rectangle of the shape.
339 340 341 342
     * When setting a default connection point, the new position is ignored, as these
     * are fixed at their default position.
     * The function will insert a new connection point if the specified id was not used
     * before.
343
     *
344 345 346
     * @param connectionPointId the id of the connection point to set
     * @param point the connection point data
     * @return false if specified connection point id is invalid, else true
347
     */
348
    bool setConnectionPoint(int connectionPointId, const KoConnectionPoint &point);
349

350 351 352 353
    /// Checks if a connection point with the specified id exists
    bool hasConnectionPoint(int connectionPointId) const;

    /// Returns connection point with specified connection point id
354
    KoConnectionPoint connectionPoint(int connectionPointId) const;
Thomas Zander's avatar
Thomas Zander committed
355

356 357
    /**
     * Return a list of the connection points that have been added to this shape.
Thomas Zander's avatar
Thomas Zander committed
358
     * All the points are relative to the shape position, see absolutePosition().
359 360
     * @return a list of the connectors that have been added to this shape.
     */
361
    KoConnectionPoints connectionPoints() const;
Thomas Zander's avatar
Thomas Zander committed
362

363 364 365 366 367 368
    /// Removes connection point with specified id
    void removeConnectionPoint(int connectionPointId);

    /// Removes all connection points
    void clearConnectionPoints();

369
    /**
Sebastian Sauer's avatar
dox++  
Sebastian Sauer committed
370 371
     * Return the side text should flow around this shape. This implements the ODF style:wrap
     * attribute that specifies how text is displayed around a frame or graphic object.
372 373 374 375 376 377
     */
    TextRunAroundSide textRunAroundSide() const;

    /**
     * Set the side text should flow around this shape.
     * @param side the requested side
Sebastian Sauer's avatar
dox++  
Sebastian Sauer committed
378
     * @param runThrought run through the foreground or background or...
379
     */
380
    void setTextRunAroundSide(TextRunAroundSide side, RunThroughLevel runThrough = Background);
381 382

    /**
383
     * The space between this shape's left edge and text that runs around this shape.
384 385
     * @return the space around this shape to keep free from text
     */
386
    qreal textRunAroundDistanceLeft() const;
387 388

    /**
389
     * Set the space between this shape's left edge and the text that run around this shape.
390 391
     * @param distance the space around this shape to keep free from text
     */
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
    void setTextRunAroundDistanceLeft(qreal distance);

    /**
     * The space between this shape's top edge and text that runs around this shape.
     * @return the space around this shape to keep free from text
     */
    qreal textRunAroundDistanceTop() const;

    /**
     * Set the space between this shape's top edge and the text that run around this shape.
     * @param distance the space around this shape to keep free from text
     */
    void setTextRunAroundDistanceTop(qreal distance);

    /**
     * The space between this shape's right edge and text that runs around this shape.
     * @return the space around this shape to keep free from text
     */
    qreal textRunAroundDistanceRight() const;

    /**
     * Set the space between this shape's right edge and the text that run around this shape.
     * @param distance the space around this shape to keep free from text
     */
    void setTextRunAroundDistanceRight(qreal distance);

    /**
     * The space between this shape's bottom edge and text that runs around this shape.
     * @return the space around this shape to keep free from text
     */
    qreal textRunAroundDistanceBottom() const;

    /**
     * Set the space between this shape's bottom edge and the text that run around this shape.
     * @param distance the space around this shape to keep free from text
     */
    void setTextRunAroundDistanceBottom(qreal distance);
429

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
    /**
     * Return the threshold above which text should flow around this shape.
     * The text will not flow around the shape on a side unless the space available on that side
     * is above this threshold. Only used when the text run around side is EnoughRunAroundSide.
     * @return threshold the threshold
     */
    qreal textRunAroundThreshold() const;

    /**
     * Set the threshold above which text should flow around this shape.
     * The text will not flow around the shape on a side unless the space available on that side
     * is above this threshold. Only used when the text run around side is EnoughRunAroundSide.
     * @param threshold the new threshold
     */
    void setTextRunAroundThreshold(qreal threshold);

446 447 448 449 450 451 452 453 454 455 456 457
    /**
     * Return the how tight text run around is done around this shape.
     * @return the contour
     */
    TextRunAroundContour textRunAroundContour() const;

    /**
     * Set how tight text run around is done around this shape.
     * @param contour the new contour
     */
    void setTextRunAroundContour(TextRunAroundContour contour);

458 459 460 461 462 463 464 465 466 467
    /**
     * Set the KoShapeAnchor
     */
    void setAnchor(KoShapeAnchor *anchor);

    /**
     * Return the KoShapeAnchor, or 0
     */
    KoShapeAnchor *anchor() const;

468 469 470 471 472 473 474 475 476 477 478 479 480 481
    /**
     * Set the minimum height of the shape.
     * Currently it's not respected but only for informational purpose
     * @param minimumShapeHeight the minimum height of the frame.
     */
    void setMinimumHeight(qreal height);

    /**
     * Return the minimum height of the shape.
     * @return the minimum height of the shape. Default is 0.0.
     */
    qreal minimumHeight() const;


Thomas Zander's avatar
Thomas Zander committed
482 483
    /**
     * Set the background of the shape.
484
     * A shape background can be a plain color, a gradient, a pattern, be fully transparent
Jan Hambrecht's avatar
Jan Hambrecht committed
485
     * or have a complex fill.
486
     * Setting such a background will allow the shape to be filled and will be able to tell
Jan Hambrecht's avatar
Jan Hambrecht committed
487 488
     * if it is transparent or not.
     * @param background the new shape background.
Thomas Zander's avatar
Thomas Zander committed
489
     */
490
    void setBackground(QSharedPointer<KoShapeBackground> background);
491

Thomas Zander's avatar
Thomas Zander committed
492 493
    /**
     * return the brush used to paint te background of this shape with.
494
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
495
     * setting such a brush will allow the shape to fill itself using that brush and
496
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
497 498
     * @return the background-brush
     */
499
    QSharedPointer<KoShapeBackground> background() const;
Thomas Zander's avatar
Thomas Zander committed
500 501

    /**
502 503
     * Returns true if there is some transparency, false if the shape is fully opaque.
     * The default implementation will just return if the background has some transparency,
Thomas Zander's avatar
Thomas Zander committed
504
     * you should override it and always return true if your shape is not square.
505
     * @return if the shape is (partly) transparent.
Thomas Zander's avatar
Thomas Zander committed
506
     */
Thomas Zander's avatar
Thomas Zander committed
507
    virtual bool hasTransparency() const;
Thomas Zander's avatar
Thomas Zander committed
508

509 510 511 512 513
    /**
     * Sets shape level transparency.
     * @param transparency the new shape level transparency
     */
    void setTransparency(qreal transparency);
514

515 516 517 518 519
    /**
     * Returns the shape level transparency.
     * @param recursive when true takes the parents transparency into account
     */
    qreal transparency(bool recursive=false) const;
520

Thomas Zander's avatar
Thomas Zander committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
    /**
     * Retrieve the z-coordinate of this shape.
     * The zIndex property is used to determine which shape lies on top of other objects.
     * An shape with a higher z-order is on top, and can obscure another shape.
     * @return the z-index of this shape.
     * @see setZIndex()
     */
    int zIndex() const;

    /**
     * Set the z-coordinate of this shape.
     * The zIndex property is used to determine which shape lies on top of other objects.
     * An shape with a higher z-order is on top, and can obscure, another shape.
     * <p>Just like two objects having the same x or y coordinate will make them 'touch',
     * so will two objects with the same z-index touch on the z plane.  In layering the
     * shape this, however, can cause a little confusion as one always has to be on top.
537
     * The layering if two overlapping objects have the same index is implementation dependent
Thomas Zander's avatar
Thomas Zander committed
538 539 540
     * and probably depends on the order in which they are added to the shape manager.
     * @param zIndex the new z-index;
     */
Thomas Zander's avatar
Thomas Zander committed
541
    void setZIndex(int zIndex);
Thomas Zander's avatar
Thomas Zander committed
542

543 544 545 546 547 548 549 550 551 552 553 554
    /**
     * Retrieve the run through property of this shape.
     * The run through property is used to determine if the shape is behind, inside or before text.
     * @return the run through of this shape.
     */
    int runThrough();

    /**
     * Set the run through property of this shape.
     * The run through property is used to determine if the shape is behind, inside or before text.
     * @param runThrough the new run through;
     */
Thorsten Zachmann's avatar
Thorsten Zachmann committed
555
    virtual void setRunThrough(short int runThrough);
556

Thomas Zander's avatar
Thomas Zander committed
557 558
    /**
     * Changes the Shape to be visible or invisible.
559
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
560 561
     *   things like guidelines or searches.
     * @param on when true; set the shape to be visible.
562
     * @see setGeometryProtected(), setContentProtected(), setSelectable()
Thomas Zander's avatar
Thomas Zander committed
563
     */
Thomas Zander's avatar
Thomas Zander committed
564
    void setVisible(bool on);
Thomas Zander's avatar
Thomas Zander committed
565 566
    /**
     * Returns current visibility state of this shape.
567
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
568
     *   things like guidelines or searches.
569
     * @param recursive when true, checks visibility recursively
Thomas Zander's avatar
Thomas Zander committed
570
     * @return current visibility state of this shape.
571
     * @see isGeometryProtected(), isContentProtected(), isSelectable()
Thomas Zander's avatar
Thomas Zander committed
572
     */
573
    bool isVisible(bool recursive = false) const;
Thomas Zander's avatar
Thomas Zander committed
574

575 576 577 578 579
    /**
     * Changes the shape to be printable or not. The default is true.
     *
     * If a Shape's print flag is true, the shape will be printed. If
     * false, the shape will not be printed. If a shape is not visible (@see isVisible),
580
     * it isPrinted will return false, too.
581 582 583 584 585 586 587 588 589 590 591 592
     */
    void setPrintable(bool on);

    /**
     * Returns the current printable state of this shape.
     *
     * A shape can be visible but not printable, not printable and not visible
     * or visible and printable, but not invisible and still printable.
     *
     * @return current printable state of this shape.
     */
    bool isPrintable() const;
593

594 595 596
    /**
     * Makes it possible for the user to select this shape.
     * This parameter defaults to true.
Thomas Zander's avatar
Thomas Zander committed
597
     * @param selectable when true; set the shape to be selectable by the user.
598
     * @see setGeometryProtected(), setContentProtected(), setVisible()
599
     */
Thomas Zander's avatar
Thomas Zander committed
600
    void setSelectable(bool selectable);
601

602
    /**
Thomas Zander's avatar
Thomas Zander committed
603
     * Returns if this shape can be selected by the user.
604
     * @return true only when the object is selectable.
605
     * @see isGeometryProtected(), isContentProtected(), isVisible()
606
     */
Thomas Zander's avatar
Thomas Zander committed
607
    bool isSelectable() const;
608

Thomas Zander's avatar
Thomas Zander committed
609
    /**
610 611 612 613
     * Tells the shape to have its position/rotation and size protected from user-changes.
     * The geometry being protected means the user can not change shape or position of the
     * shape. This includes any matrix operation such as rotation.
     * @param on when true; set the shape to have its geometry protected.
614
     * @see setContentProtected(), setSelectable(), setVisible()
Thomas Zander's avatar
Thomas Zander committed
615
     */
616
    void setGeometryProtected(bool on);
617

Thomas Zander's avatar
Thomas Zander committed
618
    /**
619 620 621 622
     * Returns current geometry protection state of this shape.
     * The geometry being protected means the user can not change shape or position of the
     * shape. This includes any matrix operation such as rotation.
     * @return current geometry protection state of this shape.
623
     * @see isContentProtected(), isSelectable(), isVisible()
Thomas Zander's avatar
Thomas Zander committed
624
     */
625
    bool isGeometryProtected() const;
Thomas Zander's avatar
Thomas Zander committed
626

627 628 629 630
    /**
     * Marks the shape to have its content protected against editing.
     * Content protection is a hint for tools to disallow the user editing the content.
     * @param protect when true set the shapes content to be protected from user modification.
631
     * @see setGeometryProtected(), setSelectable(), setVisible()
632 633
     */
    void setContentProtected(bool protect);
634

635 636 637 638
    /**
     * Returns current content protection state of this shape.
     * Content protection is a hint for tools to disallow the user editing the content.
     * @return current content protection state of this shape.
639
     * @see isGeometryProtected(), isSelectable(), isVisible()
640 641 642
     */
    bool isContentProtected() const;

Thomas Zander's avatar
Thomas Zander committed
643 644 645 646
    /**
     * Returns the parent, or 0 if there is no parent.
     * @return the parent, or 0 if there is no parent.
     */
Thomas Zander's avatar
Thomas Zander committed
647
    KoShapeContainer *parent() const;
Thomas Zander's avatar
Thomas Zander committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661

    /**
     * Set the parent of this shape.
     * @param parent the new parent of this shape. Can be 0 if the shape has no parent anymore.
     */
    void setParent(KoShapeContainer *parent);

    /**
     * Request a repaint to be queued.
     * The repaint will be of the entire Shape, including its selection handles should this
     * shape be selected.
     * <p>This method will return immediately and only request a repaint. Successive calls
     * will be merged into an appropriate repaint action.
     */
662
    virtual void update() const;
Thomas Zander's avatar
Thomas Zander committed
663 664 665 666 667 668 669 670

    /**
     * Request a repaint to be queued.
     * The repaint will be restricted to the parameters rectangle, which is expected to be
     * in points (the internal coordinates system of KoShape) and it is expected to be
     * normalized.
     * <p>This method will return immediately and only request a repaint. Successive calls
     * will be merged into an appropriate repaint action.
Boudewijn Rempt's avatar
Boudewijn Rempt committed
671
     * @param rect the rectangle (in pt) to queue for repaint.
Thomas Zander's avatar
Thomas Zander committed
672
     */
Boudewijn Rempt's avatar
Boudewijn Rempt committed
673
    virtual void update(const QRectF &rect) const;
Thomas Zander's avatar
Thomas Zander committed
674

675 676 677 678 679 680 681
    /// Used by compareShapeZIndex() to order shapes
    enum ChildZOrderPolicy {
        ChildZDefault,
        ChildZParentChild = ChildZDefault, ///< normal parent/child ordering
        ChildZPassThrough ///< children are considered equal to this shape
    };

682
   /**
683 684 685 686 687 688 689 690
    * Returns if during compareShapeZIndex() how this shape portrays the values
    * of its children. The default behaviour is to let this shape's z values take
    * the place of its childrens values, so you get a parent/child relationship.
    * The children are naturally still ordered relatively to their z values
    *
    * But for special cases (like Calligra's TextShape) it can be overloaded to return
    * ChildZPassThrough which means the children keep their own z values
    * @returns the z order policy of this shape
691
    */
692
    virtual ChildZOrderPolicy childZOrderPolicy();
693

Thomas Zander's avatar
Thomas Zander committed
694 695
    /**
     * This is a method used to sort a list using the STL sorting methods.
696 697
     * @param s1 the first shape
     * @param s2 the second shape
Thomas Zander's avatar
Thomas Zander committed
698
     */
699
    static bool compareShapeZIndex(KoShape *s1, KoShape *s2);
Thomas Zander's avatar
Thomas Zander committed
700 701 702

    /**
     * returns the outline of the shape in the form of a path.
Casper Boemann's avatar
Casper Boemann committed
703
     * The outline returned will always be relative to the position() of the shape, so
704
     * moving the shape will not alter the result.  The outline is used to draw the stroke
Thomas Zander's avatar
Thomas Zander committed
705 706 707
     * on, for example.
     * @returns the outline of the shape in the form of a path.
     */
708
    virtual QPainterPath outline() const;
Thomas Zander's avatar
Thomas Zander committed
709

710 711
    /**
     * returns the outline of the shape in the form of a rect.
Casper Boemann's avatar
Casper Boemann committed
712 713 714
     * The outlineRect returned will always be relative to the position() of the shape, so
     * moving the shape will not alter the result.  The outline is used to calculate
     * the boundingRect.
715 716 717 718
     * @returns the outline of the shape in the form of a rect.
     */
    virtual QRectF outlineRect() const;

719 720 721 722 723 724 725 726 727 728 729 730
    /**
     * returns the outline of the shape in the form of a path for the use of painting a shadow.
     *
     * Normally this would be the same as outline() if there is a fill (background) set on the
     * shape and empty if not.  However, a shape could reimplement this to return an outline
     * even if no fill is defined. A typical example of this would be the picture shape
     * which has a picture but almost never a background. 
     *
     * @returns the outline of the shape in the form of a path.
     */
    virtual QPainterPath shadowOutline() const;

Thomas Zander's avatar
Thomas Zander committed
731
    /**
732 733
     * Returns the currently set stroke, or 0 if there is no stroke.
     * @return the currently set stroke, or 0 if there is no stroke.
Thomas Zander's avatar
Thomas Zander committed
734
     */
735
    KoShapeStrokeModel *stroke() const;
Thomas Zander's avatar
Thomas Zander committed
736 737

    /**
738 739
     * Set a new stroke, removing the old one.
     * @param stroke the new stroke, or 0 if there should be no stroke.
Thomas Zander's avatar
Thomas Zander committed
740
     */
741
    void setStroke(KoShapeStrokeModel *stroke);
Thomas Zander's avatar
Thomas Zander committed
742

743
    /**
744 745
     * Return the insets of the stroke.
     * Convenience method for KoShapeStrokeModel::strokeInsets()
746
     */
747
    KoInsets strokeInsets() const;
748

749
    /// Sets the new shadow, removing the old one
750
    void setShadow(KoShapeShadow *shadow);
751

752
    /// Returns the currently set shadow or 0 if there is no shadow set
753
    KoShapeShadow *shadow() const;
754

755 756 757 758 759 760
    /// Sets the new border, removing the old one.
    void setBorder(KoBorder *border);

    /// Returns the currently set border or 0 if there is no border set
    KoBorder *border() const;

761
    /// Sets a new clip path, removing the old one
Jan Hambrecht's avatar
Jan Hambrecht committed
762
    void setClipPath(KoClipPath *clipPath);
763 764 765 766

    /// Returns the currently set clip path or 0 if there is no clip path set
    KoClipPath * clipPath() const;

767 768 769 770 771 772
    /// Sets a new clip mask, removing the old one. The mask is owned by the shape.
    void setClipMask(KoClipMask *clipMask);

    /// Returns the currently set clip mask or 0 if there is no clip mask set
    KoClipMask* clipMask() const;

Thomas Zander's avatar
Thomas Zander committed
773 774 775 776 777 778
    /**
     * Setting the shape to keep its aspect-ratio has the effect that user-scaling will
     * keep the width/hight ratio intact so as not to distort shapes that rely on that
     * ratio.
     * @param keepAspect the new value
     */
Thomas Zander's avatar
Thomas Zander committed
779
    void setKeepAspectRatio(bool keepAspect);
780

Thomas Zander's avatar
Thomas Zander committed
781 782 783 784 785 786
    /**
     * Setting the shape to keep its aspect-ratio has the effect that user-scaling will
     * keep the width/hight ratio intact so as not to distort shapes that rely on that
     * ratio.
     * @return whether to keep aspect ratio of this shape
     */
Thomas Zander's avatar
Thomas Zander committed
787
    bool keepAspectRatio() const;
Thomas Zander's avatar
Thomas Zander committed
788 789 790 791

    /**
     * Return the position of this shape regardless of rotation/skew/scaling and regardless of
     * this shape having a parent (being in a group) or not.<br>
792
     * @param anchor The place on the (unaltered) shape that you want the position of.
Thomas Zander's avatar
Thomas Zander committed
793 794
     * @return the point that is the absolute, centered position of this shape.
     */
Jan Hambrecht's avatar
Jan Hambrecht committed
795
    QPointF absolutePosition(KoFlake::Position anchor = KoFlake::CenteredPosition) const;
796

Thomas Zander's avatar
Thomas Zander committed
797 798 799 800 801 802 803 804 805 806 807 808
    /**
     * Move this shape to an absolute position where the end location will be the same
     * regardless of the shape's rotation/skew/scaling and regardless of this shape having
     * a parent (being in a group) or not.<br>
     * The newPosition is going to be the center of the shape.
     * This has the convenient effect that: <pre>
    shape-&gt;setAbsolutePosition(QPointF(0,0));
    shape-&gt;rotate(45);</pre>
        Will result in the same visual position of the shape as the opposite:<pre>
    shape-&gt;rotate(45);
    shape-&gt;setAbsolutePosition(QPointF(0,0));</pre>
     * @param newPosition the new absolute center of the shape.
Thomas Zander's avatar
Thomas Zander committed
809
     * @param anchor The place on the (unaltered) shape that you set the position of.
Thomas Zander's avatar
Thomas Zander committed
810
     */
Friedrich W. H. Kossebau's avatar
Friedrich W. H. Kossebau committed
811
    void setAbsolutePosition(const QPointF &newPosition, KoFlake::Position anchor = KoFlake::CenteredPosition);
Thomas Zander's avatar
Thomas Zander committed
812

813 814
    /**
     * Set a data object on the shape to be used by an application.
815
     * This is specifically useful when a shape is created in a plugin and that data from that
816 817 818 819 820 821 822 823 824
     * shape should be accessible outside the plugin.
     * @param userData the new user data, or 0 to delete the current one.
     */
    void setUserData(KoShapeUserData *userData);
    /**
     * Return the current userData.
     */
    KoShapeUserData *userData() const;

825 826 827 828 829 830 831
    /**
     * Set a data object on the shape to be used by an application.
     * This is specifically useful when an application wants to have data that is per shape
     * and should be deleted when the shape is destructed.
     * @param applicationData the new application data, or 0 to delete the current one.
     */
    void setApplicationData(KoShapeApplicationData *applicationData);
832

833 834 835 836 837
    /**
     * Return the current applicationData.
     */
    KoShapeApplicationData *applicationData() const;

838
    /**
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
839
     * Return the Id of this shape, identifying the type of shape by the id of the factory.
840
     * @see KoShapeFactoryBase::shapeId()
841 842
     * @return the id of the shape-type
     */
843 844
    QString shapeId() const;

845 846 847
    /**
     * Set the Id of this shape.  A shapeFactory is expected to set the Id at creation
     * so applications can find out what kind of shape this is.
848
     * @see KoShapeFactoryBase::shapeId()
849 850
     * @param id the ID from the factory that created this shape
     */
Thomas Zander's avatar
Thomas Zander committed
851
    void setShapeId(const QString &id);
852

Thomas Zander's avatar
Thomas Zander committed
853 854
    /**
     * Create a matrix that describes all the transformations done on this shape.
855 856 857 858
     *
     * The absolute transformation is the combined transformation of this shape
     * and all its parents and grandparents.
     *
Thomas Zander's avatar
Thomas Zander committed
859 860 861
     * @param converter if not null, this method uses the converter to mark the right
     *        offsets in the current view.
     */
862
    QTransform absoluteTransformation(const KoViewConverter *converter) const;
Thomas Zander's avatar
Thomas Zander committed
863

864 865 866 867
    /**
     * Applies a transformation to this shape.
     *
     * The transformation given is relative to the global coordinate system, i.e. the document.
868 869
     * This is a convenience function to apply a global transformation to this shape.
     * @see applyTransformation
870 871 872
     *
     * @param matrix the transformation matrix to apply
     */
873
    void applyAbsoluteTransformation(const QTransform &matrix);
874 875 876 877 878

    /**
     * Sets a new transformation matrix describing the local transformations on this shape.
     * @param matrix the new transformation matrix
     */
879
    void setTransformation(const QTransform &matrix);
880

881
    /// Returns the shapes local transformation matrix
882
    QTransform transformation() const;
883 884 885 886 887 888 889 890

    /**
     * Applies a transformation to this shape.
     *
     * The transformation given is relative to the shape coordinate system.
     *
     * @param matrix the transformation matrix to apply
     */
891
    void applyTransformation(const QTransform &matrix);
892

Thomas Zander's avatar
Thomas Zander committed
893 894 895 896 897 898
    /**
     * Copy all the settings from the parameter shape and apply them to this shape.
     * Settings like the position and rotation to visible and locked.  The parent
     * is a notable exclusion.
     * @param shape the shape to use as original
     */
Thomas Zander's avatar
Thomas Zander committed
899
    void copySettings(const KoShape *shape);
Thomas Zander's avatar
Thomas Zander committed
900

Thomas Zander's avatar
Thomas Zander committed
901 902 903 904 905 906 907 908 909
    /**
     * Convenience method that allows people implementing paint() to use the shape
     * internal coordinate system directly to paint itself instead of considering the
     * views zoom.
     * @param painter the painter to alter the zoom level of.
     * @param converter the converter for the current views zoom.
     */
    static void applyConversion(QPainter &painter, const KoViewConverter &converter);

910 911 912 913 914
    /**
     * @brief Transforms point from shape coordinates to document coordinates
     * @param point in shape coordinates
     * @return point in document coordinates
     */
915
    QPointF shapeToDocument(const QPointF &point) const;
916 917 918 919 920 921

    /**
     * @brief Transforms rect from shape coordinates to document coordinates
     * @param rect in shape coordinates
     * @return rect in document coordinates
     */
922
    QRectF shapeToDocument(const QRectF &rect) const;
923 924 925 926 927 928

    /**
     * @brief Transforms point from document coordinates to shape coordinates
     * @param point in document coordinates
     * @return point in shape coordinates
     */
929
    QPointF documentToShape(const QPointF &point) const;
930 931 932 933 934 935

    /**
     * @brief Transform rect from document coordinates to shape coordinates
     * @param rect in document coordinates
     * @return rect in shape coordinates
     */
936
    QRectF documentToShape(const QRectF &rect) const;
937

938 939 940 941
    /**
     * Returns the name of the shape.
     * @return the shapes name
     */
942
    QString name() const;
943 944 945 946 947

    /**
     * Sets the name of the shape.
     * @param name the new shape name
     */
948
    void setName(const QString &name);
949

950 951 952 953 954
    /**
     * Update the position of the shape in the tree of the KoShapeManager.
     */
    void notifyChanged();

955
    /**
Thomas Zander's avatar
Thomas Zander committed
956
     * A shape can be in a state that it is doing processing data like loading or text layout.
957
     * In this case it can be shown on screen probably partially but it should really not be printed
Thomas Zander's avatar
Thomas Zander committed
958
     * until it is fully done processing.
959
     * Warning! This method can be blocking for a long time
Boudewijn Rempt's avatar
Boudewijn Rempt committed
960 961 962
     * @param asynchronous If set to true the processing will can take place in a different thread and the
     *                     function will not block until the shape is finised.
     *                     In case of printing Flake will call this method from a non-main thread and only
963
     *                     start printing it when the in case of printing method returned.
Boudewijn Rempt's avatar
Boudewijn Rempt committed
964
     *                     If set to false the processing needs to be done synchronously and will
965 966 967
     *                     block until the result is finished.
     */
    virtual void waitUntilReady(const KoViewConverter &converter, bool asynchronous = true) const;
968

969 970 971
    /// checks recursively if the shape or one of its parents is not visible or locked
    bool isEditable() const;

972 973
    /**
     * Adds a shape which depends on this shape.
974 975
     * Making a shape dependent on this one means it will get shapeChanged() called
     * on each update of this shape.
976 977 978 979 980
     *
     * If this shape already depends on the given shape, establishing the
     * dependency is refused to prevent circular dependencies.
     *
     * @param shape the shape which depends on this shape
981 982
     * @return true if dependency could be established, otherwise false
     * @see removeDependee(), hasDependee()
983
     */
984
    bool addDependee(KoShape *shape);
985

986 987 988 989
    /**
     * Removes as shape depending on this shape.
     * @see addDependee(), hasDependee()
     */
990
    void removeDependee(KoShape *shape);
991

992
    /// Returns if the given shape is dependent on this shape
993
    bool hasDependee(KoShape *shape) const;
994

995 996 997
    /// Returns list of shapes depending on this shape
    QList<KoShape*> dependees() const;

998 999 1000
    /// Returns additional snap data the shape wants to have snapping to
    virtual KoSnapData snapData() const;

1001 1002 1003 1004 1005 1006 1007 1008 1009
    /**
     * Set additional attribute
     *
     * This can be used to attach additional attributes to a shape for attributes
     * that are application specific like presentation:placeholder
     *
     * @param name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
     * @param value The value of the attribute
     */
1010
    void setAdditionalAttribute(const QString &name, const QString &value);
1011 1012 1013 1014 1015 1016

    /**
     * Remove additional attribute
     *
     * @param name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
     */
1017
    void removeAdditionalAttribute(const QString &name);
1018 1019 1020 1021 1022 1023 1024 1025

    /**
     * Check if additional attribute is set
     *
     * @param name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
     *
     * @return true if there is a attribute with prefix:tag set, false otherwise
     */
1026
    bool hasAdditionalAttribute(const QString &name) const;
1027 1028 1029 1030 1031 1032 1033 1034

    /**
     * Get additional attribute
     *
     * @param name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
     *
     * @return The value of the attribute if it exists or a null string if not found.
     */
1035
    QString additionalAttribute(const QString &name) const;
1036

1037
    void setAdditionalStyleAttribute(const char *name, const QString &value);
1038

1039
    void removeAdditionalStyleAttribute(const char *name);
1040

1041
    /**
1042
     * Returns the filter effect stack of the shape
1043 1044 1045
     *
     * @return the list of filter effects applied on the shape when rendering.
     */
1046
    KoFilterEffectStack *filterEffectStack() const;
1047

1048
    /// Sets the new filter effect stack, removing the old one
1049
    void setFilterEffectStack(KoFilterEffectStack *filterEffectStack);
1050

1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
    /**
     * Set the property collision detection.
     * Setting this to true will result in calls to shapeChanged() with the CollisionDetected
     * parameter whenever either this or another shape is moved/rotated etc and intersects this shape.
     * @param detect if true detect collisions.
     */
    void setCollisionDetection(bool detect);

    /**
     * get the property collision detection.
     * @returns true if collision detection is on.
     */
    bool collisionDetection();

1065 1066 1067 1068 1069 1070
    /**
     * Return the tool delegates for this shape.
     * In Flake a shape being selected will cause the tool manager to make available all tools that
     * can edit the selected shapes.  In some cases selecting one shape should allow the tool to
     * edit a related shape be available too.  The tool delegates allows this to happen by taking
     * all the shapes in the set into account on tool selection.
Thomas Zander's avatar
Thomas Zander committed
1071
     * Notice that if the set is non-empty 'this' shape is no longer looked at. You can choose
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
     * to add itself to the set too.
     */
    QSet<KoShape*> toolDelegates() const;

    /**
     * Set the tool delegates.
     * @param delegates the new delegates.
     * @see toolDelegates()
     */
    void setToolDelegates(const QSet<KoShape*> &delegates);

1083 1084 1085 1086 1087 1088 1089 1090 1091
    /**
     * Return the hyperlink for this shape.
     */
    QString hyperLink () const;

    /**
     * Set hyperlink for this shape.
     * @param hyperLink name.
     */
Friedrich W. H. Kossebau's avatar
Friedrich W. H. Kossebau committed
1092
    void setHyperLink(const QString &hyperLink);
1093

1094 1095
    /**
     * \internal
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
1096
     * Returns the private object for use within the flake lib
1097 1098 1099
     */
    KoShapePrivate *priv();

1100
protected:
1101 1102
    /// constructor
    KoShape(KoShapePrivate &);
1103

1104
    /* ** loading saving helper methods */
1105 1106
    /// attributes from ODF 1.1 chapter 9.2.15 Common Drawing Shape Attributes
    enum OdfAttribute {
1107 1108
        OdfTransformation = 1,       ///< Store transformation information
        OdfSize = 2,                 ///< Store size information
1109 1110 1111 1112 1113 1114 1115
        OdfPosition = 8,             ///< Store position
        OdfAdditionalAttributes = 4, ///< Store additional attributes of the shape
        OdfCommonChildElements = 16, ///< Event actions and connection points
        OdfLayer = 64,               ///< Store layer name
        OdfStyle = 128,              ///< Store the style
        OdfId = 256,                 ///< Store the unique ID
        OdfName = 512,               ///< Store the name of the shape
1116
        OdfZIndex = 1024,            ///< Store the z-index
1117
        OdfViewbox = 2048,           ///< Store the viewbox
1118 1119 1120 1121 1122

        /// A mask for all mandatory attributes
        OdfMandatories = OdfLayer | OdfStyle | OdfId | OdfName | OdfZIndex,
        /// A mask for geometry attributes
        OdfGeometry = OdfPosition | OdfSize,
1123
        /// A mask for all the attributes
1124
        OdfAllAttributes = OdfTransformation | OdfGeometry | OdfAdditionalAttributes | OdfMandatories | OdfCommonChildElements
1125
    };
1126

1127 1128 1129 1130 1131 1132 1133
    /**
     * This method is used during loading of the shape to load common attributes
     *
     * @param context the KoShapeLoadingContext used for loading
     * @param element element which represents the shape in odf
     * @param attributes a number of OdfAttribute items to state which attributes to load.
     */
1134
    bool loadOdfAttributes(const KoXmlElement &element, KoShapeLoadingContext &context, int attributes);
1135

Jan Hambrecht's avatar
 
Jan Hambrecht committed
1136