KoShape.h 40.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>
3
   Copyright (C) 2006, 2008 Casper Boemann <cbr@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 "KoInsets.h"
27
#include "KoFlake.h"
28
#include "KoConnectionPoint.h"
29

30
#include <QTransform>
Thomas Zander's avatar
Thomas Zander committed
31
#include <QVector>
32
#include <QSet>
33
#include <QMap>
Thomas Zander's avatar
Thomas Zander committed
34
#include <QBrush>
35
#include <QMetaType>
Thomas Zander's avatar
Thomas Zander committed
36

37
#include <KoXmlReaderForward.h>
38

39
//#include <KoSnapData.h>
40

41 42
#include "flake_export.h"

Thomas Zander's avatar
Thomas Zander committed
43 44 45 46 47 48
class QPainter;
class QRectF;
class QPainterPath;

class KoShapeContainer;
class KoShapeBorderModel;
49
class KoShapeBackground;
50
class KoShapeManager;
51
class KoShapeUserData;
52
class KoViewConverter;
53
class KoShapeApplicationData;
54
class KoShapeSavingContext;
55
class KoCanvasBase;
56
class KoShapeLoadingContext;
57
class KoGenStyle;
58
class KoShapeBasedDocumentBase;
59
class KoDataCenterBase;
60
class KoShapeShadow;
61
class KoEventAction;
62
class KoShapePrivate;
63
class KoFilterEffectStack;
64
class KoSnapData;
65
class KoClipPath;
Thomas Zander's avatar
Thomas Zander committed
66 67

/**
68
 *
69
 * Base class for all flake shapes. Shapes extend this class
Thomas Zander's avatar
Thomas Zander committed
70 71 72
 * 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.
73
 *
74
 * Due to the limited responsibility of this class, the extending object
Thomas Zander's avatar
Thomas Zander committed
75
 * can have any data backend and is responsible for painting itself.
76
 *
77
 * We strongly suggest that any extending class will use a Model View
Thomas Zander's avatar
Thomas Zander committed
78
 * Controller (MVC) design where the View part is all in this class, as well
79
 * as the one that inherits from this one.  This allows the data that rests
Thomas Zander's avatar
Thomas Zander committed
80
 * in the model to be reused in different parts of the document. For example
81
 * by having two flake objects that show that same data. Or each showing a section of it.
82
 *
83 84 85 86 87
 * 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()
88
 *
89
 * <p>Flake objects can be created in three ways:
90 91 92 93 94
 * <ul>
 *   <li>a simple new KoDerivedFlake(),
 *   <li>through an associated tool,
 *   <li>through a factory
 * </ul>
95
 *
Thomas Zander's avatar
Thomas Zander committed
96 97 98 99 100 101 102 103 104 105 106 107 108
 * <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
109
 */
110
class FLAKE_EXPORT KoShape
Thomas Zander's avatar
Thomas Zander committed
111 112
{
public:
113 114 115
    /// Used by shapeChanged() to select which change was made
    enum ChangeType {
        PositionChanged, ///< used after a setPosition()
116
        RotationChanged, ///< used after a setRotation()
Thomas Zander's avatar
Thomas Zander committed
117
        ScaleChanged,   ///< used after a scale()
Thomas Zander's avatar
Thomas Zander committed
118
        ShearChanged,   ///< used after a shear()
119
        SizeChanged,    ///< used after a setSize()
120
        GenericMatrixChange,    ///< used after the matrix was changed without knowing which property explicitly changed
121
        ParentChanged,   ///< used after a setParent()
122
        CollisionDetected, ///< used when another shape moved in our boundingrect
123 124
        Deleted, ///< the shape was deleted
        BorderChanged, ///< the shapes border has changed
125
        BackgroundChanged, ///< the shapes background has changed
126
        ShadowChanged, ///< the shapes shadow has changed
127 128
        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
129
        TextRunAroundChanged, ///< used after a setTextRunAroundSide()
Jan Hambrecht's avatar
Jan Hambrecht committed
130
        ChildChanged, ///< a child of a container was changed/removed. This is propagated to all parents
131 132
        ConnectionPointChanged, ///< a connection point has changed
        ClipPathChanged ///< the shapes clip path has changed
133 134
    };

135 136 137 138 139
    /// 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
140
        EnoughRunAroundSide,      ///< Run other text dynamically around both sides of the shape, provided there is sufficient space left
141 142 143 144 145 146 147 148 149 150 151 152 153
        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
    };

    /**
     * TODO
     */
    enum Through {
        Background,
        Foreground
    };

Thomas Zander's avatar
Thomas Zander committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167
    /**
     * @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
168
     * something transparent on top.
Thomas Zander's avatar
Thomas Zander committed
169 170 171 172
     * 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.
173 174
     * 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
175 176 177 178
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
     * @see applyConversion()
     */
179
    virtual void paint(QPainter &painter, const KoViewConverter &converter) = 0;
Thomas Zander's avatar
Thomas Zander committed
180 181 182 183 184 185 186

    /**
     * Paint non-print decorations specific for this type of shape.
     * The default implementation is empty.
     *
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
Thomas Zander's avatar
Thomas Zander committed
187
     * @param canvas the canvas that requested this paint.  This can be used to retrieve canvas specific properties
188
     *      like selection and get a reference to the KoDocumentResourceManager.
Thomas Zander's avatar
Thomas Zander committed
189
     */
190
    virtual void paintDecorations(QPainter &painter, const KoViewConverter &converter, const KoCanvasBase *canvas);
Thomas Zander's avatar
Thomas Zander committed
191

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

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

    /**
211 212 213 214 215 216
     * 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
217
     */
218
    void saveOdfAttributes(KoShapeSavingContext &context, int attributes) const;
219

Thorsten Zachmann's avatar
Thorsten Zachmann committed
220 221 222 223 224
    /**
     * 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.
     */
225
    void saveOdfCommonChildElements(KoShapeSavingContext &context) const;
Thorsten Zachmann's avatar
Thorsten Zachmann committed
226

Thomas Zander's avatar
Thomas Zander committed
227 228 229 230 231 232 233
    /**
     * @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
234
    void scale(qreal sx, qreal sy);
Thomas Zander's avatar
Thomas Zander committed
235 236

    /**
237
     * @brief Rotate the shape (relative)
Thomas Zander's avatar
Thomas Zander committed
238
     *
239
     * 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
240
     *
241
     * @param angle change the angle of rotation increasing it with 'angle' degrees
Thomas Zander's avatar
Thomas Zander committed
242
     */
243
    void rotate(qreal angle);
Thomas Zander's avatar
Thomas Zander committed
244 245 246

    /**
     * Return the current rotation in degrees.
247
     * It returns NaN if the shape has a shearing or scaling transformation applied.
Thomas Zander's avatar
Thomas Zander committed
248
     */
249
    qreal rotation() const;
Thomas Zander's avatar
Thomas Zander committed
250 251 252 253 254 255 256 257 258

    /**
     * @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
259
    void shear(qreal sx, qreal sy);
Thomas Zander's avatar
Thomas Zander committed
260 261 262 263

    /**
     * @brief Resize the shape
     *
264
     * @param size the new size of the shape.  This is different from scaling as
Jan Hambrecht's avatar
Jan Hambrecht committed
265
     * scaling is a so called secondary operation which is comparable to zooming in
Thomas Zander's avatar
Thomas Zander committed
266 267 268 269
     * instead of changing the size of the basic shape.
     * Easiest example of this difference is that using this method will not distort the
     * size of pattern-fills and borders.
     */
270
    virtual void setSize(const QSizeF &size);
Thomas Zander's avatar
Thomas Zander committed
271 272 273 274

    /**
     * @brief Get the size of the shape in pt.
     *
Thorsten Zachmann's avatar
Thorsten Zachmann committed
275 276
     * The size is in shape coordinates.
     *
Inge Wallin's avatar
Inge Wallin committed
277
     * @return the size of the shape as set by setSize()
Thomas Zander's avatar
Thomas Zander committed
278
     */
Thomas Zander's avatar
Thomas Zander committed
279
    virtual QSizeF size() const;
Thomas Zander's avatar
Thomas Zander committed
280 281 282 283 284 285

    /**
     * @brief Set the position of the shape in pt
     *
     * @param position the new position of the shape
     */
286
    virtual void setPosition(const QPointF &position);
Thomas Zander's avatar
Thomas Zander committed
287 288 289 290 291 292

    /**
     * @brief Get the position of the shape in pt
     *
     * @return the position of the shape
     */
293
    QPointF position() const;
Thomas Zander's avatar
Thomas Zander committed
294 295 296 297 298 299

    /**
     * @brief Check if the shape is hit on position
     * @param position the position where the user clicked.
     * @return true when it hits.
     */
300
    virtual bool hitTest(const QPointF &position) const;
Thomas Zander's avatar
Thomas Zander committed
301 302 303 304

    /**
     * @brief Get the bounding box of the shape
     *
305
     * This includes the line width and the shadow of the shape
Thomas Zander's avatar
Thomas Zander committed
306 307 308
     *
     * @return the bounding box of the shape
     */
309
    virtual QRectF boundingRect() const;
Thomas Zander's avatar
Thomas Zander committed
310 311 312

    /**
     * @brief Add a connector point to the shape
313
     * 
Thomas Zander's avatar
Thomas Zander committed
314 315 316
     * A connector is a place on the shape that allows a graphical connection to be made
     * using a line, for example.
     *
317
     * @param point the connection point to add
318
     * @return the id of the new connection point
Thomas Zander's avatar
Thomas Zander committed
319
     */
320
    int addConnectionPoint(const KoConnectionPoint &point);
321

322
    /**
323
     * Sets data of connection point with specified id.
324 325
     *
     * The position of the connector is restricted to the bounding rectangle of the shape.
326 327 328 329
     * 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.
330
     * 
331 332 333
     * @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
334
     */
335
    bool setConnectionPoint(int connectionPointId, const KoConnectionPoint &point);
336

337 338 339 340
    /// Checks if a connection point with the specified id exists
    bool hasConnectionPoint(int connectionPointId) const;

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

343 344
    /**
     * Return a list of the connection points that have been added to this shape.
Thomas Zander's avatar
Thomas Zander committed
345
     * All the points are relative to the shape position, see absolutePosition().
346 347
     * @return a list of the connectors that have been added to this shape.
     */
348
    KoConnectionPoints connectionPoints() const;
Thomas Zander's avatar
Thomas Zander committed
349

350 351 352 353 354 355
    /// Removes connection point with specified id
    void removeConnectionPoint(int connectionPointId);

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

356
    /**
357
     * Add a event action
358
     */
359
    void addEventAction(KoEventAction *action);
360 361 362 363

    /**
     * Remove a event action
     */
364
    void removeEventAction(KoEventAction *action);
365 366 367 368

    /**
     * Get all event actions
     */
369
    QSet<KoEventAction *> eventActions() const;
370

371
    /**
Sebastian Sauer's avatar
dox++  
Sebastian Sauer committed
372 373
     * 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.
374 375 376 377 378 379
     */
    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
380
     * @param runThrought run through the foreground or background or...
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
     */
    void setTextRunAroundSide(TextRunAroundSide side, Through runThrought = Background);

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

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

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
    /**
     * 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);

Thomas Zander's avatar
Thomas Zander committed
412 413
    /**
     * Set the background of the shape.
414
     * A shape background can be a plain color, a gradient, a pattern, be fully transparent
Jan Hambrecht's avatar
Jan Hambrecht committed
415
     * or have a complex fill.
416
     * Setting such a background will allow the shape to be filled and will be able to tell
Jan Hambrecht's avatar
Jan Hambrecht committed
417 418
     * if it is transparent or not.
     * @param background the new shape background.
Thomas Zander's avatar
Thomas Zander committed
419
     */
420 421
    void setBackground(KoShapeBackground *background);

Thomas Zander's avatar
Thomas Zander committed
422 423
    /**
     * return the brush used to paint te background of this shape with.
424
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
425
     * setting such a brush will allow the shape to fill itself using that brush and
426
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
427 428
     * @return the background-brush
     */
429
    KoShapeBackground *background() const;
Thomas Zander's avatar
Thomas Zander committed
430 431

    /**
432 433
     * 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
434
     * you should override it and always return true if your shape is not square.
435
     * @return if the shape is (partly) transparent.
Thomas Zander's avatar
Thomas Zander committed
436
     */
Thomas Zander's avatar
Thomas Zander committed
437
    virtual bool hasTransparency() const;
Thomas Zander's avatar
Thomas Zander committed
438

439 440 441 442 443
    /**
     * Sets shape level transparency.
     * @param transparency the new shape level transparency
     */
    void setTransparency(qreal transparency);
444

445 446 447 448 449
    /**
     * Returns the shape level transparency.
     * @param recursive when true takes the parents transparency into account
     */
    qreal transparency(bool recursive=false) const;
450

Thomas Zander's avatar
Thomas Zander committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    /**
     * 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.
467
     * The layering if two overlapping objects have the same index is implementation dependent
Thomas Zander's avatar
Thomas Zander committed
468 469 470
     * 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
471
    void setZIndex(int zIndex);
Thomas Zander's avatar
Thomas Zander committed
472

473 474 475 476 477 478 479 480 481 482 483 484
    /**
     * 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
485
    virtual void setRunThrough(short int runThrough);
486

Thomas Zander's avatar
Thomas Zander committed
487 488
    /**
     * Changes the Shape to be visible or invisible.
489
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
490 491
     *   things like guidelines or searches.
     * @param on when true; set the shape to be visible.
492
     * @see setGeometryProtected(), setContentProtected(), setSelectable()
Thomas Zander's avatar
Thomas Zander committed
493
     */
Thomas Zander's avatar
Thomas Zander committed
494
    void setVisible(bool on);
Thomas Zander's avatar
Thomas Zander committed
495 496
    /**
     * Returns current visibility state of this shape.
497
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
498
     *   things like guidelines or searches.
499
     * @param recursive when true, checks visibility recursively
Thomas Zander's avatar
Thomas Zander committed
500
     * @return current visibility state of this shape.
501
     * @see isGeometryProtected(), isContentProtected(), isSelectable()
Thomas Zander's avatar
Thomas Zander committed
502
     */
503
    bool isVisible(bool recursive = false) const;
Thomas Zander's avatar
Thomas Zander committed
504

505 506 507 508 509
    /**
     * 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),
510
     * it isPrinted will return false, too.
511 512 513 514 515 516 517 518 519 520 521 522
     */
    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;
523

524 525 526
    /**
     * Makes it possible for the user to select this shape.
     * This parameter defaults to true.
Thomas Zander's avatar
Thomas Zander committed
527
     * @param selectable when true; set the shape to be selectable by the user.
528
     * @see setGeometryProtected(), setContentProtected(), setVisible()
529
     */
Thomas Zander's avatar
Thomas Zander committed
530
    void setSelectable(bool selectable);
531

532
    /**
Thomas Zander's avatar
Thomas Zander committed
533
     * Returns if this shape can be selected by the user.
534
     * @return true only when the object is selectable.
535
     * @see isGeometryProtected(), isContentProtected(), isVisible()
536
     */
Thomas Zander's avatar
Thomas Zander committed
537
    bool isSelectable() const;
538

Thomas Zander's avatar
Thomas Zander committed
539
    /**
540 541 542 543
     * 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.
544
     * @see setContentProtected(), setSelectable(), setVisible()
Thomas Zander's avatar
Thomas Zander committed
545
     */
546
    void setGeometryProtected(bool on);
547

Thomas Zander's avatar
Thomas Zander committed
548
    /**
549 550 551 552
     * 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.
553
     * @see isContentProtected(), isSelectable(), isVisible()
Thomas Zander's avatar
Thomas Zander committed
554
     */
555
    bool isGeometryProtected() const;
Thomas Zander's avatar
Thomas Zander committed
556

557 558 559 560
    /**
     * 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.
561
     * @see setGeometryProtected(), setSelectable(), setVisible()
562 563
     */
    void setContentProtected(bool protect);
564

565 566 567 568
    /**
     * 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.
569
     * @see isGeometryProtected(), isSelectable(), isVisible()
570 571 572
     */
    bool isContentProtected() const;

Thomas Zander's avatar
Thomas Zander committed
573 574 575 576
    /**
     * 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
577
    KoShapeContainer *parent() const;
Thomas Zander's avatar
Thomas Zander committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591

    /**
     * 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.
     */
592
    virtual void update() const;
Thomas Zander's avatar
Thomas Zander committed
593 594 595 596 597 598 599 600

    /**
     * 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
601
     * @param rect the rectangle (in pt) to queue for repaint.
Thomas Zander's avatar
Thomas Zander committed
602
     */
Boudewijn Rempt's avatar
Boudewijn Rempt committed
603
    virtual void update(const QRectF &rect) const;
Thomas Zander's avatar
Thomas Zander committed
604 605 606

    /**
     * This is a method used to sort a list using the STL sorting methods.
607 608
     * @param s1 the first shape
     * @param s2 the second shape
Thomas Zander's avatar
Thomas Zander committed
609
     */
610
    static bool compareShapeZIndex(KoShape *s1, KoShape *s2);
Thomas Zander's avatar
Thomas Zander committed
611 612 613

    /**
     * returns the outline of the shape in the form of a path.
Casper Boemann's avatar
Casper Boemann committed
614
     * The outline returned will always be relative to the position() of the shape, so
Thomas Zander's avatar
Thomas Zander committed
615 616 617 618
     * moving the shape will not alter the result.  The outline is used to draw the border
     * on, for example.
     * @returns the outline of the shape in the form of a path.
     */
619
    virtual QPainterPath outline() const;
Thomas Zander's avatar
Thomas Zander committed
620

621 622
    /**
     * returns the outline of the shape in the form of a rect.
Casper Boemann's avatar
Casper Boemann committed
623 624 625
     * 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.
626 627 628 629
     * @returns the outline of the shape in the form of a rect.
     */
    virtual QRectF outlineRect() const;

Thomas Zander's avatar
Thomas Zander committed
630 631 632 633
    /**
     * Returns the currently set border, or 0 if there is no border.
     * @return the currently set border, or 0 if there is no border.
     */
634
    KoShapeBorderModel *border() const;
Thomas Zander's avatar
Thomas Zander committed
635 636 637 638 639

    /**
     * Set a new border, removing the old one.
     * @param border the new border, or 0 if there should be no border.
     */
640
    void setBorder(KoShapeBorderModel *border);
Thomas Zander's avatar
Thomas Zander committed
641

642 643 644 645 646 647
    /**
     * Return the insets of the border.
     * Convenience method for KoShapeBorderModel::borderInsets()
     */
    KoInsets borderInsets() const;

648
    /// Sets the new shadow, removing the old one
649
    void setShadow(KoShapeShadow *shadow);
650

651
    /// Returns the currently set shadow or 0 if there is no shadow set
652
    KoShapeShadow *shadow() const;
653

654
    /// Sets a new clip path, removing the old one
Jan Hambrecht's avatar
Jan Hambrecht committed
655
    void setClipPath(KoClipPath *clipPath);
656 657 658 659

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

Thomas Zander's avatar
Thomas Zander committed
660 661 662 663 664 665
    /**
     * 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
666
    void setKeepAspectRatio(bool keepAspect);
667

Thomas Zander's avatar
Thomas Zander committed
668 669 670 671 672 673
    /**
     * 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
674
    bool keepAspectRatio() const;
Thomas Zander's avatar
Thomas Zander committed
675 676 677 678

    /**
     * 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>
679
     * @param anchor The place on the (unaltered) shape that you want the position of.
Thomas Zander's avatar
Thomas Zander committed
680 681
     * @return the point that is the absolute, centered position of this shape.
     */
Jan Hambrecht's avatar
Jan Hambrecht committed
682
    QPointF absolutePosition(KoFlake::Position anchor = KoFlake::CenteredPosition) const;
683

Thomas Zander's avatar
Thomas Zander committed
684 685 686 687 688 689 690 691 692 693 694 695
    /**
     * 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
696
     * @param anchor The place on the (unaltered) shape that you set the position of.
Thomas Zander's avatar
Thomas Zander committed
697
     */
Jan Hambrecht's avatar
Jan Hambrecht committed
698
    void setAbsolutePosition(QPointF newPosition, KoFlake::Position anchor = KoFlake::CenteredPosition);
Thomas Zander's avatar
Thomas Zander committed
699

700 701
    /**
     * Set a data object on the shape to be used by an application.
702
     * This is specifically useful when a shape is created in a plugin and that data from that
703 704 705 706 707 708 709 710 711
     * 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;

712 713 714 715 716 717 718
    /**
     * 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);
719

720 721 722 723 724
    /**
     * Return the current applicationData.
     */
    KoShapeApplicationData *applicationData() const;

725
    /**
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
726
     * Return the Id of this shape, identifying the type of shape by the id of the factory.
727
     * @see KoShapeFactoryBase::shapeId()
728 729
     * @return the id of the shape-type
     */
730 731
    QString shapeId() const;

732 733 734
    /**
     * 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.
735
     * @see KoShapeFactoryBase::shapeId()
736 737
     * @param id the ID from the factory that created this shape
     */
Thomas Zander's avatar
Thomas Zander committed
738
    void setShapeId(const QString &id);
739

Thomas Zander's avatar
Thomas Zander committed
740 741
    /**
     * Create a matrix that describes all the transformations done on this shape.
742 743 744 745
     *
     * The absolute transformation is the combined transformation of this shape
     * and all its parents and grandparents.
     *
Thomas Zander's avatar
Thomas Zander committed
746 747 748
     * @param converter if not null, this method uses the converter to mark the right
     *        offsets in the current view.
     */
749
    QTransform absoluteTransformation(const KoViewConverter *converter) const;
Thomas Zander's avatar
Thomas Zander committed
750

751 752 753 754
    /**
     * Applies a transformation to this shape.
     *
     * The transformation given is relative to the global coordinate system, i.e. the document.
755 756
     * This is a convenience function to apply a global transformation to this shape.
     * @see applyTransformation
757 758 759
     *
     * @param matrix the transformation matrix to apply
     */
760
    void applyAbsoluteTransformation(const QTransform &matrix);
761 762 763 764 765

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

768
    /// Returns the shapes local transformation matrix
769
    QTransform transformation() const;
770 771 772 773 774 775 776 777

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

Thomas Zander's avatar
Thomas Zander committed
780 781 782 783 784 785
    /**
     * 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
786
    void copySettings(const KoShape *shape);
Thomas Zander's avatar
Thomas Zander committed
787

Thomas Zander's avatar
Thomas Zander committed
788 789 790 791 792 793 794 795 796
    /**
     * 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);

797 798 799 800 801
    /**
     * @brief Transforms point from shape coordinates to document coordinates
     * @param point in shape coordinates
     * @return point in document coordinates
     */
802
    QPointF shapeToDocument(const QPointF &point) const;
803 804 805 806 807 808

    /**
     * @brief Transforms rect from shape coordinates to document coordinates
     * @param rect in shape coordinates
     * @return rect in document coordinates
     */
809
    QRectF shapeToDocument(const QRectF &rect) const;
810 811 812 813 814 815

    /**
     * @brief Transforms point from document coordinates to shape coordinates
     * @param point in document coordinates
     * @return point in shape coordinates
     */
816
    QPointF documentToShape(const QPointF &point) const;
817 818 819 820 821 822

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

825 826 827 828
    /**
     * Returns the name of the shape.
     * @return the shapes name
     */
829
    QString name() const;
830 831 832 833 834

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

837 838 839 840 841
    /**
     * Update the position of the shape in the tree of the KoShapeManager.
     */
    void notifyChanged();

842
    /**
Thomas Zander's avatar
Thomas Zander committed
843
     * A shape can be in a state that it is doing processing data like loading or text layout.
844
     * 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
845
     * until it is fully done processing.
846
     * Warning! This method can be blocking for a long time
Boudewijn Rempt's avatar
Boudewijn Rempt committed
847 848 849
     * @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
850
     *                     start printing it when the in case of printing method returned.
Boudewijn Rempt's avatar
Boudewijn Rempt committed
851
     *                     If set to false the processing needs to be done synchronously and will
852 853 854
     *                     block until the result is finished.
     */
    virtual void waitUntilReady(const KoViewConverter &converter, bool asynchronous = true) const;
855

Thomas Zander's avatar
api dox  
Thomas Zander committed
856 857 858
    /**
     * Schedule the shape for thread-safe deletion.
     * After calling this method will self-delete in the main threads event loop.
Thomas Zander's avatar
Thomas Zander committed
859 860 861 862
     * If your code deletes a shape and your code can possibly be running in a separate thread,
     * you should use this method to delete the shape.
     * The reason for this is that If you delete a shape from another thread then it is
     * possible the main
Thomas Zander's avatar
api dox  
Thomas Zander committed
863
     * thread will use it after its been removed, while painting for example.
Thomas Zander's avatar
Thomas Zander committed
864 865
     *
     * Note that in contrary to the equivalent method on QObject, you can not call this more than once.
Thomas Zander's avatar
api dox  
Thomas Zander committed
866
     */
867
    void deleteLater();
868

869 870 871
    /// checks recursively if the shape or one of its parents is not visible or locked
    bool isEditable() const;

872 873
    /**
     * Adds a shape which depends on this shape.
874 875
     * Making a shape dependent on this one means it will get shapeChanged() called
     * on each update of this shape.
876 877 878 879 880
     *
     * 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
881 882
     * @return true if dependency could be established, otherwise false
     * @see removeDependee(), hasDependee()
883
     */
884
    bool addDependee(KoShape *shape);
885

886 887 888 889
    /**
     * Removes as shape depending on this shape.
     * @see addDependee(), hasDependee()
     */
890
    void removeDependee(KoShape *shape);
891

892
    /// Returns if the given shape is dependent on this shape
893
    bool hasDependee(KoShape *shape) const;
894

895 896 897
    /// Returns additional snap data the shape wants to have snapping to
    virtual KoSnapData snapData() const;

898 899 900 901 902 903 904 905 906
    /**
     * 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
     */
907
    void setAdditionalAttribute(const QString &name, const QString &value);
908 909 910 911 912 913

    /**
     * Remove additional attribute
     *
     * @param name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
     */
914
    void removeAdditionalAttribute(const QString &name);
915 916 917 918 919 920 921 922

    /**
     * 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
     */
923
    bool hasAdditionalAttribute(const QString &name) const;
924 925 926 927 928 929 930 931

    /**
     * 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.
     */
932
    QString additionalAttribute(const QString &name) const;
933

934
    void setAdditionalStyleAttribute(const char *name, const QString &value);
935

936
    void removeAdditionalStyleAttribute(const char *name);
937

938
    /**
939
     * Returns the filter effect stack of the shape
940 941 942
     *
     * @return the list of filter effects applied on the shape when rendering.
     */
943
    KoFilterEffectStack *filterEffectStack() const;
944

945
    /// Sets the new filter effect stack, removing the old one
946
    void setFilterEffectStack(KoFilterEffectStack *filterEffectStack);
947

948 949 950 951 952 953 954 955 956 957 958 959 960 961
    /**
     * 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();

962 963 964 965 966 967
    /**
     * 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
968
     * Notice that if the set is non-empty 'this' shape is no longer looked at. You can choose
969 970 971 972 973 974 975 976 977 978 979
     * 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);

980 981 982 983 984 985 986 987 988 989 990
    /**
     * Return the hyperlink for this shape.
     */
    QString hyperLink () const;

    /**
     * Set hyperlink for this shape.
     * @param hyperLink name.
     */
    void setHyperLink (QString & hyperLink);

991 992
    /**
     * \internal
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
993
     * Returns the private object for use within the flake lib
994 995 996
     */
    KoShapePrivate *priv();

997
protected:
998 999
    /// constructor
    KoShape(KoShapePrivate &);
1000

1001
    /* ** loading saving helper methods */
1002 1003
    /// attributes from ODF 1.1 chapter 9.2.15 Common Drawing Shape Attributes
    enum OdfAttribute {
1004 1005
        OdfTransformation = 1,       ///< Store transformation information
        OdfSize = 2,                 ///< Store size information
1006 1007 1008 1009 1010 1011 1012 1013
        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
        OdfZIndex = 1024,            ///< This only loads the z-index; when saving, it is reflected by the order of the shapes.
1014
        OdfViewbox = 2048,           ///< Store the viewbox
1015 1016 1017 1018 1019

        /// A mask for all mandatory attributes
        OdfMandatories = OdfLayer | OdfStyle | OdfId | OdfName | OdfZIndex,
        /// A mask for geometry attributes
        OdfGeometry = OdfPosition | OdfSize,
1020
        /// A mask for all the attributes
1021
        OdfAllAttributes = OdfTransformation | OdfGeometry | OdfAdditionalAttributes | OdfMandatories | OdfCommonChildElements
1022
    };
1023

1024 1025 1026 1027 1028 1029 1030
    /**
     * 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.
     */
1031
    bool loadOdfAttributes(const KoXmlElement &element, KoShapeLoadingContext &context, int attributes);
1032

Jan Hambrecht's avatar
 
Jan Hambrecht committed
1033 1034 1035 1036 1037
    /**
     * Parses the transformation attribute from the given string
     * @param transform the transform attribute string
     * @return the resulting transformation matrix
     */
1038
    QTransform parseOdfTransform(const QString &transform);
Jan Hambrecht's avatar
 
Jan Hambrecht committed
1039

1040
    /**
1041
     * @brief Saves the style used for the shape
1042
     *
1043 1044
     * This method fills the given style object with the border and
     * background properties and then adds the style to the context.
1045
     *
1046
     * @param style the style object to fill
1047 1048 1049
     * @param context used for saving
     * @return the name of the style
     * @see saveOdf
1050
     */
1051
    virtual QString saveStyle(KoGenStyle &style, KoShapeSavingContext &context) const;
1052 1053 1054 1055 1056 1057 1058

    /**
     * Loads the stroke and fill style from the given element.
     *
     * @param element the xml element to  load the style from
     * @param context the loading context used for loading
     */
1059
    virtual void loadStyle(const KoXmlElement &element, KoShapeLoadingContext &context);
1060

1061
    /// Loads the stroke style
1062
    KoShapeBorderModel *loadOdfStroke(const KoXmlElement &element, KoShapeLoadingContext &context) const;
1063

1064
    /// Loads the shadow style
1065
    KoShapeBackground *loadOdfFill(KoShapeLoadingContext &context) const;
1066

1067 1068 1069
    /// Loads the connection points
    void loadOdfGluePoints(const KoXmlElement &element, KoShapeLoadingContext &context);

1070
    /* ** end loading saving */
1071

1072 1073 1074 1075 1076
    /**
     * A hook that allows inheriting classes to do something after a KoShape property changed
     * This is called whenever the shape, position rotation or scale properties were altered.
     * @param type an indicator which type was changed.
     */
1077
    virtual void shapeChanged(ChangeType type, KoShape *shape = 0);
1078

Thomas Zander's avatar
Thomas Zander committed
1079
    /// return the current matrix that contains the rotation/scale/position of this shape
1080
    QTransform transform() const;
1081

1082 1083
    KoShapePrivate *d_ptr;

Thomas Zander's avatar
Thomas Zander committed
1084
private:
1085
    Q_DECLARE_PRIVATE(KoShape)
Thomas Zander's avatar
Thomas Zander committed
1086 1087
};

1088 1089
Q_DECLARE_METATYPE(KoShape*)

Thomas Zander's avatar
Thomas Zander committed
1090
#endif