libs/flake

KoShape Class Reference

Base class for all flake shapes. More...

#include <KoShape.h>

Inheritance diagram for KoShape:
Inheritance graph
[legend]

List of all members.

Public Types

enum  ChangeType {
  PositionChanged, RotationChanged, ScaleChanged, ShearChanged,
  SizeChanged, GenericMatrixChange, ParentChanged, CollisionDetected,
  Deleted, BorderChanged, BackgroundChanged, ShadowChanged,
  ParameterChanged, ContentChanged, ChildChanged
}

Public Member Functions

 KoShape ()
virtual ~KoShape ()
QPointF absolutePosition (KoFlake::Position anchor=KoFlake::CenteredPosition) const
QMatrix absoluteTransformation (const KoViewConverter *converter) const
void addConnectionPoint (const QPointF &point)
bool addDependee (KoShape *shape)
void addEventAction (KoEventAction *action)
QString additionalAttribute (const char *name) const
KoShapeApplicationData * applicationData () const
void applyAbsoluteTransformation (const QMatrix &matrix)
void applyTransformation (const QMatrix &matrix)
KoShapeBackground * background () const
KoShapeBorderModel * border () const
KoInsets borderInsets () const
virtual QRectF boundingRect () const
QList< QPointF > connectionPoints () const
virtual void copySettings (const KoShape *shape)
void deleteLater ()
QRectF documentToShape (const QRectF &rect) const
QPointF documentToShape (const QPointF &point) const
QList< KoEventAction * > eventActions () const
KoFilterEffectStack * filterEffectStack () const
bool hasAdditionalAttribute (const char *name) const
bool hasDependee (KoShape *shape) const
virtual bool hasTransparency ()
virtual bool hitTest (const QPointF &position) const
virtual void init (const QMap< QString, KoDataCenter * > &dataCenterMap)
bool isContentProtected () const
bool isEditable () const
bool isGeometryProtected () const
bool isPrintable () const
bool isSelectable () const
bool isVisible (bool recursive=false) const
bool keepAspectRatio () const
virtual bool loadOdf (const KoXmlElement &element, KoShapeLoadingContext &context)=0
QString name () const
void notifyChanged ()
virtual QPainterPath outline () const
virtual void paint (QPainter &painter, const KoViewConverter &converter)=0
virtual void paintDecorations (QPainter &painter, const KoViewConverter &converter, const KoCanvasBase *canvas)
KoShapeContainer * parent () const
QPointF position () const
void removeAdditionalAttribute (const char *name)
void removeAdditionalStyleAttribute (const char *name)
void removeConnectionPoint (int index)
void removeDependee (KoShape *shape)
void removeEventAction (KoEventAction *action)
void rotate (qreal angle)
qreal rotation () const
virtual void saveOdf (KoShapeSavingContext &context) const =0
void saveOdfAttributes (KoShapeSavingContext &context, int attributes) const
void saveOdfCommonChildElements (KoShapeSavingContext &context) const
void setAbsolutePosition (QPointF newPosition, KoFlake::Position anchor=KoFlake::CenteredPosition)
void setAdditionalAttribute (const char *name, const QString &value)
void setAdditionalStyleAttribute (const char *name, const QString &value)
void setApplicationData (KoShapeApplicationData *applicationData)
void setBackground (KoShapeBackground *background)
void setBorder (KoShapeBorderModel *border)
void setContentProtected (bool protect)
void setFilterEffectStack (KoFilterEffectStack *filterEffectStack)
void setGeometryProtected (bool on)
void setKeepAspectRatio (bool keepAspect)
void setName (const QString &name)
void setParent (KoShapeContainer *parent)
virtual void setPosition (const QPointF &position)
void setPrintable (bool on)
void setScale (qreal sx, qreal sy)
void setSelectable (bool selectable)
void setShadow (KoShapeShadow *shadow)
void setShapeId (const QString &id)
void setShear (qreal sx, qreal sy)
virtual void setSize (const QSizeF &size)
void setTransformation (const QMatrix &matrix)
void setUserData (KoShapeUserData *userData)
void setVisible (bool on)
void setZIndex (int zIndex)
KoShapeShadow * shadow () const
QString shapeId () const
QRectF shapeToDocument (const QRectF &rect) const
QPointF shapeToDocument (const QPointF &point) const
virtual QSizeF size () const
virtual KoSnapData snapData () const
QMatrix transformation () const
virtual void update (const QRectF &shape) const
virtual void update () const
KoShapeUserData * userData () const
virtual void waitUntilReady (const KoViewConverter &converter, bool asynchronous=true) const
int zIndex () const

Static Public Member Functions

static void applyConversion (QPainter &painter, const KoViewConverter &converter)
static bool compareShapeZIndex (KoShape *s1, KoShape *s2)

Protected Types

enum  OdfAttribute {
  OdfTransformation = 1, OdfSize = 2, OdfPosition = 8, OdfAdditionalAttributes = 4,
  OdfCommonChildElements = 16, OdfLayer = 64, OdfStyle = 128, OdfId = 256,
  OdfName = 512, OdfZIndex = 1024, OdfViewbox = 2048, OdfMandatories = OdfLayer | OdfStyle | OdfId | OdfName | OdfZIndex,
  OdfGeometry = OdfPosition | OdfSize, OdfAllAttributes = OdfTransformation | OdfGeometry | OdfAdditionalAttributes | OdfMandatories | OdfCommonChildElements
}

Protected Member Functions

 KoShape (KoShapePrivate &)
bool collisionDetection ()
QString getStyleProperty (const char *property, const KoXmlElement &element, KoShapeLoadingContext &context)
bool loadOdfAttributes (const KoXmlElement &element, KoShapeLoadingContext &context, int attributes)
KoShapeBackground * loadOdfFill (const KoXmlElement &element, KoShapeLoadingContext &context)
KoShapeShadow * loadOdfShadow (const KoXmlElement &element, KoShapeLoadingContext &context)
KoShapeBorderModel * loadOdfStroke (const KoXmlElement &element, KoShapeLoadingContext &context)
virtual void loadStyle (const KoXmlElement &element, KoShapeLoadingContext &context)
QMatrix matrix () const
QMatrix parseOdfTransform (const QString &transform)
virtual QString saveStyle (KoGenStyle &style, KoShapeSavingContext &context) const
void setCollisionDetection (bool detect)
virtual void shapeChanged (ChangeType type, KoShape *shape=0)

Protected Attributes

KoShapePrivate * d_ptr

Detailed Description

Base class for all flake shapes.

Shapes extend this class 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.

Due to the limited responsibility of this class, the extending object can have any data backend and is responsible for painting itself.

We strongly suggest that any extending class will use a Model View Controller (MVC) design where the View part is all in this class, as well as the one that inherits from this one. This allows the data that rests in the model to be reused in different parts of the document. For example by having two flake objects that show that same data. Or each showing a section of it.

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.

flake_shape_coords.png


The Rotation center can be returned with absolutePosition()

Flake objects can be created in three ways:

  • a simple new KoDerivedFlake(),
  • through an associated tool,
  • through a factory

Shape interaction notifications

We had several notification methods that allow your shape to be notified of changes in other shapes positions or rotation etc.

  1. The most general is KoShape::shapeChanged().
    a virtual method that you can use to check various changed to your shape made by tools or otherwise.
  2. for shape hierarchies the parent may receive a notification when a child was modified. This is done though KoShapeContainerModel::childChanged()
  3. 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 other 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.

Definition at line 106 of file KoShape.h.

Member Enumeration Documentation

enum KoShape::ChangeType

Used by shapeChanged() to select which change was made.

Enumerator:
PositionChanged 

used after a setPosition()

RotationChanged 

used after a setRotation()

ScaleChanged 

used after a setScale()

ShearChanged 

used after a setShear()

SizeChanged 

used after a setSize()

GenericMatrixChange 

used after the matrix was changed without knowing which property explicitly changed

ParentChanged 

used after a setParent()

CollisionDetected 

used when another shape moved in our boundingrect

Deleted 

the shape was deleted

BorderChanged 

the shapes border has changed

BackgroundChanged 

the shapes background has changed

ShadowChanged 

the shapes shadow has changed

ParameterChanged 

the shapes parameter has changed (KoParameterShape only)

ContentChanged 

the content of the shape changed e.g. a new image inside a pixmap/text change inside a textshape

ChildChanged 

a child of a container was changed/removed. This is propagated to all parents

Definition at line 110 of file KoShape.h.

enum KoShape::OdfAttribute [protected]

attributes from ODF 1.1 chapter 9.2.15 Common Drawing Shape Attributes

Enumerator:
OdfTransformation 

Store transformation information.

OdfSize 

Store size information.

OdfPosition 

Store position.

OdfAdditionalAttributes 

Store additional attributes of the shape.

OdfCommonChildElements 

Event actions and connection points.

OdfLayer 

Store layer name.

OdfStyle 

Store the style.

OdfId 

Store the unique ID.

OdfName 

Store the name of the shape.

OdfZIndex 

This only loads the z-index; when saving, it is reflected by the order of the shapes.

OdfViewbox 

Store the viewbox.

OdfMandatories 

A mask for all mandatory attributes.

OdfGeometry 

A mask for geometry attributes.

OdfAllAttributes 

A mask for all the attributes.

Definition at line 824 of file KoShape.h.

Constructor & Destructor Documentation

KoShape::KoShape (  ) 

Constructor.

Definition at line 148 of file KoShape.cpp.

KoShape::~KoShape (  )  [virtual]

Destructor.

Definition at line 159 of file KoShape.cpp.

KoShape::KoShape ( KoShapePrivate &  dd  )  [protected]

constructor

Definition at line 154 of file KoShape.cpp.

Member Function Documentation

QPointF KoShape::absolutePosition ( KoFlake::Position  anchor = KoFlake::CenteredPosition  )  const

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.


Parameters:
anchor The place on the (unaltered) shape that you want the position of.
Returns:
the point that is the absolute, centered position of this shape.

Definition at line 469 of file KoShape.cpp.

QMatrix KoShape::absoluteTransformation ( const KoViewConverter *  converter  )  const

Create a matrix that describes all the transformations done on this shape.

The absolute transformation is the combined transformation of this shape and all its parents and grandparents.

Parameters:
converter if not null, this method uses the converter to mark the right offsets in the current view.

Definition at line 325 of file KoShape.cpp.

void KoShape::addConnectionPoint ( const QPointF &  point  ) 

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.

Parameters:
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.

Definition at line 602 of file KoShape.cpp.

bool KoShape::addDependee ( KoShape *  shape  ) 

Adds a shape which depends on this shape.

If this shape already depends on the given shape, establishing the dependency is refused to prevent circular dependencies.

Parameters:
shape the shape which depends on this shape
Returns:
true if dependency could be established, else false

Definition at line 1359 of file KoShape.cpp.

void KoShape::addEventAction ( KoEventAction *  action  ) 

Add a event action.

Definition at line 622 of file KoShape.cpp.

QString KoShape::additionalAttribute ( const char *  name  )  const

Get additional attribute.

Parameters:
name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
Returns:
The value of the attribute if it exists or a null string if not found.

Definition at line 1418 of file KoShape.cpp.

KoShapeApplicationData * KoShape::applicationData (  )  const

Return the current applicationData.

Definition at line 543 of file KoShape.cpp.

void KoShape::applyAbsoluteTransformation ( const QMatrix &  matrix  ) 

Applies a transformation to this shape.

The transformation given is relative to the global coordinate system, i.e. the document. This is a convenience function to apply a global transformation to this shape.

See also:
applyTransformation
Parameters:
matrix the transformation matrix to apply

Definition at line 352 of file KoShape.cpp.

void KoShape::applyConversion ( QPainter &  painter,
const KoViewConverter &  converter 
) [static]

Convenience method that allows people implementing paint() to use the shape internal coordinate system directly to paint itself instead of considering the views zoom.

Parameters:
painter the painter to alter the zoom level of.
converter the converter for the current views zoom.

Definition at line 1332 of file KoShape.cpp.

void KoShape::applyTransformation ( const QMatrix &  matrix  ) 

Applies a transformation to this shape.

The transformation given is relative to the shape coordinate system.

Parameters:
matrix the transformation matrix to apply

Definition at line 362 of file KoShape.cpp.

KoShapeBackground * KoShape::background (  )  const

return the brush used to paint te background of this shape with.

A QBrush can have a plain color, be fully transparent or have a complex fill. setting such a brush will allow the shape to fill itself using that brush and will be able to tell if its transparent or not.

Returns:
the background-brush

Definition at line 656 of file KoShape.cpp.

KoShapeBorderModel * KoShape::border (  )  const

Returns the currently set border, or 0 if there is no border.

Returns:
the currently set border, or 0 if there is no border.

Definition at line 797 of file KoShape.cpp.

KoInsets KoShape::borderInsets (  )  const

Return the insets of the border.

Convenience method for KoShapeBorderModel::borderInsets()

Definition at line 558 of file KoShape.cpp.

QRectF KoShape::boundingRect (  )  const [virtual]

Get the bounding box of the shape.

This includes the line width but not the shadow of the shape

Returns:
the bounding box of the shape

Reimplemented in KoPathShape, KoSelection, and KoShapeLayer.

Definition at line 300 of file KoShape.cpp.

bool KoShape::collisionDetection (  )  [protected]

get the property collision detection.

Returns:
true if collision detection is on.

Definition at line 779 of file KoShape.cpp.

bool KoShape::compareShapeZIndex ( KoShape *  s1,
KoShape *  s2 
) [static]

This is a method used to sort a list using the STL sorting methods.

Parameters:
s1 the first shape
s2 the second shape

Definition at line 384 of file KoShape.cpp.

QList< QPointF > KoShape::connectionPoints (  )  const

Return a list of the connection points that have been added to this shape.

All the points are relative to the shape position, see absolutePosition().

Returns:
a list of the connectors that have been added to this shape.

Definition at line 610 of file KoShape.cpp.

void KoShape::copySettings ( const KoShape *  shape  )  [virtual]

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.

Parameters:
shape the shape to use as original

Definition at line 494 of file KoShape.cpp.

void KoShape::deleteLater (  ) 

Schedule the shape for thread-safe deletion.

After calling this method will self-delete in the main threads event loop. If your code deletes a shape and your code can possibly be running in a separate thread, you should use this method to delete the shape. The reason for this is that If you delete a shape from another thread then it is possible the main 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 once.

Definition at line 868 of file KoShape.cpp.

QRectF KoShape::documentToShape ( const QRectF &  rect  )  const

Transform rect from document coordinates to shape coordinates.

Parameters:
rect in document coordinates
Returns:
rect in shape coordinates

Definition at line 1354 of file KoShape.cpp.

QPointF KoShape::documentToShape ( const QPointF &  point  )  const

Transforms point from document coordinates to shape coordinates.

Parameters:
point in document coordinates
Returns:
point in shape coordinates

Definition at line 1349 of file KoShape.cpp.

QList< KoEventAction * > KoShape::eventActions (  )  const

Get all event actions.

Definition at line 638 of file KoShape.cpp.

KoFilterEffectStack * KoShape::filterEffectStack (  )  const

Returns the filter effect stack of the shape.

Returns:
the list of filter effects applied on the shape when rendering.

Definition at line 1436 of file KoShape.cpp.

QString KoShape::getStyleProperty ( const char *  property,
const KoXmlElement &  element,
KoShapeLoadingContext &  context 
) [protected]

Fills the style stack and returns the value of the given style property (e.g fill, stroke).

Definition at line 1057 of file KoShape.cpp.

bool KoShape::hasAdditionalAttribute ( const char *  name  )  const

Check if additional attribute is set.

Parameters:
name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
Returns:
true if there is a attribute with prefix:tag set, false otherwise

Definition at line 1412 of file KoShape.cpp.

bool KoShape::hasDependee ( KoShape *  shape  )  const

Returns if the given shape is dependent on this shape.

Definition at line 1383 of file KoShape.cpp.

bool KoShape::hasTransparency (  )  [virtual]

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, you should override it and always return true if your shape is not square.

Returns:
if the shape is (partly) transparent.

Definition at line 549 of file KoShape.cpp.

bool KoShape::hitTest ( const QPointF &  position  )  const [virtual]

Check if the shape is hit on position.

Parameters:
position the position where the user clicked.
Returns:
true when it hits.

Reimplemented in KoConnectionShape, KoPathShape, KoSelection, KoShapeGroup, and KoShapeLayer.

Definition at line 273 of file KoShape.cpp.

void KoShape::init ( const QMap< QString, KoDataCenter * > &  dataCenterMap  )  [virtual]

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.

Definition at line 1325 of file KoShape.cpp.

bool KoShape::isContentProtected (  )  const

Returns current content protection state of this shape.

Content protection is a hint for tools to disallow the user editing the content.

Returns:
current content protection state of this shape.
See also:
isGeometryProtected(), isSelectable(), isVisible()

Definition at line 737 of file KoShape.cpp.

bool KoShape::isEditable (  )  const

checks recursively if the shape or one of its parents is not visible or locked

Definition at line 877 of file KoShape.cpp.

bool KoShape::isGeometryProtected (  )  const

Returns current geometry protection state of this shape.

