Kross::ChildrenInterface Class Reference

#include <childreninterface.h>

Inheritance diagram for Kross::ChildrenInterface:

Public Types
enum	Options { NoOption = 0x00, AutoConnectSignals = 0x01, LastOption = 0x1000000 }

Public Member Functions
void	addObject (QObject *object, const QString &name=QString(), Options options=NoOption)
bool	hasObject (const QString &name) const
QObject *	object (const QString &name) const
Options	objectOption (const QString &name) const
QHash< QString, Options >	objectOptions () const
QHash< QString, QObject * >	objects () const

Detailed Description

Interface for managing Object collections.

The Manager as well as the Action class inherit this interface to allow to attach QObject to a global or a local context related instances that should be published to the scripting code.

Definition at line 55 of file childreninterface.h.

Member Enumeration Documentation

Options

enum Kross::ChildrenInterface::Options

Additional options that could be defined for a QObject instance.

Enumerator
NoOption	No additional options. This is the default.
AutoConnectSignals	auto connect signals with scripting functions.

Definition at line 79 of file childreninterface.h.

Member Function Documentation

addObject()

void Kross::ChildrenInterface::addObject ( QObject *  object, const QString &  name = QString(), Options  options = NoOption  )

inline

Add a QObject to the list of children.

Parameters

object	The QObject instance that should be added to the list of children.
name	The name the QObject should be known under. If not defined, the QObject's objectName is used.
options	Additional optional options for the QObject.

Definition at line 114 of file childreninterface.h.

hasObject()

bool Kross::ChildrenInterface::hasObject ( const QString &  name ) const

inline

Returns

true if there exist a QObject with the name else false is returned.

Definition at line 126 of file childreninterface.h.

object()

QObject* Kross::ChildrenInterface::object ( const QString &  name ) const

inline

Returns

the QObject with name or NULL if there exist no such object.

Definition at line 134 of file childreninterface.h.

objectOption()

Options Kross::ChildrenInterface::objectOption ( const QString &  name ) const

inline

Returns

true if the QObject with name was added with autoConnect enabled.

Definition at line 150 of file childreninterface.h.

objectOptions()

QHash< QString, Options > Kross::ChildrenInterface::objectOptions ( ) const

inline

Returns

the map of options.

Definition at line 158 of file childreninterface.h.

objects()

QHash< QString, QObject * > Kross::ChildrenInterface::objects ( ) const

inline

Returns

the map of QObject instances.

Definition at line 142 of file childreninterface.h.

---

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

• childreninterface.h