CodeAccessorMethod Class Reference

#include <codeaccessormethod.h>

Inheritance diagram for CodeAccessorMethod:

Public Types
enum	AccessorType {   GET =0, SET, ADD, REMOVE,   LIST }
Public Types inherited from CodeBlock
enum	ContentType { AutoGenerated =0, UserGenerated }

Public Member Functions
	CodeAccessorMethod (CodeClassField *field)
virtual	~CodeAccessorMethod ()
CodeClassField *	getParentClassField ()
AccessorType	getType ()
virtual void	loadFromXMI (QDomElement &root)
bool	parentIsAttribute ()
virtual void	saveToXMI (QDomDocument &doc, QDomElement &root)
virtual void	setAttributesFromObject (TextBlock *obj)
void	setType (AccessorType type)
virtual void	updateContent ()=0
Public Member Functions inherited from CodeMethodBlock
	CodeMethodBlock (ClassifierCodeDocument *doc, UMLObject *parentObj, const QString &body=QString(), const QString &comment=QString())
virtual	~CodeMethodBlock ()
QString	getEndMethodText () const
CodeDocument *	getParentDocument ()
QString	getStartMethodText () const
virtual QString	toString () const
Public Member Functions inherited from OwnedCodeBlock
	OwnedCodeBlock (UMLObject *parent)
virtual	~OwnedCodeBlock ()
UMLObject *	getParentObject ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const
Public Member Functions inherited from CodeBlockWithComments
	CodeBlockWithComments (CodeDocument *parent, const QString &body=QString(), const QString &comment=QString())
virtual	~CodeBlockWithComments ()
CodeComment *	getComment () const
void	setComment (CodeComment *object)
void	setOverallIndentationLevel (int level)
Public Member Functions inherited from CodeBlock
	CodeBlock (CodeDocument *parent, const QString &body=QString())
virtual	~CodeBlock ()
ContentType	contentType () const
void	setContentType (ContentType new_var)
Public Member Functions inherited from TextBlock
	TextBlock (CodeDocument *parent, const QString &text=QString())
virtual	~TextBlock ()
void	appendText (const QString &text)
bool	canDelete () const
virtual int	firstEditableLine ()
int	getIndentationLevel () const
QString	getIndentationString (int level=0) const
virtual QString	getNewEditorLine (int amount=0)
CodeDocument *	getParentDocument () const
QString	getTag () const
QString	getText () const
bool	getWriteOutText () const
virtual int	lastEditableLine ()
void	setIndentationLevel (int level)
void	setTag (const QString &value)
void	setText (const QString &text)
void	setWriteOutText (bool write)
virtual QString	unformatText (const QString &text, const QString &indent=QString())

Protected Member Functions
void	forceRelease ()
virtual void	release ()
virtual void	setAttributesFromNode (QDomElement &element)
virtual void	setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement)
virtual void	updateMethodDeclaration ()=0
Protected Member Functions inherited from CodeMethodBlock
void	setEndMethodText (const QString &value)
void	setStartMethodText (const QString &value)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Protected Member Functions inherited from TextBlock
void	setCanDelete (bool canDelete)

Additional Inherited Members
Public Slots inherited from CodeMethodBlock
virtual void	syncToParent ()
Public Slots inherited from OwnedCodeBlock
virtual void	syncToParent ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Public Member Functions inherited from CodeBlock
static QString	enumToString (const ContentType &val)
Static Public Member Functions inherited from TextBlock
static QString	decodeText (const QString &text, const QString &endLine)
static QString	encodeText (const QString &text, const QString &endLine)
static QString	formatMultiLineText (const QString &work, const QString &linePrefix, const QString &breakStr, bool addBreak=true, bool lastLineHasBreak=true)
static QString	getIndentation ()
static QString	getNewLineEndingChars ()
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Definition at line 20 of file codeaccessormethod.h.

Member Enumeration Documentation

enum CodeAccessorMethod::AccessorType

Enumerator
GET
SET
ADD
REMOVE
LIST

Definition at line 32 of file codeaccessormethod.h.

Constructor & Destructor Documentation

CodeAccessorMethod::CodeAccessorMethod ( CodeClassField *  field )

explicit

Constructors.

Definition at line 23 of file codeaccessormethod.cpp.

CodeAccessorMethod::~CodeAccessorMethod ( )

virtual

Empty Destructor.

Definition at line 32 of file codeaccessormethod.cpp.

Member Function Documentation

void CodeAccessorMethod::forceRelease ( )

protected

A method so the parent code classfield can force code block to release.

Definition at line 91 of file codeaccessormethod.cpp.

CodeClassField * CodeAccessorMethod::getParentClassField

(

)

Get the value of m_parentclassfield.

Returns

the value of m_parentclassfield

Definition at line 40 of file codeaccessormethod.cpp.

CodeAccessorMethod::AccessorType CodeAccessorMethod::getType

(

)

Utility method to get the value of the parent object of the parent classifield.

Returns

the value of the parent of the parent classfield Return the type of accessor method this is.

Definition at line 64 of file codeaccessormethod.cpp.

void CodeAccessorMethod::loadFromXMI ( QDomElement &  root )

virtual

Load params from the appropriate XMI element node.

Reimplemented from CodeBlockWithComments.

Definition at line 102 of file codeaccessormethod.cpp.

bool CodeAccessorMethod::parentIsAttribute

(

)

Definition at line 45 of file codeaccessormethod.cpp.

void CodeAccessorMethod::release ( )

protectedvirtual

This type of textblock is special we DON'T release it when resetTextBlocks is called because we re-use it over and over until the codeclassfield is released.

Reimplemented from CodeMethodBlock.

Definition at line 83 of file codeaccessormethod.cpp.

void CodeAccessorMethod::saveToXMI ( QDomDocument &  doc, QDomElement &  root  )

virtual

Save the XMI representation of this object.

Reimplemented from CodeBlockWithComments.

Definition at line 110 of file codeaccessormethod.cpp.

void CodeAccessorMethod::setAttributesFromNode ( QDomElement &  element )

protectedvirtual

Set the class attributes of this object from the passed element node.

Reimplemented from CodeMethodBlock.

Reimplemented in DCodeAccessorMethod, JavaCodeAccessorMethod, and RubyCodeAccessorMethod.

Definition at line 137 of file codeaccessormethod.cpp.

void CodeAccessorMethod::setAttributesFromObject ( TextBlock *  obj )

virtual

Set the class attributes from a passed object.

Reimplemented from CodeMethodBlock.

Definition at line 170 of file codeaccessormethod.cpp.

void CodeAccessorMethod::setAttributesOnNode ( QDomDocument &  doc, QDomElement &  blockElement  )

protectedvirtual

Set attributes of the node that represents this class in the XMI document.

Reimplemented from CodeMethodBlock.

Reimplemented in DCodeAccessorMethod, JavaCodeAccessorMethod, and RubyCodeAccessorMethod.

Definition at line 123 of file codeaccessormethod.cpp.

void CodeAccessorMethod::setType

(

CodeAccessorMethod::AccessorType

atype

)

Set the type of accessor method this is.

Definition at line 72 of file codeaccessormethod.cpp.

virtual void CodeAccessorMethod::updateContent ( )

pure virtual

This is the method called from within syncToparent() to update the body of the method.

It is only called if the method is Auto-generated.

Implements CodeMethodBlock.

Implemented in CPPHeaderCodeAccessorMethod, CPPSourceCodeAccessorMethod, DCodeAccessorMethod, JavaCodeAccessorMethod, and RubyCodeAccessorMethod.

virtual void CodeAccessorMethod::updateMethodDeclaration ( )

protectedpure virtual

This is the method called from within syncToparent().

To update the start and end Method text. It is called whether or not the method is Auto or User generated.

Implements CodeMethodBlock.

Implemented in CPPHeaderCodeAccessorMethod, CPPSourceCodeAccessorMethod, DCodeAccessorMethod, JavaCodeAccessorMethod, and RubyCodeAccessorMethod.

---

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

• codeaccessormethod.h
• codeaccessormethod.cpp