Kross::Api::Argument

Kross::Api::Argument Class Reference

#include <argument.h>

Collaboration diagram for Kross::Api::Argument:

Collaboration graph
[legend]
List of all members.

Detailed Description

Each Class::Function holds a list of arguments the function supports. The Argument-class represents such a single argument in a ArgumentList collection.

Definition at line 38 of file argument.h.

Public Member Functions

 Argument (const QString &classname=QString::null)
 ~Argument ()
const QString & getClassName ()
ArgumentList & operator<< (ArgumentList &arglist)

Constructor & Destructor Documentation

Argument::Argument (  const QString &  classname = QString::null  )  [explicit]
 

Constructor.

Parameters:
classname The name of the class this argument expects.
object The optional default Object this class holds.
visible defines if the Argument is visible to scripting-languages. If the argument is hidden, it's somewhat 'const' and cant be changed by scripting code. In that case the argument won't be even visible by scripting languages.

Definition at line 24 of file argument.cpp.

00025     : m_classname(classname)
00026     //, m_object(object)
00027     //, m_visible(visible)
00028 {
00029 }

Argument::~Argument (   ) 
 

Destructor.

Definition at line 31 of file argument.cpp.

00032 {
00033 }

Member Function Documentation

const QString & Argument::getClassName (   ) 
 

Return the name of the class this argument expects.

Returns:
Name of the class this argument expects.

Definition at line 35 of file argument.cpp.

00036 {
00037     return m_classname;
00038 }

ArgumentList & Argument::operator<< (  ArgumentList &  arglist  ) 
 

Implementation of the << operator.

Parameters:
arglist The ArgumentList the operator is applied on.
Returns:
The changed ArgumentList.
Todo:
Document where this argument is added in the list and add a brief code example.

Definition at line 52 of file argument.cpp.

00053 {
00054     arglist << *this;
00055     return arglist;
00056 }

The documentation for this class was generated from the following files:
Generated on Thu Feb 9 17:59:31 2006 for Kross by  doxygen 1.4.6