BogusObject Class Reference (Kig Python Scripting API)

| # Kig Python Scripting API Documentation
Overview | Class Hierarchy | Classes | Classes (annotated) | Members

Public Member Functions | Static Public Member Functions | List of all members
BogusObject Class Reference

This is the base class for the so-called BogusObject's. More...

`#include <bogus_imp.h>`

Inheritance diagram for BogusObject:
[legend]
Collaboration diagram for BogusObject:
[legend]

## Public Member Functions
Coordinate | attachPoint () const
| Returns a reference point where to attach labels; when this returns an invalidCoord then the attachment is either not done at all, or done in a specific way (like for curves, or for points) The treatment of points could also take advantage of this attachment mechanism.
Object * | transform (const Transformation &) const
| Return this Object, transformed by the transformation t.
Public Member Functions inherited from Object
bool | inherits (const ObjectType *t) const
| Returns true if this Object inherits the Object type represented by t.
bool | valid () const
| Returns true if this is a valid Object.
virtual const ObjectType * | type () const =0
| Returns the lowermost ObjectType that this object is an instantiation of.
virtual Object * | copy () const =0
| Returns a copy of this Object.
virtual bool | equals (const Object &rhs) const =0
| Returns true if this Object is equal to rhs.

## Static Public Member Functions
static const ObjectType * | stype ()
| Returns the ObjectType representing the BogusObject type.
Static Public Member Functions inherited from Object
static const ObjectType * | stype ()
| The ObjectType representing the base Object class.

## Detailed Description

This is the base class for the so-called BogusObject's.

These Object's are not really Object's, in that they don't represent objects. They exist because Object's also serve another purpose, namely containing data. They can all be loaded and saved, and the only difference between these objects and normal objects are that these serve only to be loaded and saved. This approach adds a lot of flexibility to the Kig system, and has certainly proven itself very valuable.

## Member Function Documentation

## ◆ attachPoint()

Coordinate BogusObject::attachPoint | ( |  | ) | const
| virtual

Returns a reference point where to attach labels; when this returns an invalidCoord then the attachment is either not done at all, or done in a specific way (like for curves, or for points) The treatment of points could also take advantage of this attachment mechanism.

If this method returns a valid Coordinate, then this is interpreted as a pivot point for the label, which can still be moved relative to that point, but follows the object when the object changes. In practice a new RelativePointType is created (position of the string), this type in turn depends on the object (to get its attachPoint) and two DoubleObject that are interpreted as relative displacement (x and y)

Implements Object.

This file is part of the documentation for tdelibs .
Documentation copyright © 1996-2002 the KDE developers.
Generated on by doxygen 1.16.1 written by Dimitri van Heesch, © 1997-2001