• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Kross

Kross::ChildrenInterface

Kross::ChildrenInterface Class Reference

Interface for managing Object collections. More...

#include <childreninterface.h>

Inheritance diagram for Kross::ChildrenInterface:

Inheritance graph
[legend]

List of all members.


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 38 of file childreninterface.h.


Member Enumeration Documentation

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.
LastOption 

Definition at line 45 of file childreninterface.h.


Member Function Documentation

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 80 of file childreninterface.h.

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 90 of file childreninterface.h.

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 97 of file childreninterface.h.

Options Kross::ChildrenInterface::objectOption ( const QString &  name  )  const [inline]

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

Definition at line 111 of file childreninterface.h.

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

Returns:
the map of options.

Definition at line 118 of file childreninterface.h.

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

Returns:
the map of QObject instances.

Definition at line 104 of file childreninterface.h.


The documentation for this class was generated from the following file:
  • childreninterface.h

Kross

Skip menu "Kross"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal