Kig Python Scripting API Documentation

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

This Object represents an invalid object. More...

Inheritance diagram for InvalidObject:
Inheritance graph
[legend]
Collaboration diagram for InvalidObject:
Collaboration graph
[legend]

Public Member Functions

 InvalidObject ()
 Construct a new InvalidObject.
 
InvalidObjectcopy () const
 Returns a copy of this Object. More...
 
const ObjectTypetype () const
 Returns the lowermost ObjectType that this object is an instantiation of. More...
 
bool equals (const Object &rhs) const
 Returns true if this Object is equal to rhs. More...
 
- Public Member Functions inherited from BogusObject
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. More...
 
Objecttransform (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. More...
 
bool valid () const
 Returns true if this is a valid Object. More...
 

Static Public Member Functions

static const ObjectTypestype ()
 Returns the ObjectType representing the InvalidObject type.
 
- Static Public Member Functions inherited from BogusObject
static const ObjectTypestype ()
 Returns the ObjectType representing the BogusObject type.
 
- Static Public Member Functions inherited from Object
static const ObjectTypestype ()
 The ObjectType representing the base Object class. More...
 

Detailed Description

This Object represents an invalid object.

If a calculation fails, then often an InvalidObject is returned, indicating that the generated object is invalid.

Member Function Documentation

◆ copy()

InvalidObject* InvalidObject::copy ( ) const
virtual

Returns a copy of this Object.

The copy is an exact copy. Changes to the copy don't affect the original.

Implements Object.

◆ equals()

bool InvalidObject::equals ( const Object rhs) const
virtual

Returns true if this Object is equal to rhs.

This function checks whether rhs is of the same Object type, and whether it contains the same data as this Object.

Implements Object.

◆ type()

const ObjectType* InvalidObject::type ( ) const
virtual

Returns the lowermost ObjectType that this object is an instantiation of.

E.g. if you want to get a string containing the internal name of the type of an object, you can do:

tn = object.type().internalName()

Implements Object.

KDE Logo
This file is part of the documentation for tdelibs .
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed May 15 2024 03:39:42 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2001