EnumeratorModel Class Reference

#include <codemodel.h>

Inheritance diagram for EnumeratorModel:

Public Types
typedef EnumeratorDom	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	isEnumerator () const
TQString	value () const
void	setValue (const TQString &value)
virtual void	read (TQDataStream &stream)
virtual void	write (TQDataStream &stream) const
virtual void	dump (std::ostream &file, bool recurse=false, TQString Info="")
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	isFunction () const
virtual bool	isFunctionDefinition () const
virtual bool	isVariable () const
virtual bool	isArgument () const
virtual bool	isEnum () const
virtual bool	isTypeAlias () const
virtual bool	isCustom () const
virtual bool	isTemplateable () const
CodeModel *	codeModel ()
const CodeModel *	codeModel () const

Protected Member Functions
	EnumeratorModel (CodeModel *model)
Protected Member Functions inherited from CodeModelItem
	CodeModelItem (int kind, CodeModel *model)

Friends
class	CodeModel

Detailed Description

Enumerator model.

Represents enumerators. Enums consist of enumerators, for example in code:

enum Type { A, B, C};

Type is represented as EnumModel;
A, B, C are represented with EnumeratorModel.

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

Definition at line 1537 of file codemodel.h.

Member Typedef Documentation

Ptr

typedef EnumeratorDom EnumeratorModel::Ptr

A definition of safe pointer to the enumerator model.

Definition at line 1546 of file codemodel.h.

Constructor & Destructor Documentation

EnumeratorModel()

EnumeratorModel::EnumeratorModel ( CodeModel * model )

protected

Constructor.

Parameters

model

Code model which stores this item.

Definition at line 1716 of file codemodel.cpp.

Member Function Documentation

dump()

void EnumeratorModel::dump ( std::ostream & file, bool recurse = false, TQString Info = "" )

virtual

just to get rid of the warning

Reimplemented from CodeModelItem.

Definition at line 337 of file codemodel.cpp.

isEnumerator()

virtual bool EnumeratorModel::isEnumerator ( ) const

inlinevirtual

Returns

true if an item is a EnumeratorModel.

Reimplemented from CodeModelItem.

Definition at line 1548 of file codemodel.h.

read()

void EnumeratorModel::read ( TQDataStream & stream )

virtual

Reads an item from the stream.

Parameters

stream

The stream to read from.

Reimplemented from CodeModelItem.

Definition at line 1731 of file codemodel.cpp.

setValue()

void EnumeratorModel::setValue

(

const TQString &

value

)

Sets the value of an enumerator.

Parameters

value

The value.

Definition at line 1726 of file codemodel.cpp.

value()

TQString EnumeratorModel::value

(

)

const

Returns

The value of an enumerator.

Definition at line 1721 of file codemodel.cpp.

write()

void EnumeratorModel::write ( TQDataStream & stream ) const

virtual

Writes an item to the stream.

Parameters

stream

The stream to write to.

Reimplemented from CodeModelItem.

Definition at line 1737 of file codemodel.cpp.

Friends And Related Symbol Documentation

CodeModel

friend class CodeModel

friend

Definition at line 1567 of file codemodel.h.

---

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

• codemodel.h
• codemodel.cpp