FunctionDefinitionModel Class Reference

#include <codemodel.h>

Inheritance diagram for FunctionDefinitionModel:

Public Types
typedef FunctionDefinitionDom	Ptr
Public Types inherited from FunctionModel
typedef FunctionDom	Ptr
Public Types inherited from CodeModelItem
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	isFunctionDefinition () const
Public Member Functions inherited from FunctionModel
virtual bool	isFunction () const
TQStringList	scope () const
void	setScope (const TQStringList &scope)
int	access () const
void	setAccess (int access)
bool	isSignal () const
void	setSignal (bool isSignal)
bool	isSlot () const
void	setSlot (bool isSlot)
bool	isVirtual () const
void	setVirtual (bool isVirtual)
bool	isStatic () const
void	setStatic (bool isStatic)
bool	isInline () const
void	setInline (bool isInline)
bool	isConstant () const
void	setConstant (bool isConstant)
bool	isAbstract () const
void	setAbstract (bool isAbstract)
TQString	resultType () const
void	setResultType (const TQString &type)
ArgumentList	argumentList ()
const ArgumentList	argumentList () const
bool	addArgument (ArgumentDom arg)
void	removeArgument (ArgumentDom arg)
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 FunctionModel *i)
bool	canUpdate (const FunctionModel *i) const
Public Member Functions inherited from CodeModelItem
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	isVariable () const
virtual bool	isArgument () 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
	FunctionDefinitionModel (CodeModel *model)
Protected Member Functions inherited from FunctionModel
	FunctionModel (CodeModel *model)
Protected Member Functions inherited from CodeModelItem
	CodeModelItem (int kind, CodeModel *model)

Friends
class	CodeModel

Detailed Description

Function model.

Represents function definition for languages that have such.

Instances of this class should be created using CodeModel::create method.

Definition at line 1383 of file codemodel.h.

Member Typedef Documentation

Ptr

typedef FunctionDefinitionDom FunctionDefinitionModel::Ptr

A definition of safe pointer to the function definition model.

Definition at line 1392 of file codemodel.h.

Constructor & Destructor Documentation

FunctionDefinitionModel()

FunctionDefinitionModel::FunctionDefinitionModel ( CodeModel * model )

protected

Constructor.

Parameters

model

Code model which stores this item.

Definition at line 1265 of file codemodel.cpp.

Member Function Documentation

isFunctionDefinition()

virtual bool FunctionDefinitionModel::isFunctionDefinition ( ) const

inlinevirtual

Returns

true if an item is a FileDefinitionModel.

Reimplemented from CodeModelItem.

Definition at line 1394 of file codemodel.h.

Friends And Related Symbol Documentation

CodeModel

friend class CodeModel

friend

Definition at line 1399 of file codemodel.h.

---

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

• codemodel.h
• codemodel.cpp