The geometry being protected means the user can not change shape or position of the shape. This includes any matrix operation such as rotation.

Returns:
current geometry protection state of this shape.
See also:
isContentProtected(), isSelectable(), isVisible()

Definition at line 725 of file KoShape.cpp.

bool KoShape::isPrintable (  )  const

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.

Returns:
current printable state of this shape.

Definition at line 698 of file KoShape.cpp.

bool KoShape::isSelectable (  )  const

Returns if this shape can be selected by the user.

Returns:
true only when the object is selectable.
See also:
isGeometryProtected(), isContentProtected(), isVisible()

Definition at line 713 of file KoShape.cpp.

bool KoShape::isVisible ( bool  recursive = false  )  const

Returns current visibility state of this shape.

Being visible means being painted, as well as being used for things like guidelines or searches.

Parameters:
recursive when true, checks visibility recursively
Returns:
current visibility state of this shape.
See also:
isGeometryProtected(), isContentProtected(), isSelectable()

Definition at line 675 of file KoShape.cpp.

bool KoShape::keepAspectRatio (  )  const

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.

Returns:
whether to keep aspect ratio of this shape

Definition at line 755 of file KoShape.cpp.

virtual bool KoShape::loadOdf ( const KoXmlElement &  element,
KoShapeLoadingContext &  context 
) [pure virtual]

Load a shape from odf.

Parameters:
context the KoShapeLoadingContext used for loading
element element which represents the shape in odf
Returns:
false if loading failed

Implemented in KoConnectionShape, KoPathShape, KoShapeGroup, and KoShapeLayer.

bool KoShape::loadOdfAttributes ( const KoXmlElement &  element,
KoShapeLoadingContext &  context,
int  attributes 
) [protected]

This method is used during loading of the shape to load common attributes.

Parameters:
context the KoShapeLoadingContext used for loading
element element which represents the shape in odf
attributes a number of OdfAttribute items to state which attributes to load.

Definition at line 971 of file KoShape.cpp.

KoShapeBackground * KoShape::loadOdfFill ( const KoXmlElement &  element,
KoShapeLoadingContext &  context 
) [protected]

Loads the fill style.

Definition at line 1070 of file KoShape.cpp.

KoShapeShadow * KoShape::loadOdfShadow ( const KoXmlElement &  element,
KoShapeLoadingContext &  context 
) [protected]

Loads the shadow style.

Definition at line 1124 of file KoShape.cpp.

KoShapeBorderModel * KoShape::loadOdfStroke ( const KoXmlElement &  element,
KoShapeLoadingContext &  context 
) [protected]

Loads the stroke style.

Definition at line 1092 of file KoShape.cpp.

void KoShape::loadStyle ( const KoXmlElement &  element,
KoShapeLoadingContext &  context 
) [protected, virtual]

Loads the stroke and fill style from the given element.

Parameters:
element the xml element to load the style from
context the loading context used for loading

Definition at line 936 of file KoShape.cpp.

QMatrix KoShape::matrix (  )  const [protected]

return the current matrix that contains the rotation/scale/position of this shape

Definition at line 837 of file KoShape.cpp.

QString KoShape::name (  )  const

Returns the name of the shape.

Returns:
the shapes name

Definition at line 850 of file KoShape.cpp.

void KoShape::notifyChanged (  ) 

Update the position of the shape in the tree of the KoShapeManager.

Definition at line 515 of file KoShape.cpp.

QPainterPath KoShape::outline (  )  const [virtual]

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.

Reimplemented in KoPathShape.

Definition at line 461 of file KoShape.cpp.

virtual void KoShape::paint ( QPainter &  painter,
const KoViewConverter &  converter 
) [pure virtual]

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 something transparent on top. This can be done with a method like: painter.fillRect(converter.normalToView(QRectF(QPointF(0.0,0.0), size())), background()); Or equavalent for non-square objects. Do note that a shape's top-left is always at coordinate 0,0. Even if the shape itself is rotated or translated.

Parameters:
painter used for painting the shape
converter to convert between internal and view coordinates.
See also:
applyConversion()

Implemented in KoConnectionShape, KoPathShape, KoSelection, and KoShapeContainer.

void KoShape::paintDecorations ( QPainter &  painter,
const KoViewConverter &  converter,
const KoCanvasBase *  canvas 
) [virtual]

Paint non-print decorations specific for this type of shape.

The default implementation is empty.

Parameters:
painter used for painting the shape
converter to convert between internal and view coordinates.
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.

Definition at line 166 of file KoShape.cpp.

KoShapeContainer * KoShape::parent (  )  const

Returns the parent, or 0 if there is no parent.

Returns:
the parent, or 0 if there is no parent.

Definition at line 743 of file KoShape.cpp.

QMatrix KoShape::parseOdfTransform ( const QString &  transform  )  [protected]

Parses the transformation attribute from the given string.

Parameters:
transform the transform attribute string
Returns:
the resulting transformation matrix

Definition at line 1146 of file KoShape.cpp.

QPointF KoShape::position (  )  const

Get the position of the shape in pt.

Returns:
the position of the shape

Definition at line 594 of file KoShape.cpp.

void KoShape::removeAdditionalAttribute ( const char *  name  ) 

Remove additional attribute.

Parameters:
name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder

Definition at line 1406 of file KoShape.cpp.

void KoShape::removeAdditionalStyleAttribute ( const char *  name  ) 

Definition at line 1430 of file KoShape.cpp.

void KoShape::removeConnectionPoint ( int  index  ) 

Removes connection point with given index.

Definition at line 843 of file KoShape.cpp.

void KoShape::removeDependee ( KoShape *  shape  ) 

Removes as shape depending on this shape.

Definition at line 1375 of file KoShape.cpp.

void KoShape::removeEventAction ( KoEventAction *  action  ) 

Remove a event action.

Definition at line 630 of file KoShape.cpp.

void KoShape::rotate ( qreal  angle  ) 

Rotate the shape (relative).

The shape will be rotated from the current rotation using the center of the shape using the size()

Parameters:
angle change the angle of rotation increasing it with 'angle' degrees

Definition at line 202 of file KoShape.cpp.

qreal KoShape::rotation (  )  const

Return the current rotation in degrees.

It returns NaN if the shape has a shearing or scaling transformation applied.

Definition at line 567 of file KoShape.cpp.

virtual void KoShape::saveOdf ( KoShapeSavingContext &  context  )  const [pure virtual]

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.

See also:
saveOdfAttributes

Implemented in KoConnectionShape, KoPathShape, KoShapeGroup, and KoShapeLayer.

void KoShape::saveOdfAttributes ( KoShapeSavingContext &  context,
int  attributes 
) const

This method can be used while saving the shape as ODF to add the data stored on this shape to the current element.

Parameters:
context the context for the current save.
attributes a number of OdfAttribute items to state which attributes to save.
See also:
saveOdf

Definition at line 1224 of file KoShape.cpp.

void KoShape::saveOdfCommonChildElements ( KoShapeSavingContext &  context  )  const

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.

Definition at line 1308 of file KoShape.cpp.

QString KoShape::saveStyle ( KoGenStyle &  style,
KoShapeSavingContext &  context 
) const [protected, virtual]

Saves the style used for the shape.

This method fills the given style object with the border and background properties and then adds the style to the context.

Parameters:
style the style object to fill
context used for saving
Returns:
the name of the style
See also:
saveOdf

Definition at line 890 of file KoShape.cpp.

void KoShape::setAbsolutePosition ( QPointF  newPosition,
KoFlake::Position  anchor = KoFlake::CenteredPosition 
)

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.


The newPosition is going to be the center of the shape. This has the convenient effect that: 

    shape->setAbsolutePosition(QPointF(0,0));
    shape->rotate(45);

Will result in the same visual position of the shape as the opposite:

    shape->rotate(45);
    shape->setAbsolutePosition(QPointF(0,0));
Parameters:
newPosition the new absolute center of the shape.
anchor The place on the (unaltered) shape that you set the position of.

Definition at line 482 of file KoShape.cpp.

void KoShape::setAdditionalAttribute ( const char *  name,
const QString &  value 
)

Set additional attribute.

This can be used to attach additional attributes to a shape for attributes that are application specific like presentation:placeholder

Parameters:
name The name of the attribute in the following form prefix:tag e.g. presentation:placeholder
value The value of the attribute

Definition at line 1400 of file KoShape.cpp.

void KoShape::setAdditionalStyleAttribute ( const char *  name,
const QString &  value 
)

Definition at line 1424 of file KoShape.cpp.

void KoShape::setApplicationData ( KoShapeApplicationData *  applicationData  ) 

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.

Parameters:
applicationData the new application data, or 0 to delete the current one.

