#include <codemodel.h>

Public Types | |
typedef ArgumentDom | Ptr |
![]() | |
enum | Kind { File, Namespace, Class, Function, Variable, Argument, FunctionDefinition, Enum, Enumerator, TypeAlias, Custom = 1000 } |
enum | Access { Public, Protected, Private } |
typedef ItemDom | Ptr |
Public Member Functions | |
virtual bool | isArgument () const |
TQString | type () const |
void | setType (const TQString &type) |
TQString | defaultValue () const |
void | setDefaultValue (const TQString &defaultValue) |
virtual void | read (TQDataStream &stream) |
virtual void | write (TQDataStream &stream) const |
virtual void | dump (std::ostream &file, bool recurse=false, TQString Info="") |
![]() | |
void | update (const CodeModelItem *i) |
bool | canUpdate (const CodeModelItem *i) const |
virtual | ~CodeModelItem () |
int | kind () const |
void | setKind (int kind) |
TQString | name () const |
TQString | comment () const |
void | setComment (TQString comment) |
void | setName (const TQString &name) |
FileDom | file () |
const FileDom | file () const |
TQString | fileName () const |
void | setFileName (const TQString &fileName) |
void | getStartPosition (int *line, int *col) const |
void | setStartPosition (int line, int col) |
void | getEndPosition (int *line, int *col) const |
void | setEndPosition (int line, int col) |
virtual bool | isFile () const |
virtual bool | isNamespace () const |
virtual bool | isClass () const |
virtual bool | isFunction () const |
virtual bool | isFunctionDefinition () const |
virtual bool | isVariable () const |
virtual bool | isEnum () const |
virtual bool | isEnumerator () const |
virtual bool | isTypeAlias () const |
virtual bool | isCustom () const |
virtual bool | isTemplateable () const |
CodeModel * | codeModel () |
const CodeModel * | codeModel () const |
Protected Member Functions | |
ArgumentModel (CodeModel *model) | |
![]() | |
CodeModelItem (int kind, CodeModel *model) | |
Friends | |
class | CodeModel |
Detailed Description
Function (procedure) argument model.
Represents an argument in the function.
Instances of this class should be created using CodeModel::create method.
Definition at line 1191 of file codemodel.h.
Member Typedef Documentation
◆ Ptr
typedef ArgumentDom ArgumentModel::Ptr |
A definition of safe pointer to the argument model.
Definition at line 1198 of file codemodel.h.
Member Function Documentation
◆ defaultValue()
TQString ArgumentModel::defaultValue | ( | ) | const |
- Returns
- The default value of this argument.
Definition at line 1079 of file codemodel.cpp.
◆ dump()
|
virtual |
just to get rid of the warning
Reimplemented from CodeModelItem.
Definition at line 248 of file codemodel.cpp.
◆ isArgument()
|
inlinevirtual |
- Returns
- true if an item is an ArgumentModel.
Reimplemented from CodeModelItem.
Definition at line 1200 of file codemodel.h.
◆ read()
|
virtual |
Reads an item from the stream.
- Parameters
-
stream The stream to read from.
Reimplemented from CodeModelItem.
Definition at line 1559 of file codemodel.cpp.
◆ setDefaultValue()
void ArgumentModel::setDefaultValue | ( | const TQString & | defaultValue | ) |
Sets the default value of this argument.
- Parameters
-
defaultValue The default value to set.
Definition at line 1084 of file codemodel.cpp.
◆ setType()
void ArgumentModel::setType | ( | const TQString & | type | ) |
Sets the type of this argument.
- Parameters
-
type The type to set.
Definition at line 1074 of file codemodel.cpp.
◆ type()
TQString ArgumentModel::type | ( | ) | const |
- Returns
- The type of this argument.
Definition at line 1069 of file codemodel.cpp.
◆ write()
|
virtual |
Writes an item to the stream.
- Parameters
-
stream The stream to write to.
Reimplemented from CodeModelItem.
Definition at line 1567 of file codemodel.cpp.
The documentation for this class was generated from the following files: