karbon

VLayer Class Reference

#include <vlayer.h>

Inheritance diagram for VLayer:

VGroup VObject List of all members.

Detailed Description

VLayer manages a set of vobjects.

It keeps the objects from bottom to top in a list, ie. objects higher in the list are drawn above lower objects. Objects in a layer can be manipulated and worked on independant of objects in other layers.

Definition at line 36 of file vlayer.h.


Public Member Functions

 VLayer (VObject *parent, VState state=normal)
 VLayer (const VLayer &layer)
virtual ~VLayer ()
virtual DCOPObject * dcopObject ()
virtual void draw (VPainter *painter, const KoRect *rect=0L) const
virtual void save (QDomElement &element) const
virtual void saveOasis (KoStore *store, KoXmlWriter *docWriter, KoGenStyles &mainStyles, int &index) const
virtual void load (const QDomElement &element)
virtual VLayerclone () const
virtual void accept (VVisitor &visitor)
void bringToFront (const VObject &object)
void upwards (const VObject &object)
void downwards (const VObject &object)
void sendToBack (const VObject &object)
void setSelected (bool state)
bool selected ()

Constructor & Destructor Documentation

VLayer::VLayer ( VObject parent,
VState  state = normal 
)

Constructs a new layer object that is child of parent and has the given state.

Parameters:
parent the new object's parent
state the new object's state

Definition at line 38 of file vlayer.cc.

VLayer::VLayer ( const VLayer layer  ) 

Copy constructor.

Parameters:
layer the layer to copy properties from

Definition at line 49 of file vlayer.cc.


Member Function Documentation

void VLayer::accept ( VVisitor visitor  )  [virtual]

Accept a VVisitor.

Reimplemented from VGroup.

Definition at line 182 of file vlayer.cc.

void VLayer::bringToFront ( const VObject object  ) 

Moves the object to the top of the list.

When the object is at the top this method has no effect.

Parameters:
object the object to move

Definition at line 84 of file vlayer.cc.

VLayer * VLayer::clone (  )  const [virtual]

Create an exact copy of this object.

Returns:
the exact object copy

Reimplemented from VGroup.

Definition at line 176 of file vlayer.cc.

DCOPObject * VLayer::dcopObject (  )  [virtual]

Returns pointer to internal DCOP object.

If no internal DCOP object exist yet, it is created.

Reimplemented from VObject.

Definition at line 58 of file vlayer.cc.

void VLayer::downwards ( const VObject object  ) 

Moves the object one step down the list.

When the object is at the bottom this method has no effect.

Parameters:
object the object to move

Definition at line 110 of file vlayer.cc.

void VLayer::draw ( VPainter painter,
const KoRect *  rect = 0L 
) const [virtual]

Draw the object to a painting device.

Parameters:
painter abstraction that is used to render to a painting device.
rect represents the visible rectangular area. If this object doesn't intersect with this area it is not drawn.

Reimplemented from VGroup.

Definition at line 67 of file vlayer.cc.

void VLayer::load ( const QDomElement &  element  )  [virtual]

Load this object's state from xml and initialize this object accordingly.

Parameters:
element the DOM element from which the attributes are read

Reimplemented from VGroup.

Definition at line 168 of file vlayer.cc.

void VLayer::save ( QDomElement &  element  )  const [virtual]

Save this object's state to xml.

Parameters:
element the DOM element to which the attributes are saved

Reimplemented from VGroup.

Definition at line 134 of file vlayer.cc.

void VLayer::saveOasis ( KoStore *  store,
KoXmlWriter *  docWriter,
KoGenStyles &  mainStyles,
int &  index 
) const [virtual]

Save this object's state to OpenDocument.

Parameters:
store FIXME
docWriter FIXME
mainStyles FIXME

Reimplemented from VGroup.

Definition at line 154 of file vlayer.cc.

bool VLayer::selected (  )  [inline]

Returns the selection state of the layer.

Returns:
the actual selection state

Definition at line 115 of file vlayer.h.

void VLayer::sendToBack ( const VObject object  ) 

Moves the object to the end of the list.

When the object is at the bottom this method has no effect.

Parameters:
object the object to move

Definition at line 124 of file vlayer.cc.

void VLayer::setSelected ( bool  state  )  [inline]

Selects or unselects the layer.

Parameters:
state the new selection state

Definition at line 108 of file vlayer.h.

void VLayer::upwards ( const VObject object  ) 

Moves the object one step up the list.

When the object is at the top this method has no effect.

Parameters:
object the object to move

Definition at line 94 of file vlayer.cc.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys