Kross::Api::List Class Reference

#include <list.h>

Inheritance diagram for Kross::Api::List:

[legend]Collaboration diagram for Kross::Api::List:

[legend]List of all members.

---

Detailed Description

The List class implementates Value to handle lists and collections.

Definition at line 36 of file list.h.

Public Types
typedef KSharedPtr< List >	Ptr
Public Member Functions
	List (QValueList< Object::Ptr > value=QValueList< Object::Ptr >(), const QString &name="list")
virtual	~List ()
virtual const QString	getClassName () const
virtual const QString	toString ()
Object::Ptr	item (uint idx)
uint	count ()
void	append (Object::Ptr object)
V &	getValue ()
const QString &	getName () const
Object::Ptr	getParent () const
bool	hasChild (const QString &name) const
Object::Ptr	getChild (const QString &name) const
QMap< QString, Object::Ptr >	getChildren () const
bool	addChild (Object::Ptr object, const QString &name=QString::null)
void	removeChild (const QString &name)
void	removeAllChildren ()
virtual Object::Ptr	call (const QString &name, KSharedPtr< List > arguments)
virtual QStringList	getCalls ()
Static Public Member Functions
template<class T>
static T *	fromObject (Object::Ptr object)
Friends
class	Value< List, QValueList< Object::Ptr > >

---

Member Typedef Documentation

typedef KSharedPtr<List> Kross::Api::List::Ptr

Shared pointer to implement reference-counting. Reimplemented from Kross::Api::Object. Definition at line 44 of file list.h.

---

Constructor & Destructor Documentation

List::List (  QValueList< Object::Ptr >  value = QValueList< Object::Ptr >(), const QString &  name = "list" )

Constructor. Parameters: value  The list of Object instances this list has initialy. name  A name this list has. Definition at line 27 of file list.cpp. : Value< List, QValueList<Object::Ptr> >(value, name) { }

List::~List (   )  [virtual]

Destructor. Definition at line 32 of file list.cpp. { }

---

Member Function Documentation

bool Object::addChild (  Object::Ptr  object, const QString &  name = QString::null )  [inherited]

Add a new child. Replaces a possible already existing child with such a name. Parameters: name  the name of the child object  The Object to add. Returns: true if the Object was added successfully else false. Definition at line 79 of file object.cpp. References QString::arg(), QString::isEmpty(), QString::isNull(), and QMap::replace(). Referenced by Kross::Api::MainModule::addKAction(), Kross::Api::MainModule::addQObject(), Kross::Api::MainModule::addSignal(), Kross::Api::MainModule::addSlot(), Kross::Api::QtObject::QtObject(), and TestPluginModule::TestPluginModule(). { QString n = name.isNull() ? object->getName() : name; #ifdef KROSS_API_OBJECT_ADDCHILD_DEBUG kdDebug() << QString("Kross::Api::Object::addChild() object.name='%2' object.classname='%3'") .arg(n).arg(object->getClassName()) << endl; #endif if(n.isEmpty()) // prevent invalid items. return false; //throw Exception::Ptr( new Exception( QString("Failed to add child object to object '%1'. Invalid name for class '%2'.").arg(getName()).arg(object->getClassName()) ) ); object->m_parent = this; m_children.replace(n, object); return true; }

void List::append (  Object::Ptr  object  )

Append an Kross::Api::Object to the list. Parameters: object  The Kross::Api::Object instance to append to this list. Definition at line 65 of file list.cpp. References Kross::Api::Value< T, V >::getValue(). Referenced by Kross::Api::ListT< OBJECT, TYPE >::ListT(). { getValue().append(object); }

virtual Object::Ptr Kross::Api::Object::call (  const QString &  name, KSharedPtr< List >  arguments )  [virtual, inherited]

Pass a call to the object and evaluated it recursive down the object-hierachy. Objects like Class are able to handle call's by just implementing this function. If the call is done the called() method will be executed recursive from bottom up the call hierachy. Exceptions: TypeException  if the object or the name is not callable. Parameters: name  Each call has a name that says what should be called. In the case of a Class the name is the functionname. arguments  The list of arguments passed to the call. Returns: The call-result as Object::Ptr instance or NULL if the call has no result. Reimplemented in Kross::Api::EventScript, Kross::Api::EventSignal, and Kross::Api::EventSlot. Referenced by Kross::Api::Callable::call(), and Kross::Api::Callable::callChild().

uint List::count (   )

Return the number of items in the QValueList this list holds. Returns: The number of items. Definition at line 60 of file list.cpp. References Kross::Api::Value< T, V >::getValue(). { return getValue().count(); }

template<class T> static T* Kross::Api::Object::fromObject (  Object::Ptr  object  )  [inline, static, inherited]

Try to convert the Object instance to the template class T. Exceptions: TypeException  if the cast failed. Parameters: object  The Object to cast. Returns: The to a instance from template type T casted Object. Definition at line 198 of file object.h. { T* t = (T*) object.data(); if(! t) throw KSharedPtr<Exception>( new Exception(QString("Object \"%1\" invalid.").arg(object ? object->getClassName() : "")) ); return t; }

virtual QStringList Kross::Api::Object::getCalls (   )  [inline, virtual, inherited]

Return a list of supported callable objects. Returns: List of supported calls. Reimplemented in Kross::Python::PythonObject. Definition at line 186 of file object.h. { return QStringList(); }

Object::Ptr Object::getChild (  const QString &  name  )  const [inherited]

Return the defined child or NULL if there is no such object with that name avaible. Parameters: name  The name of the Object to return. Returns: The Object matching to the defined name or NULL if there is no such Object. Definition at line 69 of file object.cpp. Referenced by Kross::Api::Callable::getChild(). { return m_children[name]; }

QMap< QString, Object::Ptr > Object::getChildren (   )  const [inherited]

Return all children. Returns: A ObjectMap of children this Object has. Definition at line 74 of file object.cpp. Referenced by Kross::Api::Callable::getChildrenDict(), and Kross::Api::Callable::getChildrenList(). { return m_children; }

const QString List::getClassName (   )  const [virtual]

See See also: Kross::Api::Object::getClassName() Implements Kross::Api::Object. Definition at line 36 of file list.cpp. { return "Kross::Api::List"; }

const QString & Object::getName (   )  const [inherited]

Return the name this object has. Returns: Name of this object. Reimplemented in Kross::Api::ScriptContainer. Definition at line 49 of file object.cpp. Referenced by Kross::Api::Event< QtObject >::call(), Kross::Api::Callable::call(), Kross::Api::Callable::getChild(), and Kross::Api::Module::~Module(). { return m_name; }

Object::Ptr Object::getParent (   )  const [inherited]

Return the parent object or NULL if this object doesn't has a parent. Returns: The parent-Object or NULL if this Object doesn't has a parent. Definition at line 59 of file object.cpp. { return m_parent; }

template<class T, class V> V& Kross::Api::Value< T, V >::getValue (   )  [inline, inherited]

Return the value. Returns: The value this Value-class holds. Definition at line 66 of file value.h. Referenced by append(), count(), item(), Kross::Api::Variant::operator bool(), Kross::Api::Variant::operator const char *(), Kross::Api::Variant::operator const QCString(), Kross::Api::Variant::operator const QCString &(), Kross::Api::Variant::operator const QString(), Kross::Api::Variant::operator const QString &(), Kross::Api::Variant::operator const QVariant &(), Kross::Api::Variant::operator double(), Kross::Api::Variant::operator int(), Kross::Api::Variant::operator QCString(), Kross::Api::Variant::operator QString(), Kross::Api::Variant::operator uint(), Kross::Api::Variant::toList(), Kross::Api::Variant::toString(), toString(), Kross::Api::Dict::toString(), and Kross::Api::Variant::toVariant(). { return m_value; }

bool Object::hasChild (  const QString &  name  )  const [inherited]

Returns if the defined child is avaible. Returns: true if child exists else false. Reimplemented in Kross::Api::MainModule. Definition at line 64 of file object.cpp. References QMap::contains(). Referenced by Kross::Api::MainModule::hasChild(), and Kross::Api::Callable::hasChild(). { return m_children.contains(name); }

Object::Ptr List::item (  uint  idx  )

Return the Object with defined index from the QValueList this list holds. Exceptions: TypeException  If index is out of bounds. Parameters: idx  The QValueList-index. Returns: The Object instance. Definition at line 50 of file list.cpp. References QValueList::count(), and Kross::Api::Value< T, V >::getValue(). { QValueList<Object::Ptr>& list = getValue(); if(idx >= list.count()) { kdDebug() << "List::item index=" << idx << " is out of bounds. Raising TypeException." << endl; throw Exception::Ptr( new Exception(QString("List-index %1 out of bounds.").arg(idx)) ); } return list[idx]; }

void Object::removeAllChildren (   )  [inherited]

Remove all children. Definition at line 104 of file object.cpp. References QMap::clear(). { #ifdef KROSS_API_OBJECT_REMCHILD_DEBUG kdDebug() << "Kross::Api::Object::removeAllChildren()" << endl; #endif m_children.clear(); }

void Object::removeChild (  const QString &  name  )  [inherited]

Remove an existing child. Parameters: name  The name of the Object to remove. If there doesn't exists an Object with such name just nothing will be done. Definition at line 96 of file object.cpp. References QMap::remove(). { #ifdef KROSS_API_OBJECT_REMCHILD_DEBUG kdDebug() << QString("Kross::Api::Object::removeChild() name='%1'").arg(name) << endl; #endif m_children.remove(name); }

const QString List::toString (   )  [virtual]

Returns: a string representation of the whole list. See also: Kross::Api::Object::toString() Reimplemented from Kross::Api::Object. Definition at line 41 of file list.cpp. References QValueList::begin(), QValueList::end(), QString::endsWith(), Kross::Api::Value< T, V >::getValue(), QString::left(), and QString::length(). { QString s = "["; QValueList<Object::Ptr> list = getValue(); for(QValueList<Object::Ptr>::Iterator it = list.begin(); it != list.end(); ++it) s += "'" + (*it)->toString() + "', "; return (s.endsWith(", ") ? s.left(s.length() - 2) : s) + "]"; }

---

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

• list.h
• list.cpp

---