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 31.3 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>
Thomas Zander's avatar
Thomas Zander committed
4
   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>
32
#include <QMap>
Thomas Zander's avatar
Thomas Zander committed
33 34
#include <QBrush>

35
#include <KoXmlReaderForward.h>
36
#include <KoSnapData.h>
37

38 39
#include "flake_export.h"

Thomas Zander's avatar
Thomas Zander committed
40 41 42 43 44 45
class QPainter;
class QRectF;
class QPainterPath;

class KoShapeContainer;
class KoShapeBorderModel;
46
class KoShapeManager;
47
class KoShapeUserData;
48
class KoViewConverter;
49
class KoShapeApplicationData;
50
class KoShapeSavingContext;
51
class KoCanvasBase;
52
class KoShapeLoadingContext;
53
class KoGenStyle;
54
class KoShapeControllerBase;
55
class KoDataCenter;
56
class KoShapeShadow;
57
class KoEventAction;
Thomas Zander's avatar
Thomas Zander committed
58 59

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

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

    /**
     * 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
154 155
     * @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
156
     */
157
    virtual void paintDecorations(QPainter &painter, const KoViewConverter &converter, const KoCanvasBase *canvas);
Thomas Zander's avatar
Thomas Zander committed
158

159 160 161 162 163 164
    /**
     * Load a shape from odf
     *
     * @param context the KoShapeLoadingContext used for loading
     * @param element element which represents the shape in odf
     *
165
     * @return false if loading failed
166
     */
167
    virtual bool loadOdf( const KoXmlElement & element, KoShapeLoadingContext &context ) = 0;
168

169
    /**
170 171 172
     * @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
173
     * @see saveOdfAttributes
174
     */
175
    virtual void saveOdf( KoShapeSavingContext & context ) const = 0;
176 177

    /**
178 179 180 181 182 183
     * 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
184
     */
185
    void saveOdfAttributes( KoShapeSavingContext &context, int attributes ) const;
186

Thorsten Zachmann's avatar
Thorsten Zachmann committed
187 188 189 190 191 192 193
    /**
     * 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.
     */
    void saveOdfCommonChildElements( KoShapeSavingContext &context ) const;

194 195 196 197 198 199 200
    /**
     * After the shape has been created this method is called so it can get access to any DataCenter it
     * might want.
     * The default implementation does nothing.
     */
    virtual void init( QMap<QString, KoDataCenter *> dataCenterMap ) {Q_UNUSED(dataCenterMap)};

Thomas Zander's avatar
Thomas Zander committed
201 202 203 204 205 206 207
    /**
     * @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
     */
208
    void setScale( double sx, double sy );
Thomas Zander's avatar
Thomas Zander committed
209 210

    /**
211
     * @brief Rotate the shape (relative)
Thomas Zander's avatar
Thomas Zander committed
212
     *
213
     * 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
214
     *
215
     * @param angle change the angle of rotation increasing it with 'angle' degrees
Thomas Zander's avatar
Thomas Zander committed
216 217 218 219 220
     */
    void rotate( double angle );

    /**
     * Return the current rotation in degrees.
221
     * It returns NaN if the shape has a shearing or scaling transformation applied.
Thomas Zander's avatar
Thomas Zander committed
222
     */
223
    double rotation() const;
Thomas Zander's avatar
Thomas Zander committed
224 225 226 227 228 229 230 231 232

    /**
     * @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
     */
233
    void setShear( double sx, double sy );
Thomas Zander's avatar
Thomas Zander committed
234 235 236 237

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

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

    /**
     * @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
267
    virtual QPointF position() const;
Thomas Zander's avatar
Thomas Zander committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

    /**
     * @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
     */
283
    virtual QRectF boundingRect() const;
Thomas Zander's avatar
Thomas Zander committed
284 285 286 287 288 289 290 291 292 293 294

    /**
     * @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
295
    void addConnectionPoint( const QPointF &point );
Thomas Zander's avatar
Thomas Zander committed
296

297 298 299 300
    /**
     * 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.
     */
301
    QList<QPointF> connectionPoints() const;
Thomas Zander's avatar
Thomas Zander committed
302

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
    /**
     * Add a event action 
     */
    void addEventAction( KoEventAction * action );

    /**
     * Remove a event action
     */
    void removeEventAction( KoEventAction * action );

    /**
     * Get all event actions
     */
    QList<KoEventAction *> eventActions() const;

Thomas Zander's avatar
Thomas Zander committed
318 319
    /**
     * Set the background of the shape.
320
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
321
     * setting such a brush will allow the shape to fill itself using that brush and
322
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
323 324
     * @param brush the brush for the background.
     */
Thomas Zander's avatar
Thomas Zander committed
325
    void setBackground ( const QBrush & brush );
Thomas Zander's avatar
Thomas Zander committed
326 327 328

    /**
     * return the brush used to paint te background of this shape with.
329
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
330
     * setting such a brush will allow the shape to fill itself using that brush and
331
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
332 333
     * @return the background-brush
     */
334
    QBrush background() const;
Thomas Zander's avatar
Thomas Zander committed
335 336

    /**
337 338
     * 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
339
     * you should override it and always return true if your shape is not square.
340
     * @return if the shape is (partly) transparent.
Thomas Zander's avatar
Thomas Zander committed
341
     */
342
    virtual bool hasTransparency();
Thomas Zander's avatar
Thomas Zander committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

    /**
     * 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.
360
     * The layering if two overlapping objects have the same index is implementation dependent
Thomas Zander's avatar
Thomas Zander committed
361 362 363
     * 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
364
    void setZIndex(int zIndex);
Thomas Zander's avatar
Thomas Zander committed
365 366 367

    /**
     * Changes the Shape to be visible or invisible.
368
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
369 370 371
     *   things like guidelines or searches.
     * @param on when true; set the shape to be visible.
     */
Thomas Zander's avatar
Thomas Zander committed
372
    void setVisible(bool on);
Thomas Zander's avatar
Thomas Zander committed
373 374
    /**
     * Returns current visibility state of this shape.
375
     * Being visible means being painted, as well as being used for
Thomas Zander's avatar
Thomas Zander committed
376
     *   things like guidelines or searches.
377
     * @param recursive when true, checks visibility recursively
Thomas Zander's avatar
Thomas Zander committed
378 379
     * @return current visibility state of this shape.
     */
380
    bool isVisible( bool recursive = false ) const;
Thomas Zander's avatar
Thomas Zander committed
381

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
    /**
     * 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;
    
401 402 403
    /**
     * Makes it possible for the user to select this shape.
     * This parameter defaults to true.
Thomas Zander's avatar
Thomas Zander committed
404
     * @param selectable when true; set the shape to be selectable.
405
     */
Thomas Zander's avatar
Thomas Zander committed
406
    void setSelectable(bool selectable);
407 408 409 410
    /**
     * 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
411
    bool isSelectable() const;
412

Thomas Zander's avatar
Thomas Zander committed
413 414 415 416 417
    /**
     * 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
418
    void setLocked(bool locked);
Thomas Zander's avatar
Thomas Zander committed
419 420 421 422 423
    /**
     * 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
424
    bool isLocked() const;
Thomas Zander's avatar
Thomas Zander committed
425 426 427 428 429

    /**
     * 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
430
    KoShapeContainer *parent() const;
Thomas Zander's avatar
Thomas Zander committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444

    /**
     * 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.
     */
445
    virtual void update() const;
Thomas Zander's avatar
Thomas Zander committed
446 447 448 449 450 451 452 453 454 455

    /**
     * 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.
     */
456
    void update(const QRectF &shape) const;
Thomas Zander's avatar
Thomas Zander committed
457 458 459

    /**
     * This is a method used to sort a list using the STL sorting methods.
460 461
     * @param s1 the first shape
     * @param s2 the second shape
Thomas Zander's avatar
Thomas Zander committed
462
     */
463
    static bool compareShapeZIndex(KoShape *s1, KoShape *s2);
Thomas Zander's avatar
Thomas Zander committed
464 465 466 467 468 469 470 471 472 473 474 475 476 477

    /**
     * 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.
     */
478
    KoShapeBorderModel *border() const;
Thomas Zander's avatar
Thomas Zander committed
479 480 481 482 483

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

486 487 488 489 490 491
    /**
     * Return the insets of the border.
     * Convenience method for KoShapeBorderModel::borderInsets()
     */
    KoInsets borderInsets() const;

