Search for usage in LXR

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
QObjectobject (const QString &name) const
Options objectOption (const QString &name) const
QHash< QString, OptionsobjectOptions () 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

Additional options that could be defined for a QObject instance.


No additional options. This is the default.


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 

Add a QObject to the list of children.

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

Definition at line 114 of file childreninterface.h.

◆ hasObject()

bool Kross::ChildrenInterface::hasObject ( const QString name) const
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
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
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
the map of options.

Definition at line 158 of file childreninterface.h.

◆ objects()

QHash< QString, QObject * > Kross::ChildrenInterface::objects ( ) const
the map of QObject instances.

Definition at line 142 of file childreninterface.h.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Fri Sep 22 2023 04:09:59 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.