KoShape.h 25.7 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
#include <flake_export.h>
Thomas Zander's avatar
Thomas Zander committed
35

36 37
#include <KoXmlReaderForward.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;
Thomas Zander's avatar
Thomas Zander committed
52 53

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

Thomas Zander's avatar
Thomas Zander committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109
    /**
     * @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
110
     * something transparent on top.
Thomas Zander's avatar
Thomas Zander committed
111 112 113 114
     * 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.
115 116
     * 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
117 118 119 120
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
     * @see applyConversion()
     */
121
    virtual void paint(QPainter &painter, const KoViewConverter &converter) = 0;
Thomas Zander's avatar
Thomas Zander committed
122 123 124 125 126 127 128

    /**
     * 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
129 130
     * @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
131
     */
132
    virtual void paintDecorations(QPainter &painter, const KoViewConverter &converter, const KoCanvasBase *canvas);
Thomas Zander's avatar
Thomas Zander committed
133

134 135 136 137 138 139
    /**
     * Load a shape from odf
     *
     * @param context the KoShapeLoadingContext used for loading
     * @param element element which represents the shape in odf
     *
140 141
     * @return false if loading failed
     *
142 143
     * TODO make it pure virtual
     */
144
    virtual bool loadOdf( const KoXmlElement & element, KoShapeLoadingContext &context ) = 0;
145

146
    /**
147 148 149
     * @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
150
     * @see saveOdfAttributes
151
     */
152
    virtual void saveOdf( KoShapeSavingContext & context ) const = 0;
153 154

    /**
155 156 157
     * 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.
158
     */
159
    void saveOdfFrameAttributes( KoShapeSavingContext & context ) const;
160

Thomas Zander's avatar
Thomas Zander committed
161 162 163 164 165 166 167 168 169 170 171 172
    /**
     * @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
     */
    void scale( double sx, double sy );

    /**
     * Return the current scaling adjustment over the X axis.
     */
173
    KDE_DEPRECATED double scaleX() const;
Thomas Zander's avatar
Thomas Zander committed
174 175 176 177

    /**
     * Return the current scaling adjustment over the Y axis.
     */
178
    KDE_DEPRECATED double scaleY() const;
Thomas Zander's avatar
Thomas Zander committed
179 180 181 182 183 184 185 186 187 188 189 190

    /**
     * @brief Rotate the shape
     *
     * The shape will be rotated using the center of the shape using the size()
     *
     * @param angle set the rotation angle of the shape in degrees
     */
    void rotate( double angle );

    /**
     * Return the current rotation in degrees.
191
     * It returns NaN if the shape has a shearing or scaling transformation applied.
Thomas Zander's avatar
Thomas Zander committed
192
     */
193
    double rotation() const;
Thomas Zander's avatar
Thomas Zander committed
194 195 196 197 198 199 200 201 202 203 204

    /**
     * @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
     */
    void shear( double sx, double sy );

Thomas Zander's avatar
Thomas Zander committed
205 206 207 208
    /**
     * Return the current horizontal shearing angle for this shape.
     * @return the current horizontal shearing angle for this shape.
     */
209
    KDE_DEPRECATED double shearX() const;
Thomas Zander's avatar
Thomas Zander committed
210

Thomas Zander's avatar
Thomas Zander committed
211 212 213 214
    /**
     * Return the current vertical shearing angle for this shape.
     * @return the current vertical shearing angle for this shape.
     */
215
    KDE_DEPRECATED double shearY() const;
Thomas Zander's avatar
Thomas Zander committed
216

Thomas Zander's avatar
Thomas Zander committed
217 218 219
    /**
     * @brief Resize the shape
     *
220
     * @param size the new size of the shape.  This is different from scaling as
Jan Hambrecht's avatar
Jan Hambrecht committed
221
     * scaling is a so called secondary operation which is comparable to zooming in
Thomas Zander's avatar
Thomas Zander committed
222 223 224 225
     * 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.
     */
226
    virtual void resize( const QSizeF &size );
Thomas Zander's avatar
Thomas Zander committed
227 228 229 230

    /**
     * @brief Get the size of the shape in pt.
     *
Thorsten Zachmann's avatar
Thorsten Zachmann committed
231 232
     * The size is in shape coordinates.
     *
Thomas Zander's avatar
Thomas Zander committed
233 234
     * @return the size of the shape as set by resize()
     */
Thomas Zander's avatar
Thomas Zander committed
235
    virtual QSizeF size() const;
Thomas Zander's avatar
Thomas Zander committed
236 237 238 239 240 241 242 243 244 245 246 247 248

    /**
     * @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
249
    virtual QPointF position() const;
Thomas Zander's avatar
Thomas Zander committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264

    /**
     * @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
     */
265
    virtual QRectF boundingRect() const;
Thomas Zander's avatar
Thomas Zander committed
266 267 268 269 270 271 272 273 274 275 276

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

Thomas Zander's avatar
Thomas Zander committed
279 280 281 282 283 284
    /**
     * Return a list of the connectors that have been added to this shape.
     * Note that altering the list or the points in there will not have any
     * effect on the shape.
     * @return a list of the connectors that have been added to this shape.
     */
Thomas Zander's avatar
Thomas Zander committed
285
    QList<QPointF> connectors() const;
Thomas Zander's avatar
Thomas Zander committed
286

Thomas Zander's avatar
Thomas Zander committed
287 288
    /**
     * Set the background of the shape.
289
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
290
     * setting such a brush will allow the shape to fill itself using that brush and
291
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
292 293
     * @param brush the brush for the background.
     */
Thomas Zander's avatar
Thomas Zander committed
294
    void setBackground ( const QBrush & brush );
Thomas Zander's avatar
Thomas Zander committed
295 296 297

    /**
     * return the brush used to paint te background of this shape with.
298
     * A QBrush can have a plain color, be fully transparent or have a complex fill.
Thomas Zander's avatar
Thomas Zander committed
299
     * setting such a brush will allow the shape to fill itself using that brush and
300
     * will be able to tell if its transparent or not.
Thomas Zander's avatar
Thomas Zander committed
301 302
     * @return the background-brush
     */
303
    QBrush background() const;
Thomas Zander's avatar
Thomas Zander committed
304 305

    /**
306 307
     * 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
308
     * you should override it and always return true if your shape is not square.
309
     * @return if the shape is (partly) transparent.
Thomas Zander's avatar
Thomas Zander committed
310
     */
311
    virtual bool hasTransparency();
Thomas Zander's avatar
Thomas Zander committed
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

    /**
     * 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.
329
     * The layering if two overlapping objects have the same index is implementation dependent
Thomas Zander's avatar
Thomas Zander committed
330 331 332
     * 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
333
    void setZIndex(int zIndex);
Thomas Zander's avatar
Thomas Zander committed
334 335 336 337 338 339 340

    /**
     * Changes the Shape to be visible or invisible.
     * Being visible means being painted and printed, as well as being used for
     *   things like guidelines or searches.
     * @param on when true; set the shape to be visible.
     */
Thomas Zander's avatar
Thomas Zander committed
341
    void setVisible(bool on);
Thomas Zander's avatar
Thomas Zander committed
342 343 344 345 346 347
    /**
     * Returns current visibility state of this shape.
     * Being visible means being painted and printed, as well as being used for
     *   things like guidelines or searches.
     * @return current visibility state of this shape.
     */
Thomas Zander's avatar
Thomas Zander committed
348
    bool isVisible() const;
Thomas Zander's avatar
Thomas Zander committed
349

350 351 352
    /**
     * Makes it possible for the user to select this shape.
     * This parameter defaults to true.
Thomas Zander's avatar
Thomas Zander committed
353
     * @param selectable when true; set the shape to be selectable.
354
     */
Thomas Zander's avatar
Thomas Zander committed
355
    void setSelectable(bool selectable);
356 357 358 359
    /**
     * 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
360
    bool isSelectable() const;
361

Thomas Zander's avatar
Thomas Zander committed
362 363 364 365 366
    /**
     * 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
367
    void setLocked(bool locked);
Thomas Zander's avatar
Thomas Zander committed
368 369 370 371 372
    /**
     * 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
373
    bool isLocked() const;
Thomas Zander's avatar
Thomas Zander committed
374 375 376 377 378

    /**
     * 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
379
    KoShapeContainer *parent() const;
Thomas Zander's avatar
Thomas Zander committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404

    /**
     * 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.
     */
    virtual void repaint() const;

    /**
     * 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.
     */
405
    void repaint(const QRectF &shape) const;
Thomas Zander's avatar
Thomas Zander committed
406 407 408

    /**
     * This is a method used to sort a list using the STL sorting methods.
409 410
     * @param s1 the first shape
     * @param s2 the second shape
Thomas Zander's avatar
Thomas Zander committed
411
     */
412
    static bool compareShapeZIndex(KoShape *s1, KoShape *s2);
Thomas Zander's avatar
Thomas Zander committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426

    /**
     * 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.
     */
427
    KoShapeBorderModel *border() const;
Thomas Zander's avatar
Thomas Zander committed
428 429 430 431 432

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

435 436 437 438 439 440
    /**
     * Return the insets of the border.
     * Convenience method for KoShapeBorderModel::borderInsets()
     */
    KoInsets borderInsets() const;

Thomas Zander's avatar
Thomas Zander committed
441 442 443 444 445 446
    /**
     * 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
447
    void setKeepAspectRatio(bool keepAspect);
448

Thomas Zander's avatar
Thomas Zander committed
449 450 451 452 453 454
    /**
     * 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
455
    bool keepAspectRatio() const;
Thomas Zander's avatar
Thomas Zander committed
456 457 458 459

    /**
     * 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>
460
     * @param anchor The place on the (unaltered) shape that you want the position of.
Thomas Zander's avatar
Thomas Zander committed
461 462
     * @return the point that is the absolute, centered position of this shape.
     */
463
    QPointF absolutePosition(KoFlake::Position anchor = KoFlake::CenteredPositon) const;
464

Thomas Zander's avatar
Thomas Zander committed
465 466 467 468 469 470 471 472 473 474 475 476
    /**
     * 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
477
     * @param anchor The place on the (unaltered) shape that you set the position of.
Thomas Zander's avatar
Thomas Zander committed
478
     */
479
    void setAbsolutePosition(QPointF newPosition, KoFlake::Position anchor = KoFlake::CenteredPositon);
Thomas Zander's avatar
Thomas Zander committed
480

Thomas Zander's avatar
Thomas Zander committed
481 482 483 484 485 486
    /**
     * Move this shape from its current (absolute) position over a specified distance.
     * This takes the position of the shape, and moves it in the normal plain. This takes
     * into account the rotation of the object so distanceX really will be the resulting
     * horizontal distance.
     * @param distanceX the horizontal distance to move
Thomas Zander's avatar
Thomas Zander committed
487
     * @param distanceY the vertical distance to move
Thomas Zander's avatar
Thomas Zander committed
488 489
     */
    void moveBy(double distanceX, double distanceY);
Thomas Zander's avatar
Thomas Zander committed
490

491 492
    /**
     * Set a data object on the shape to be used by an application.
493
     * This is specifically useful when a shape is created in a plugin and that data from that
494 495 496 497 498 499 500 501 502
     * 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;

503 504 505 506 507 508 509 510 511 512 513 514
    /**
     * 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;

515
    /**
Marijn Kruisselbrink's avatar
Marijn Kruisselbrink committed
516
     * Return the Id of this shape, identifying the type of shape by the id of the factory.
517 518 519
     * @see KoShapeFactory::shapeId()
     * @return the id of the shape-type
     */
Thomas Zander's avatar
Thomas Zander committed
520
    const QString & shapeId() const;
521 522 523 524 525 526
    /**
     * 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
527
    void setShapeId(const QString &id);
528

Thomas Zander's avatar
Thomas Zander committed
529 530 531 532 533
    /**
     * Create a matrix that describes all the transformations done on this shape.
     * @param converter if not null, this method uses the converter to mark the right
     *        offsets in the current view.
     */
534
    QMatrix transformationMatrix(const KoViewConverter *converter) const;
Thomas Zander's avatar
Thomas Zander committed
535

536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
    /**
     * Applies a transformation to this shape.
     *
     * The transformation given is relative to the global coordinate system, i.e. the document.
     *
     * @param matrix the transformation matrix to apply
     */
    void applyTransformation(const QMatrix &matrix );

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

Thomas Zander's avatar
Thomas Zander committed
551 552 553 554 555 556 557 558
    /**
     * 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
559 560 561 562 563 564 565 566 567
    /**
     * 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
568 569 570
    /**
     * Return all the connections made to or from this shape.
     */
571 572
    QList<KoShapeConnection*> connections() const;

573 574 575 576
    /**
     * Returns the name of the shape.
     * @return the shapes name
     */
577
    QString name() const;
578 579 580 581 582 583 584

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

585 586 587 588 589
    /**
     * Update the position of the shape in the tree of the KoShapeManager.
     */
    void notifyChanged();

590 591 592 593 594 595 596 597 598
    /**
     * 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 {}
599

600
protected:
601 602

/* ** loading saving helper methods */
603 604 605 606 607 608 609
    /// 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
610
        /// A mask for all the attributes a 'draw:frame' requires
611 612
        FrameAttributes = OdfMandatories | OdfSize | OdfPosition | OdfTransformation
    };
613

614 615 616 617 618 619 620 621
    /**
     * 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 );
622

Jan Hambrecht's avatar
 
Jan Hambrecht committed
623 624 625 626 627 628 629
    /**
     * Parses the transformation attribute from the given string
     * @param transform the transform attribute string
     * @return the resulting transformation matrix
     */
    QMatrix parseOdfTransform( const QString &transform );

630
    /**
631 632
     * This method can be used while saving the shape as ODF to add the data
     * stored on this shape to the current element.
633
     *
634 635 636
     * @param context the context for the current save.
     * @param attributes a number of OdfAttribute items to state which attributes to save.
     * @see saveOdf
637
     */
638
    void saveOdfAttributes( KoShapeSavingContext &context, int attributes ) const;
639

640
    /**
641
     * Add a new draw-glue-point element for each connections() present on this shape.
642
     */
643
    void saveOdfConnections( KoShapeSavingContext &context ) const;
644

645
    /**
646
     * @brief Get the style used for the shape
647
     *
648
     * This method calls fillStyle and add then the style to the context
649
     *
650 651 652
     * @param context used for saving
     * @return the name of the style
     * @see saveOdf
653
     */
654
    QString style( KoShapeSavingContext &context ) const;
655

656 657 658
    /// Loads the fill style
    QBrush loadOdfFill( const KoXmlElement & element, KoShapeLoadingContext & context );

659 660 661
    /// Loads the stroke style
    KoShapeBorderModel * loadOdfStroke( const KoXmlElement & element, KoShapeLoadingContext & context );

662 663
/* ** end loading saving */

664

665 666 667 668 669 670 671
    /**
     * 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); }

Thomas Zander's avatar
Thomas Zander committed
672 673 674 675 676 677
    /**
     * 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
678
    void setCollisionDetection(bool detect);
Thomas Zander's avatar
Thomas Zander committed
679 680 681 682
    /**
     * get the property collision detection.
     * @returns true if collision detection is on.
     */
Thomas Zander's avatar
Thomas Zander committed
683
    bool collisionDetection();
Thomas Zander's avatar
Thomas Zander committed
684

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

688
    friend class KoShapeConnection;
Thomas Zander's avatar
Thomas Zander committed
689 690 691 692
    /**
     * Add a connection to the list of connections of this shape.
     * This is typically called only from the constructor of the KoShapeConnection class.
     */
693
    void addConnection(KoShapeConnection *connection);
Thomas Zander's avatar
Thomas Zander committed
694 695 696 697
    /**
     * Remove a connection to the list of connections of this shape.
     * This is typically called only from the destructor of the KoShapeConnection class.
     */
698 699
    void removeConnection(KoShapeConnection *connection);

Thomas Zander's avatar
Thomas Zander committed
700 701
private:
    friend class KoShapeManager;
Thomas Zander's avatar
Thomas Zander committed
702 703 704
    void addShapeManager( KoShapeManager * manager );
    void removeShapeManager( KoShapeManager * manager );

705 706 707
    class Private;
    friend class Private;
    Private * const d;
Thomas Zander's avatar
Thomas Zander committed
708 709
};

Thomas Zander's avatar
Thomas Zander committed
710
#endif