492 493 494 495 496 497
    /// Sets the new shadow, removing the old one
    void setShadow( KoShapeShadow * shadow );

    /// Returns the currently set shadow or 0 if there is now shadow set
    KoShapeShadow * shadow() const;

Thomas Zander's avatar
Thomas Zander committed
498 499 500 501 502 503
    /**
     * 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
504
    void setKeepAspectRatio(bool keepAspect);
505

Thomas Zander's avatar
Thomas Zander committed
506 507 508 509 510 511
    /**
     * 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
512
    bool keepAspectRatio() const;
Thomas Zander's avatar
Thomas Zander committed
513 514 515 516

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

Thomas Zander's avatar
Thomas Zander committed
522 523 524 525 526 527 528 529 530 531 532 533
    /**
     * 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
534
     * @param anchor The place on the (unaltered) shape that you set the position of.
Thomas Zander's avatar
Thomas Zander committed
535
     */
Jan Hambrecht's avatar
Jan Hambrecht committed
536
    void setAbsolutePosition(QPointF newPosition, KoFlake::Position anchor = KoFlake::CenteredPosition);
Thomas Zander's avatar
Thomas Zander committed
537

538 539
    /**
     * Set a data object on the shape to be used by an application.
540
     * This is specifically useful when a shape is created in a plugin and that data from that
541 542 543 544 545 546 547 548 549
     * 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;

550 551 552 553 554 555 556 557 558 559 560 561
    /**
     * 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;

562
    /**
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
563
     * Return the Id of this shape, identifying the type of shape by the id of the factory.
564 565 566
     * @see KoShapeFactory::shapeId()
     * @return the id of the shape-type
     */
Thomas Zander's avatar
Thomas Zander committed
567
    const QString & shapeId() const;
568 569 570 571 572 573
    /**
     * 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
574
    void setShapeId(const QString &id);
575

Thomas Zander's avatar
Thomas Zander committed
576 577
    /**
     * Create a matrix that describes all the transformations done on this shape.
578 579 580 581
     *
     * The absolute transformation is the combined transformation of this shape
     * and all its parents and grandparents.
     *
Thomas Zander's avatar
Thomas Zander committed
582 583 584
     * @param converter if not null, this method uses the converter to mark the right
     *        offsets in the current view.
     */
585
    QMatrix absoluteTransformation(const KoViewConverter *converter) const;
Thomas Zander's avatar
Thomas Zander committed
586

587 588 589 590
    /**
     * Applies a transformation to this shape.
     *
     * The transformation given is relative to the global coordinate system, i.e. the document.
591 592
     * This is a convenience function to apply a global transformation to this shape.
     * @see applyTransformation
593 594 595
     *
     * @param matrix the transformation matrix to apply
     */
596
    void applyAbsoluteTransformation(const QMatrix &matrix );
597 598 599 600 601 602 603

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

604
    /// Returns the shapes local transformation matrix
605 606 607 608 609 610 611 612 613 614
    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 );
615

Thomas Zander's avatar
Thomas Zander committed
616 617 618 619 620 621 622 623
    /**
     * 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
624 625 626 627 628 629 630 631 632
    /**
     * 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);

633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
    /**
     * @brief Transforms point from shape coordinates to document coordinates
     * @param point in shape coordinates
     * @return point in document coordinates
     */
    QPointF shapeToDocument( const QPointF &point ) const;

    /**
     * @brief Transforms rect from shape coordinates to document coordinates
     * @param rect in shape coordinates
     * @return rect in document coordinates
     */
    QRectF shapeToDocument( const QRectF &rect ) const;

    /**
     * @brief Transforms point from document coordinates to shape coordinates
     * @param point in document coordinates
     * @return point in shape coordinates
     */
    QPointF documentToShape( const QPointF &point ) const;

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

661 662 663 664
    /**
     * Returns the name of the shape.
     * @return the shapes name
     */
665
    QString name() const;
666 667 668 669 670 671 672

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

673 674 675 676 677
    /**
     * Update the position of the shape in the tree of the KoShapeManager.
     */
    void notifyChanged();

678 679 680 681 682 683 684 685 686
    /**
     * 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 {}
687

Thomas Zander's avatar
api dox  
Thomas Zander committed
688 689 690 691 692 693 694 695
    /**
     * 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!
     */
696
    void deleteLater();
697

698 699 700
    /// checks recursively if the shape or one of its parents is not visible or locked
    bool isEditable() const;

701 702 703 704 705 706 707 708 709
        /// 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 );

710 711 712
    /// Returns additional snap data the shape wants to have snapping to
    virtual KoSnapData snapData() const;

713 714 715 716 717 718 719 720 721
    /**
     * 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
     */
722
    void setAdditionalAttribute( const char * name, const QString & value );
723 724 725 726 727 728

    /**
     * Remove additional attribute
     *
     * @param name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
     */
729
    void removeAdditionalAttribute( const char * name );
730 731 732 733 734 735 736 737

    /**
     * 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
     */
738
    bool hasAdditionalAttribute( const char * name );
739 740 741 742 743 744 745 746

    /**
     * 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.
     */
747
    QString additionalAttribute( const char * name );
748

749
protected:
750 751

/* ** loading saving helper methods */
752 753
    /// attributes from ODF 1.1 chapter 9.2.15 Common Drawing Shape Attributes
    enum OdfAttribute {
754 755
        OdfTransformation = 1,       ///< Store transformation information
        OdfSize = 2,                 ///< Store size information
Thorsten Zachmann's avatar
Thorsten Zachmann committed
756
        OdfAdditionalAttributes = 4, ///< Store additional attributes of shape
757
        OdfMandatories = 8,          ///< Id, z-index, layer and style
Thorsten Zachmann's avatar
Thorsten Zachmann committed
758
        OdfCommonChildElements = 16, ///< event actions and connection points
759

760
        /// A mask for all the attributes
Thorsten Zachmann's avatar
Thorsten Zachmann committed
761
        OdfAllAttributes = OdfTransformation | OdfSize | OdfAdditionalAttributes | OdfMandatories | OdfCommonChildElements
762
    };
763

764 765 766 767 768 769 770 771
    /**
     * 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 );
772

Jan Hambrecht's avatar
 
Jan Hambrecht committed
773 774 775 776 777 778 779
    /**
     * Parses the transformation attribute from the given string
     * @param transform the transform attribute string
     * @return the resulting transformation matrix
     */
    QMatrix parseOdfTransform( const QString &transform );

780
    /**
781
     * @brief Saves the style used for the shape
782
     *
783 784
     * This method fills the given style object with the border and
     * background properties and then adds the style to the context.
785
     *
786
     * @param style the style object to fill
787 788 789
     * @param context used for saving
     * @return the name of the style
     * @see saveOdf
790
     */
791 792 793 794 795 796 797 798 799
    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 );
800

801 802 803
    /// Loads the fill style
    QBrush loadOdfFill( const KoXmlElement & element, KoShapeLoadingContext & context );

804 805 806
    /// Loads the stroke style
    KoShapeBorderModel * loadOdfStroke( const KoXmlElement & element, KoShapeLoadingContext & context );

807 808 809
    /// Loads the shadow style
    KoShapeShadow * loadOdfShadow( const KoXmlElement & element, KoShapeLoadingContext & context );

810 811 812 813 814
    /**
     * 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 );

815 816
/* ** end loading saving */

817

818 819 820 821 822 823 824
    /**
     * 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); }

825 826 827
    /// 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
828 829 830 831 832 833
    /**
     * 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
834
    void setCollisionDetection(bool detect);
Thomas Zander's avatar
Thomas Zander committed
835 836 837 838
    /**
     * get the property collision detection.
     * @returns true if collision detection is on.
     */
Thomas Zander's avatar
Thomas Zander committed
839
    bool collisionDetection();
Thomas Zander's avatar
Thomas Zander committed
840

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

Thomas Zander's avatar
Thomas Zander committed
844 845
private:
    friend class KoShapeManager;
Thomas Zander's avatar
Thomas Zander committed
846 847 848
    void addShapeManager( KoShapeManager * manager );
    void removeShapeManager( KoShapeManager * manager );

849 850 851
    class Private;
    friend class Private;
    Private * const d;
Thomas Zander's avatar
Thomas Zander committed
852 853
};

Thomas Zander's avatar
Thomas Zander committed
854
#endif