Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

KoShape.h 29.8 KB
Newer Older
Thomas Zander's avatar
Thomas Zander committed
1
/* This file is part of the KDE project
2
   Copyright (C) 2006-2007 Thorsten Zachmann <zachmann@kde.org>
Thomas Zander's avatar
Thomas Zander committed
3 4
   Copyright (C) 2006 Casper Boemann Rasmussen <cbr@boemann.dk>
   Copyright (C) 2006 Thomas Zander <zander@kde.org>
5
   Copyright (C) 2007 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

Thomas Zander's avatar
Thomas Zander committed
29 30
#include <QMatrix>
#include <QVector>
31
#include <QSet>
Thomas Zander's avatar
Thomas Zander committed
32 33
#include <QBrush>

34 35
#include <KoXmlReaderForward.h>

36 37
#include "flake_export.h"

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

class KoShapeContainer;
43
class KoShapeConnection;
Thomas Zander's avatar
Thomas Zander committed
44
class KoShapeBorderModel;
45
class KoShapeManager;
46
class KoShapeUserData;
47
class KoViewConverter;
48
class KoShapeApplicationData;
49
class KoShapeSavingContext;
50
class KoCanvasBase;
51
class KoShapeLoadingContext;
52
class KoGenStyle;
53
class KoShapeControllerBase;
Thomas Zander's avatar
Thomas Zander committed
54 55

/**
56
 *
57
 * Base class for all flake shapes. Shapes extend this class
Thomas Zander's avatar
Thomas Zander committed
58 59 60
 * 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.
61
 *
62
 * Due to the limited responsibility of this class, the extending object
Thomas Zander's avatar
Thomas Zander committed
63
 * can have any data backend and is responsible for painting itself.
64
 *
65
 * We strongly suggest that any extending class will use a Model View
Thomas Zander's avatar
Thomas Zander committed
66
 * Controller (MVC) design where the View part is all in this class, as well
67
 * as the one that inherits from this one.  This allows the data that rests
Thomas Zander's avatar
Thomas Zander committed
68
 * in the model to be reused in different parts of the document. For example
69
 * by having two flake objects that show that same data. Or each showing a section of it.
70
 *
71 72 73 74 75
 * 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()
76
 *
77
 * <p>Flake objects can be created in three ways:
78 79 80 81 82
 * <ul>
 *   <li>a simple new KoDerivedFlake(),
 *   <li>through an associated tool,
 *   <li>through a factory
 * </ul>
Thomas Zander's avatar
Thomas Zander committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96
 * 
 * <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
97
 */
98
class FLAKE_EXPORT KoShape
Thomas Zander's avatar
Thomas Zander committed
99 100
{
public:
101 102 103
    /// Used by shapeChanged() to select which change was made
    enum ChangeType {
        PositionChanged, ///< used after a setPosition()
104 105 106 107
        RotationChanged, ///< used after a setRotation()
        ScaleChanged,   ///< used after a setScale()
        ShearChanged,   ///< used after a setShear()
        SizeChanged,    ///< used after a setSize()
108
        GenericMatrixChange,    ///< used after the matrix was changed without knowing which property explicitly changed
109
        ParentChanged,   ///< used after a setParent()
110 111
        CollisionDetected, ///< used when another shape moved in our boundingrect
        Deleted ///< the shape was deleted
112 113
    };

Thomas Zander's avatar
Thomas Zander committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127
    /**
     * @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
128
     * something transparent on top.
Thomas Zander's avatar
Thomas Zander committed
129 130 131 132
     * 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.
133 134
     * 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
135 136 137 138
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
     * @see applyConversion()
     */
139
    virtual void paint(QPainter &painter, const KoViewConverter &converter) = 0;
Thomas Zander's avatar
Thomas Zander committed
140 141 142 143 144 145 146

    /**
     * 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
147 148
     * @param canvas the canvas that requested this paint.  This can be used to retrieve canvas specific properties
     *      like selection and get a reference to the KoCanvasResourceProvider.
Thomas Zander's avatar
Thomas Zander committed
149
     */
150
    virtual void paintDecorations(QPainter &painter, const KoViewConverter &converter, const KoCanvasBase *canvas);
Thomas Zander's avatar
Thomas Zander committed
151

152 153 154 155 156 157
    /**
     * Load a shape from odf
     *
     * @param context the KoShapeLoadingContext used for loading
     * @param element element which represents the shape in odf
     *
158
     * @return false if loading failed
159
     */
160
    virtual bool loadOdf( const KoXmlElement & element, KoShapeLoadingContext &context ) = 0;
161

162
    /**
163 164 165
     * @brief store the shape data as ODF XML.
     * This is the method that will be called when saving a shape as a described in¬
     * OpenDocument 9.2 Drawing Shapes.
Thorsten Zachmann's avatar
Thorsten Zachmann committed
166
     * @see saveOdfAttributes
167
     */
168
    virtual void saveOdf( KoShapeSavingContext & context ) const = 0;
169 170

    /**
171 172 173
     * When saving this shape to ODF, you may nest it in a 'draw:frame' and shape properties should be
     * saved as attributes on that element instead of on the normal shape.  After starting to write such
     * an element you can call this method to write all relevant properties.
174
     */
175
    void saveOdfFrameAttributes( KoShapeSavingContext & context ) const;
176

Thomas Zander's avatar
Thomas Zander committed
177 178 179 180 181 182 183
    /**
     * @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
     */
184
    void setScale( double sx, double sy );
Thomas Zander's avatar
Thomas Zander committed
185 186 187 188

    /**
     * Return the current scaling adjustment over the X axis.
     */
189
    KDE_DEPRECATED double scaleX() const;
Thomas Zander's avatar
Thomas Zander committed
190 191 192 193

    /**
     * Return the current scaling adjustment over the Y axis.
     */
194
    KDE_DEPRECATED double scaleY() const;
Thomas Zander's avatar
Thomas Zander committed
195 196

    /**
197
     * @brief Rotate the shape (relative)
Thomas Zander's avatar
Thomas Zander committed
198
     *
199
     * 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
200
     *
201
     * @param angle change the angle of rotation increasing it with 'angle' degrees
Thomas Zander's avatar
Thomas Zander committed
202 203 204 205 206
     */
    void rotate( double angle );

    /**
     * Return the current rotation in degrees.
207
     * It returns NaN if the shape has a shearing or scaling transformation applied.
Thomas Zander's avatar
Thomas Zander committed
208
     */
209
    double rotation() const;
Thomas Zander's avatar
Thomas Zander committed
210 211 212 213 214 215 216 217 218

    /**
     * @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
     */
219
    void setShear( double sx, double sy );
Thomas Zander's avatar
Thomas Zander committed
220

Thomas Zander's avatar
Thomas Zander committed
221 222 223 224
    /**
     * Return the current horizontal shearing angle for this shape.
     * @return the current horizontal shearing angle for this shape.
     */
225
    KDE_DEPRECATED double shearX() const;
Thomas Zander's avatar
Thomas Zander committed
226

Thomas Zander's avatar
Thomas Zander committed
227 228 229 230
    /**
     * Return the current vertical shearing angle for this shape.
     * @return the current vertical shearing angle for this shape.
     */
231
    KDE_DEPRECATED double shearY() const;
Thomas Zander's avatar
Thomas Zander committed
232

Thomas Zander's avatar
Thomas Zander committed
233 234 235
    /**
     * @brief Resize the shape
     *
236
     * @param size the new size of the shape.  This is different from scaling as
Jan Hambrecht's avatar
Jan Hambrecht committed
237
     * scaling is a so called secondary operation which is comparable to zooming in
Thomas Zander's avatar
Thomas Zander committed
238 239 240 241
     * 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.
     */
242
    virtual void setSize( const QSizeF &size );
Thomas Zander's avatar
Thomas Zander committed
243 244 245 246

    /**
     * @brief Get the size of the shape in pt.
     *
Thorsten Zachmann's avatar
Thorsten Zachmann committed
247 248
     * The size is in shape coordinates.
     *
Thomas Zander's avatar
Thomas Zander committed
249 250
     * @return the size of the shape as set by resize()
     */
Thomas Zander's avatar
Thomas Zander committed
251
    virtual QSizeF size() const;
Thomas Zander's avatar
Thomas Zander committed
252 253 254 255 256 257 258 259 260 261 262 263 264

    /**
     * @brief Set the position of the shape in pt
     *
     * @param position the new position of the shape
     */
    virtual void setPosition( const QPointF &position );

    /**
     * @brief Get the position of the shape in pt
     *
     * @return the position of the shape
     */
Thomas Zander's avatar
Thomas Zander committed
265
    virtual QPointF position() const;
Thomas Zander's avatar
Thomas Zander committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280

    /**
     * @brief Check if the shape is hit on position
     * @param position the position where the user clicked.
     * @return true when it hits.
     */
    virtual bool hitTest( const QPointF &position ) const;

    /**
     * @brief Get the bounding box of the shape
     *
     * This includes the line width but not the shadow of the shape
     *
     * @return the bounding box of the shape
     */
281
    virtual QRectF boundingRect() const;
Thomas Zander's avatar
Thomas Zander committed
282 283 284 285 286 287 288 289 290 291 292

    /**
     * @brief Add a connector point to the shape
     * A connector is a place on the shape that allows a graphical connection to be made
     * using a line, for example.
     *
     * @param point the position where to place the connector. The points coordinate system
     *   are based around the zero-pos which is the top-left of the shape
     *   The point does not have to be inside the boundings rectangle.  The point is in pt,
     *   just like the rest of the KoShape class uses.
     */
Thomas Zander's avatar
Thomas Zander committed
293
    void addConnectionPoint( const QPointF &point );
Thomas Zander's avatar
Thomas Zander committed
294

Thomas Zander's avatar
Thomas Zander committed
295
    /**
296
     * Return a list of the connection points that have been added to this shape.
Thomas Zander's avatar
Thomas Zander committed
297 298
     * @return a list of the connectors that have been added to this shape.
     */
299
    KDE_DEPRECATED QList<QPointF> connectors() const;
300 301 302 303
    /**
     * Return a list of the connection points that have been added to this shape.
     * @return a list of the connectors that have been added to this shape.
     */
304
    QList<QPointF> connectionPoints() const;
Thomas Zander's avatar
Thomas Zander committed
305

Thomas Zander's avatar
Thomas Zander committed
306 307
    /**
     * Set the background of the shape.
308
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
309
     * setting such a brush will allow the shape to fill itself using that brush and
310
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
311 312
     * @param brush the brush for the background.
     */
Thomas Zander's avatar
Thomas Zander committed
313
    void setBackground ( const QBrush & brush );
Thomas Zander's avatar
Thomas Zander committed
314 315 316

    /**
     * return the brush used to paint te background of this shape with.
317
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
318
     * setting such a brush will allow the shape to fill itself using that brush and
319
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
320 321
     * @return the background-brush
     */
322
    QBrush background() const;
Thomas Zander's avatar
Thomas Zander committed
323 324

    /**
325 326
     * 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
327
     * you should override it and always return true if your shape is not square.
328
     * @return if the shape is (partly) transparent.
Thomas Zander's avatar
Thomas Zander committed
329
     */
330
    virtual bool hasTransparency();
Thomas Zander's avatar
Thomas Zander committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

    /**
     * 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.
348
     * The layering if two overlapping objects have the same index is implementation dependent
Thomas Zander's avatar
Thomas Zander committed
349 350 351
     * 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
352
    void setZIndex(int zIndex);
Thomas Zander's avatar
Thomas Zander committed
353 354 355

    /**
     * Changes the Shape to be visible or invisible.
356
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
357 358 359
     *   things like guidelines or searches.
     * @param on when true; set the shape to be visible.
     */
Thomas Zander's avatar
Thomas Zander committed
360
    void setVisible(bool on);
Thomas Zander's avatar
Thomas Zander committed
361 362
    /**
     * Returns current visibility state of this shape.
363
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
364 365 366
     *   things like guidelines or searches.
     * @return current visibility state of this shape.
     */
Thomas Zander's avatar
Thomas Zander committed
367
    bool isVisible() const;
Thomas Zander's avatar
Thomas Zander committed
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    /**
     * 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),
     * it isPrinted will return false, too. 
     */
    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;
    
388 389 390
    /**
     * Makes it possible for the user to select this shape.
     * This parameter defaults to true.
Thomas Zander's avatar
Thomas Zander committed
391
     * @param selectable when true; set the shape to be selectable.
392
     */
Thomas Zander's avatar
Thomas Zander committed
393
    void setSelectable(bool selectable);
394 395 396 397
    /**
     * Returns wheather this shape can be selected by the user.
     * @return true only when the object is selectable.
     */
Thomas Zander's avatar
Thomas Zander committed
398
    bool isSelectable() const;
399

Thomas Zander's avatar
Thomas Zander committed
400 401 402 403 404
    /**
     * Changes the Shape to be locked in place.
     * Being locked means the shape can no longer change shape or position.
     * @param locked when true; set the shape to be locked.
     */
Thomas Zander's avatar
Thomas Zander committed
405
    void setLocked(bool locked);
Thomas Zander's avatar
Thomas Zander committed
406 407 408 409 410
    /**
     * Returns current locked state of this shape.
     * Being locked means the shape can no longer change shape or position.
     * @return current locked state of this shape.
     */
Thomas Zander's avatar
Thomas Zander committed
411
    bool isLocked() const;
Thomas Zander's avatar
Thomas Zander committed
412 413 414 415 416

    /**
     * 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
417
    KoShapeContainer *parent() const;
Thomas Zander's avatar
Thomas Zander committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431

    /**
     * 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.
     */
432
    virtual void update() const;
Thomas Zander's avatar
Thomas Zander committed
433 434 435 436 437 438 439 440 441 442

    /**
     * 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.
     * @param shape the rectangle (in pt) to queue for repaint.
     */
443
    void update(const QRectF &shape) const;
Thomas Zander's avatar
Thomas Zander committed
444 445 446

    /**
     * This is a method used to sort a list using the STL sorting methods.
447 448
     * @param s1 the first shape
     * @param s2 the second shape
Thomas Zander's avatar
Thomas Zander committed
449
     */
450
    static bool compareShapeZIndex(KoShape *s1, KoShape *s2);
Thomas Zander's avatar
Thomas Zander committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464

    /**
     * returns the outline of the shape in the form of a path.
     * The outline returned will always have the position() of the shape as the origin, so
     * 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.
     */
    virtual const QPainterPath outline() const;

    /**
     * Returns the currently set border, or 0 if there is no border.
     * @return the currently set border, or 0 if there is no border.
     */
465
    KoShapeBorderModel *border() const;
Thomas Zander's avatar
Thomas Zander committed
466 467 468 469 470

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

473 474 475 476 477 478
    /**
     * Return the insets of the border.
     * Convenience method for KoShapeBorderModel::borderInsets()
     */
    KoInsets borderInsets() const;

Thomas Zander's avatar
Thomas Zander committed
479 480 481 482 483 484
    /**
     * 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
485
    void setKeepAspectRatio(bool keepAspect);
486

Thomas Zander's avatar
Thomas Zander committed
487 488 489 490 491 492
    /**
     * 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
493
    bool keepAspectRatio() const;
Thomas Zander's avatar
Thomas Zander committed
494 495 496 497

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

Thomas Zander's avatar
Thomas Zander committed
503 504 505 506 507 508 509 510 511 512 513 514
    /**
     * 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
515
     * @param anchor The place on the (unaltered) shape that you set the position of.
Thomas Zander's avatar
Thomas Zander committed
516
     */
Jan Hambrecht's avatar
Jan Hambrecht committed
517
    void setAbsolutePosition(QPointF newPosition, KoFlake::Position anchor = KoFlake::CenteredPosition);
Thomas Zander's avatar
Thomas Zander committed
518

519 520
    /**
     * Set a data object on the shape to be used by an application.
521
     * This is specifically useful when a shape is created in a plugin and that data from that
522 523 524 525 526 527 528 529 530
     * 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;

531 532 533 534 535 536 537 538 539 540 541 542
    /**
     * 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);
    /**
     * Return the current applicationData.
     */
    KoShapeApplicationData *applicationData() const;

543
    /**
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
544
     * Return the Id of this shape, identifying the type of shape by the id of the factory.
545 546 547
     * @see KoShapeFactory::shapeId()
     * @return the id of the shape-type
     */
Thomas Zander's avatar
Thomas Zander committed
548
    const QString & shapeId() const;
549 550 551 552 553 554
    /**
     * 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.
     * @see KoShapeFactory::shapeId()
     * @param id the ID from the factory that created this shape
     */
Thomas Zander's avatar
Thomas Zander committed
555
    void setShapeId(const QString &id);
556

Thomas Zander's avatar
Thomas Zander committed
557 558
    /**
     * Create a matrix that describes all the transformations done on this shape.
559 560 561 562
     *
     * The absolute transformation is the combined transformation of this shape
     * and all its parents and grandparents.
     *
Thomas Zander's avatar
Thomas Zander committed
563 564 565
     * @param converter if not null, this method uses the converter to mark the right
     *        offsets in the current view.
     */
566
    QMatrix absoluteTransformation(const KoViewConverter *converter) const;
Thomas Zander's avatar
Thomas Zander committed
567

568 569 570 571
    /**
     * Applies a transformation to this shape.
     *
     * The transformation given is relative to the global coordinate system, i.e. the document.
572 573
     * This is a convenience function to apply a global transformation to this shape.
     * @see applyTransformation
574 575 576
     *
     * @param matrix the transformation matrix to apply
     */
577
    void applyAbsoluteTransformation(const QMatrix &matrix );
578 579 580 581 582 583 584

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

585
    /// Returns the shapes local transformation matrix
586 587 588 589 590 591 592 593 594 595
    QMatrix transformation() const;

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

Thomas Zander's avatar
Thomas Zander committed
597 598 599 600 601 602 603 604
    /**
     * 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
     */
    virtual void copySettings(const KoShape *shape);

Thomas Zander's avatar
Thomas Zander committed
605 606 607 608 609 610 611 612 613
    /**
     * 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);

Thomas Zander's avatar
Thomas Zander committed
614 615 616
    /**
     * Return all the connections made to or from this shape.
     */
617 618
    QList<KoShapeConnection*> connections() const;

619 620 621 622
    /**
     * Returns the name of the shape.
     * @return the shapes name
     */
623
    QString name() const;
624 625 626 627 628 629 630

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

631 632 633 634 635
    /**
     * Update the position of the shape in the tree of the KoShapeManager.
     */
    void notifyChanged();

636 637 638 639 640 641 642 643 644
    /**
     * A shape can be in a state that its doing loading or text layout or similar in which case
     * it can be shown on screen just fine (probably partially) but it should really not be printed
     * until its fully done.
     * Flake will call this method from a non-main thread and only start printing it when the
     * method returned.
     * Warning!  This method can be blocking for a long time, never call it on the gui-thread!
     */
    virtual void waitUntilReady() const {}
645

Thomas Zander's avatar
api dox  
Thomas Zander committed
646 647 648 649 650 651 652 653
    /**
     * Schedule the shape for thread-safe deletion.
     * After calling this method will self-delete in the main threads event loop.
     * If deleting a shape can possibly be done in a separate thread, you should delete it
     * using this method.  If you delete a shape from another thread then its possible the main
     * thread will use it after its been removed, while painting for example.
     * Note that in contrary to the equivalent method on QObject, you can not call this more than ones!
     */
654
    void deleteLater();
655

656 657 658
    /// checks recursively if the shape or one of its parents is not visible or locked
    bool isEditable() const;

659 660 661 662 663 664 665 666 667
        /// Removes connection point with given index
    void removeConnectionPoint( int index );

    /// Adds a shape which depends on this shape
    void addDependee( KoShape * shape );

    /// Removes as shape depending on this shape
    void removeDependee( KoShape * shape );

668 669 670 671 672 673 674 675 676
    /**
     * Creates a clone of this shape.
     *
     * Deriving shapes have to implement the proteced abstract clone
     * function which does create the specific shape instance and
     * copies the shapes data.
     */
    KoShape * clone( KoShapeControllerBase * base ) const;

677
protected:
678 679

/* ** loading saving helper methods */
680 681 682 683 684 685 686
    /// attributes from ODF 1.1 chapter 9.2.15 Common Drawing Shape Attributes
    enum OdfAttribute {
        OdfTransformation = 1,  ///< Store transformation information
        OdfSize = 2,            ///< Store size information
        OdfPosition = 4,        ///< Store position of shape
        OdfMandatories = 8,     ///< Id, z-index, layer and style

Thomas Zander's avatar
Thomas Zander committed
687
        /// A mask for all the attributes a 'draw:frame' requires
688 689
        FrameAttributes = OdfMandatories | OdfSize | OdfPosition | OdfTransformation
    };
690

691 692 693 694 695 696 697 698
    /**
     * 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.
     */
    bool loadOdfAttributes( const KoXmlElement & element, KoShapeLoadingContext &context, int attributes );
699

Jan Hambrecht's avatar
 
Jan Hambrecht committed
700 701 702 703 704 705 706
    /**
     * Parses the transformation attribute from the given string
     * @param transform the transform attribute string
     * @return the resulting transformation matrix
     */
    QMatrix parseOdfTransform( const QString &transform );

707
    /**
708 709
     * This method can be used while saving the shape as ODF to add the data
     * stored on this shape to the current element.
710
     *
711 712 713
     * @param context the context for the current save.
     * @param attributes a number of OdfAttribute items to state which attributes to save.
     * @see saveOdf
714
     */
715
    void saveOdfAttributes( KoShapeSavingContext &context, int attributes ) const;
716

717
    /**
718
     * Add a new draw-glue-point element for each connections() present on this shape.
719
     */
720
    void saveOdfConnections( KoShapeSavingContext &context ) const;
721

722
    /**
723
     * @brief Saves the style used for the shape
724
     *
725 726
     * This method fills the given style object with the border and
     * background properties and then adds the style to the context.
727
     *
728
     * @param style the style object to fill
729 730 731
     * @param context used for saving
     * @return the name of the style
     * @see saveOdf
732
     */
733 734 735 736 737 738 739 740 741
    virtual QString saveStyle( KoGenStyle &style, KoShapeSavingContext &context ) const;

    /**
     * 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
     */
    virtual void loadStyle( const KoXmlElement & element, KoShapeLoadingContext &context );
742

743 744 745
    /// Loads the fill style
    QBrush loadOdfFill( const KoXmlElement & element, KoShapeLoadingContext & context );

746 747 748
    /// Loads the stroke style
    KoShapeBorderModel * loadOdfStroke( const KoXmlElement & element, KoShapeLoadingContext & context );

749 750 751 752 753
    /**
     * Fills the style stack and returns the value of the given style property (e.g fill, stroke).
     */
    QString getStyleProperty( const char *property, const KoXmlElement & element, KoShapeLoadingContext & context );

754 755
/* ** end loading saving */

756

757 758 759 760 761 762 763
    /**
     * 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.
     */
    virtual void shapeChanged(ChangeType type) { Q_UNUSED(type); }

764 765 766
    /// This is called whenever a shape this shape depends on has changed
    virtual void notifyShapeChanged( KoShape * shape, ChangeType type );

Thomas Zander's avatar
Thomas Zander committed
767 768 769 770 771 772
    /**
     * 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.
     */
Thomas Zander's avatar
Thomas Zander committed
773
    void setCollisionDetection(bool detect);
Thomas Zander's avatar
Thomas Zander committed
774 775 776 777
    /**
     * get the property collision detection.
     * @returns true if collision detection is on.
     */
Thomas Zander's avatar
Thomas Zander committed
778
    bool collisionDetection();
Thomas Zander's avatar
Thomas Zander committed
779

Thomas Zander's avatar
Thomas Zander committed
780
    /// return the current matrix that contains the rotation/scale/position of this shape
781 782
    const QMatrix& matrix() const;

783
    friend class KoShapeConnection;
Thomas Zander's avatar
Thomas Zander committed
784 785 786 787
    /**
     * Add a connection to the list of connections of this shape.
     * This is typically called only from the constructor of the KoShapeConnection class.
     */
788
    void addConnection(KoShapeConnection *connection);
Thomas Zander's avatar
Thomas Zander committed
789 790 791 792
    /**
     * Remove a connection to the list of connections of this shape.
     * This is typically called only from the destructor of the KoShapeConnection class.
     */
793 794
    void removeConnection(KoShapeConnection *connection);

795 796 797
    /// Deriving shapes have to implement that to support cloning
    virtual KoShape * cloneShape() const = 0;

Thomas Zander's avatar
Thomas Zander committed
798 799
private:
    friend class KoShapeManager;
Thomas Zander's avatar
Thomas Zander committed
800 801 802
    void addShapeManager( KoShapeManager * manager );
    void removeShapeManager( KoShapeManager * manager );

803 804 805
    class Private;
    friend class Private;
    Private * const d;
Thomas Zander's avatar
Thomas Zander committed
806 807
};

Thomas Zander's avatar
Thomas Zander committed
808
#endif