KoShape.h 23.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 38

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

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

/**
55
 *
56
 * Base class for all flake shapes. Shapes extend this class
Thomas Zander's avatar
Thomas Zander committed
57 58 59
 * 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.
60
 *
61
 * Due to the limited responsibility of this class, the extending object
Thomas Zander's avatar
Thomas Zander committed
62
 * can have any data backend and is responsible for painting itself.
63
 *
64
 * We strongly suggest that any extending class will use a Model View
Thomas Zander's avatar
Thomas Zander committed
65
 * Controller (MVC) design where the View part is all in this class, as well
66
 * as the one that inherits from this one.  This allows the data that rests
Thomas Zander's avatar
Thomas Zander committed
67
 * in the model to be reused in different parts of the document. For example
68
 * by having two flake objects that show that same data. Or each showing a section of it.
69
 *
70 71 72 73 74
 * 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()
75
 *
76
 * <p>Flake objects can be created in three ways:
77 78 79 80 81
 * <ul>
 *   <li>a simple new KoDerivedFlake(),
 *   <li>through an associated tool,
 *   <li>through a factory
 * </ul>
Thomas Zander's avatar
Thomas Zander committed
82
 */
83
class FLAKE_EXPORT KoShape
Thomas Zander's avatar
Thomas Zander committed
84 85
{
public:
86 87 88 89 90 91 92 93 94 95 96
    /// 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
97 98 99 100 101 102 103 104 105 106 107 108 109 110
    /**
     * @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
111
     * something transparent on top.
Thomas Zander's avatar
Thomas Zander committed
112 113 114 115
     * 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.
116 117
     * 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
118 119 120 121
     * @param painter used for painting the shape
     * @param converter to convert between internal and view coordinates.
     * @see applyConversion()
     */
122
    virtual void paint(QPainter &painter, const KoViewConverter &converter) = 0;
Thomas Zander's avatar
Thomas Zander committed
123 124 125 126 127 128 129

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

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
    /**
     * @brief Save the shape
     *
     * This is the method that will be called when saving a shape as a described in 
     * OpenDocument 9.2 Drawing Shapes. This method saves the common attributes of the
     * drawing shapes.
     * The special data for every shape is saved in @see saveOdfData().
     *
     * Please don't use yet as the design is not yet finished.
     *
     * @see saveOdfContent
     */
    bool saveOdf( KoShapeSavingContext & context );

    /**
     * @brief Save the shape
     *
     * This is used to save a shape that is not used as a Drawing Shape, e.g.
     * a text shape that is used as main part of the document as described in
     * OpenDocument 2.3.1 Text Documents.
     *
     * Please don't use yet as the design is not yet finished.
     */
    virtual bool saveOdfContext( KoShapeSavingContext & context ) { Q_UNUSED( context ); return true; }

Thomas Zander's avatar
Thomas Zander committed
160 161 162 163 164 165 166 167 168 169 170 171
    /**
     * @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.
     */
Thomas Zander's avatar
Thomas Zander committed
172
    double scaleX() const;
Thomas Zander's avatar
Thomas Zander committed
173 174 175 176

    /**
     * Return the current scaling adjustment over the Y axis.
     */
Thomas Zander's avatar
Thomas Zander committed
177
    double scaleY() const;
Thomas Zander's avatar
Thomas Zander committed
178 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.
     */
Thomas Zander's avatar
Thomas Zander committed
191
    double rotation() const;
Thomas Zander's avatar
Thomas Zander committed
192 193 194 195 196 197 198 199 200 201 202

    /**
     * @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
203 204 205 206
    /**
     * Return the current horizontal shearing angle for this shape.
     * @return the current horizontal shearing angle for this shape.
     */
Thomas Zander's avatar
Thomas Zander committed
207
    double shearX() const;
Thomas Zander's avatar
Thomas Zander committed
208

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

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

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

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

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

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

Thomas Zander's avatar
Thomas Zander committed
277 278 279 280 281 282
    /**
     * 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
283
    QList<QPointF> connectors() const;
Thomas Zander's avatar
Thomas Zander committed
284

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

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

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

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

    /**
     * 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
339
    void setVisible(bool on);
Thomas Zander's avatar
Thomas Zander committed
340 341 342 343 344 345
    /**
     * 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
346
    bool isVisible() const;
Thomas Zander's avatar
Thomas Zander committed
347

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

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

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

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

    /**
     * This is a method used to sort a list using the STL sorting methods.
407 408
     * @param s1 the first shape
     * @param s2 the second shape
Thomas Zander's avatar
Thomas Zander committed
409
     */
410
    static bool compareShapeZIndex(KoShape *s1, KoShape *s2);
Thomas Zander's avatar
Thomas Zander committed
411 412 413 414

    /**
     * Called internally whenever a property is changed that requires the matrix to be recalculated.
     */
415
    void recalcMatrix();
Thomas Zander's avatar
Thomas Zander committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429

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

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

438 439 440 441 442 443
    /**
     * Return the insets of the border.
     * Convenience method for KoShapeBorderModel::borderInsets()
     */
    KoInsets borderInsets() const;

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

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

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

Thomas Zander's avatar
Thomas Zander committed
468 469 470 471 472 473 474 475 476 477 478 479 480
    /**
     * 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.
     */
481
    void setAbsolutePosition(QPointF newPosition, KoFlake::Position anchor = KoFlake::CenteredPositon);
Thomas Zander's avatar
Thomas Zander committed
482

Thomas Zander's avatar
Thomas Zander committed
483 484 485 486 487 488
    /**
     * 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
489
     * @param distanceY the vertical distance to move
Thomas Zander's avatar
Thomas Zander committed
490 491
     */
    void moveBy(double distanceX, double distanceY);
Thomas Zander's avatar
Thomas Zander committed
492

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

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

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

Thomas Zander's avatar
Thomas Zander committed
531 532 533 534 535
    /**
     * 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.
     */
536
    QMatrix transformationMatrix(const KoViewConverter *converter) const;
Thomas Zander's avatar
Thomas Zander committed
537

Thomas Zander's avatar
Thomas Zander committed
538 539 540 541 542 543 544 545
    /**
     * 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
546 547 548 549 550 551 552 553 554
    /**
     * 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
555 556 557
    /**
     * Return all the connections made to or from this shape.
     */
558 559
    QList<KoShapeConnection*> connections() const;

560 561 562 563 564 565 566 567 568 569 570 571
    /**
     * Returns the name of the shape.
     * @return the shapes name
     */
    const QString & name() const;

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

572
protected:
573 574 575 576 577 578 579 580 581 582 583 584
    /**
     * @brief Get the tag name used for saving
     *
     * Get the name of the tag used for saving drawing shape
     *
     * This will be a pure virtual function once all shapes implemented it.
     *
     * @return the name of the tag
     *
     * @see saveOdf()
     */
    virtual const char * odfTagName() const { return ""; }
585

586 587 588 589 590 591 592 593 594 595 596
    /**
     * @brief Save the data that is special by each shape
     *
     * This will be a pure virtual function once all shapes implemented it.
     *
     * @return true if successful, false otherwise
     *
     * @see saveOdf()
     */
    virtual bool saveOdfData( KoShapeSavingContext &context ) const { Q_UNUSED( context ); return true; }

597 598 599 600 601 602 603 604 605
    /**
     * @brief Save the size and the position of a shape 
     *
     * This also takes the transformation into account. Use in shapes which have
     * Size, Position and transformation as defined in ODF 9.2.15 Common Drawing 
     * Shape Attributes.
     */
    void saveOdfSizeAndPosition( KoShapeSavingContext &context ) const;

606 607 608 609 610 611 612 613 614 615
    /**
     * @brief Fill the style object
     *
     * @param style object
     * @param context used for saving
     *
     * @see saveOdf()
     */
    void fillStyle( KoGenStyle &style, KoShapeSavingContext &context ); 

616 617 618
    /**
     * Update the position of the shape in the tree of the KoShapeManager.
     */
Thomas Zander's avatar
Thomas Zander committed
619
    void notifyChanged();
620

621 622 623 624 625 626 627
    /**
     * 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
628 629 630 631 632 633
    /**
     * 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
634
    void setCollisionDetection(bool detect);
Thomas Zander's avatar
Thomas Zander committed
635 636 637 638
    /**
     * get the property collision detection.
     * @returns true if collision detection is on.
     */
Thomas Zander's avatar
Thomas Zander committed
639
    bool collisionDetection();
Thomas Zander's avatar
Thomas Zander committed
640

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

644
    friend class KoShapeConnection;
Thomas Zander's avatar
Thomas Zander committed
645 646 647 648
    /**
     * Add a connection to the list of connections of this shape.
     * This is typically called only from the constructor of the KoShapeConnection class.
     */
649
    void addConnection(KoShapeConnection *connection);
Thomas Zander's avatar
Thomas Zander committed
650 651 652 653
    /**
     * Remove a connection to the list of connections of this shape.
     * This is typically called only from the destructor of the KoShapeConnection class.
     */
654 655
    void removeConnection(KoShapeConnection *connection);

Thomas Zander's avatar
Thomas Zander committed
656
private:
657 658 659 660 661 662 663 664 665 666
    /**
     * @brief Get the style used for the shape
     *
     * This method calls fillStyle and add then the style to the context
     *
     * @param context used for saving
     * @return the name of the style
     */
    QString getStyle( KoShapeSavingContext &context );

Thomas Zander's avatar
Thomas Zander committed
667
    friend class KoShapeManager;
Thomas Zander's avatar
Thomas Zander committed
668 669 670
    void addShapeManager( KoShapeManager * manager );
    void removeShapeManager( KoShapeManager * manager );

671 672 673
    class Private;
    friend class Private;
    Private * const d;
Thomas Zander's avatar
Thomas Zander committed
674 675
};

Thomas Zander's avatar
Thomas Zander committed
676
#endif