Definition at line 536 of file KoShape.cpp.

void KoShape::setBackground ( KoShapeBackground *  background  ) 

Set the background of the shape.

A shape background can be a plain color, a gradient, a pattern, be fully transparent or have a complex fill. Setting such a background will allow the shape to be filled and will be able to tell if it is transparent or not.

Parameters:
background the new shape background.

Definition at line 644 of file KoShape.cpp.

void KoShape::setBorder ( KoShapeBorderModel *  border  ) 

Set a new border, removing the old one.

Parameters:
border the new border, or 0 if there should be no border.

Definition at line 803 of file KoShape.cpp.

void KoShape::setCollisionDetection ( bool  detect  )  [protected]

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.

Parameters:
detect if true detect collisions.

Definition at line 773 of file KoShape.cpp.

void KoShape::setContentProtected ( bool  protect  ) 

Marks the shape to have its content protected against editing.

Content protection is a hint for tools to disallow the user editing the content.

Parameters:
protect when true set the shapes content to be protected from user modification.
See also:
setGeometryProtected(), setSelectable(), setVisible()

Definition at line 731 of file KoShape.cpp.

void KoShape::setFilterEffectStack ( KoFilterEffectStack *  filterEffectStack  ) 

Sets the new filter effect stack, removing the old one.

Definition at line 1442 of file KoShape.cpp.

void KoShape::setGeometryProtected ( bool  on  ) 

Tells the shape to have its position/rotation and size protected from user-changes.

The geometry being protected means the user can not change shape or position of the shape. This includes any matrix operation such as rotation.

Parameters:
on when true; set the shape to have its geometry protected.
See also:
setContentProtected(), setSelectable(), setVisible()

Definition at line 719 of file KoShape.cpp.

void KoShape::setKeepAspectRatio ( bool  keepAspect  ) 

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.

Parameters:
keepAspect the new value

Definition at line 749 of file KoShape.cpp.

void KoShape::setName ( const QString &  name  ) 

Sets the name of the shape.

Parameters:
name the new shape name

Definition at line 856 of file KoShape.cpp.

void KoShape::setParent ( KoShapeContainer *  parent  ) 

Set the parent of this shape.

Parameters:
parent the new parent of this shape. Can be 0 if the shape has no parent anymore.

Definition at line 417 of file KoShape.cpp.

void KoShape::setPosition ( const QPointF &  position  )  [virtual]

Set the position of the shape in pt.

Parameters:
position the new position of the shape

Definition at line 259 of file KoShape.cpp.

void KoShape::setPrintable ( bool  on  ) 

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 also:
isVisible), it isPrinted will return false, too.

Definition at line 692 of file KoShape.cpp.

void KoShape::setScale ( qreal  sx,
qreal  sy 
)

Scale the shape using the zero-point which is the top-left corner.

See also:
position()
Parameters:
sx scale in x direction
sy scale in y direction

Definition at line 188 of file KoShape.cpp.

void KoShape::setSelectable ( bool  selectable  ) 

Makes it possible for the user to select this shape.

This parameter defaults to true.

Parameters:
selectable when true; set the shape to be selectable by the user.
See also:
setGeometryProtected(), setContentProtected(), setVisible()

Definition at line 707 of file KoShape.cpp.

void KoShape::setShadow ( KoShapeShadow *  shadow  ) 

Sets the new shadow, removing the old one.

Definition at line 817 of file KoShape.cpp.

void KoShape::setShapeId ( const QString &  id  ) 

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 also:
KoShapeFactory::shapeId()
Parameters:
id the ID from the factory that created this shape

Definition at line 767 of file KoShape.cpp.

void KoShape::setShear ( qreal  sx,
qreal  sy 
)

Shear the shape The shape will be sheared using the zero-point which is the top-left corner.

See also:
position()
Parameters:
sx shear in x direction
sy shear in y direction

Definition at line 216 of file KoShape.cpp.

void KoShape::setSize ( const QSizeF &  size  )  [virtual]

Resize the shape.

Parameters:
size the new size of the shape. This is different from scaling as scaling is a so called secondary operation which is comparable to zooming in 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.

Reimplemented in KoParameterShape, and KoPathShape.

Definition at line 230 of file KoShape.cpp.

void KoShape::setTransformation ( const QMatrix &  matrix  ) 

Sets a new transformation matrix describing the local transformations on this shape.

Parameters:
matrix the new transformation matrix

Definition at line 370 of file KoShape.cpp.

void KoShape::setUserData ( KoShapeUserData *  userData  ) 

Set a data object on the shape to be used by an application.

This is specifically useful when a shape is created in a plugin and that data from that shape should be accessible outside the plugin.

Parameters:
userData the new user data, or 0 to delete the current one.

Definition at line 523 of file KoShape.cpp.

void KoShape::setVisible ( bool  on  ) 

Changes the Shape to be visible or invisible.

Being visible means being painted, as well as being used for things like guidelines or searches.

Parameters:
on when true; set the shape to be visible.
See also:
setGeometryProtected(), setContentProtected(), setSelectable()

Definition at line 669 of file KoShape.cpp.

void KoShape::setZIndex ( int  zIndex  ) 

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.

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. The layering if two overlapping objects have the same index is implementation dependent and probably depends on the order in which they are added to the shape manager.

Parameters:
zIndex the new z-index;

Definition at line 662 of file KoShape.cpp.

KoShapeShadow * KoShape::shadow (  )  const

Returns the currently set shadow or 0 if there is now shadow set.

Definition at line 831 of file KoShape.cpp.

void KoShape::shapeChanged ( ChangeType  type,
KoShape *  shape = 0 
) [protected, virtual]

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.

Parameters:
type an indicator which type was changed.

Definition at line 1389 of file KoShape.cpp.

QString KoShape::shapeId (  )  const

Return the Id of this shape, identifying the type of shape by the id of the factory.

See also:
KoShapeFactory::shapeId()
Returns:
the id of the shape-type

Definition at line 761 of file KoShape.cpp.

QRectF KoShape::shapeToDocument ( const QRectF &  rect  )  const

Transforms rect from shape coordinates to document coordinates.

Parameters:
rect in shape coordinates
Returns:
rect in document coordinates

Definition at line 1344 of file KoShape.cpp.

QPointF KoShape::shapeToDocument ( const QPointF &  point  )  const

Transforms point from shape coordinates to document coordinates.

Parameters:
point in shape coordinates
Returns:
point in document coordinates

Definition at line 1339 of file KoShape.cpp.

QSizeF KoShape::size (  )  const [virtual]

Get the size of the shape in pt.

The size is in shape coordinates.

Returns:
the size of the shape as set by resize()

Reimplemented in KoPathShape.

Definition at line 588 of file KoShape.cpp.

KoSnapData KoShape::snapData (  )  const [virtual]

Returns additional snap data the shape wants to have snapping to.

Definition at line 1395 of file KoShape.cpp.

QMatrix KoShape::transformation (  )  const

Returns the shapes local transformation matrix.

Definition at line 378 of file KoShape.cpp.

void KoShape::update ( const QRectF &  shape  )  const [virtual]

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.

This method will return immediately and only request a repaint. Successive calls will be merged into an appropriate repaint action.

Parameters:
shape the rectangle (in pt) to queue for repaint.

Definition at line 450 of file KoShape.cpp.

void KoShape::update (  )  const [virtual]

Request a repaint to be queued.

The repaint will be of the entire Shape, including its selection handles should this shape be selected.

This method will return immediately and only request a repaint. Successive calls will be merged into an appropriate repaint action.

Reimplemented in KoShapeContainer.

Definition at line 440 of file KoShape.cpp.

KoShapeUserData * KoShape::userData (  )  const

Return the current userData.

Definition at line 530 of file KoShape.cpp.

void KoShape::waitUntilReady ( const KoViewConverter &  converter,
bool  asynchronous = true 
) const [virtual]

A shape can be in a state that it is doing processing data like loading or text layout.

In this case it can be shown on screen probably partially but it should really not be printed until it is fully done processing. Warning! This method can be blocking for a long time

Parameters:
asynchronous If set to true the processing will can take place in a different thread and the function will not block until the shape is finised. In case of printing Flake will call this method from a non-main thread and only start printing it when the in case of printing method returned. If set to false the processing needs to be done synchronously and will block until the result is finished.

Definition at line 862 of file KoShape.cpp.

int KoShape::zIndex (  )  const

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.

Returns:
the z-index of this shape.
See also:
setZIndex()

Definition at line 434 of file KoShape.cpp.

Member Data Documentation

KoShapePrivate* KoShape::d_ptr [protected]

Definition at line 924 of file KoShape.h.

The documentation for this class was generated from the following files: