UMLTemplate Class Reference

This class holds information used by template classes, called paramaterised class in UML and a generic in Java. Sets up template information. More...

#include <template.h>

Inheritance diagram for UMLTemplate:

List of all members.


Public Member Functions
	UMLTemplate (const UMLObject *parent, const QString &name, Uml::IDType id=Uml::id_None, const QString &type="class")
	Sets up a template.
	UMLTemplate (const UMLObject *parent)
	Sets up a template.
bool	operator== (UMLTemplate &rhs)
	Overloaded '==' operator.
virtual void	copyInto (UMLTemplate *rhs) const
	Copy the internal presentation of this object into the new object.
virtual UMLObject *	clone () const
	Make a clone of this object.
virtual	~UMLTemplate ()
	destructor
QString	toString (Uml::Signature_Type sig=Uml::st_NoSig)
	Returns a string representation of the UMLTemplate.
virtual QString	getTypeName ()
	Overrides method from UMLClassifierListItem.
bool	showPropertiesDialog (QWidget *parent)
	Display the properties configuration dialog for the template.
void	saveToXMI (QDomDocument &qDoc, QDomElement &qElement)
	Writes the <UML:TemplateParameter> XMI element.
Protected Member Functions
bool	load (QDomElement &element)
	Loads the <UML:TemplateParameter> XMI element.

Detailed Description

This class holds information used by template classes, called paramaterised class in UML and a generic in Java. Sets up template information.

It has a type (usually just "class") and name.

Author:: Jonathan Riddell

See also:: UMLObject Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org

Definition at line 28 of file template.h.

Constructor & Destructor Documentation

UMLTemplate::UMLTemplate ( const UMLObject * parent,

const QString & name,

Uml::IDType id = Uml::id_None,

const QString & type = "class"

)

Sets up a template.

Parameters:

parent The parent of this UMLTemplate (i.e. its concept).

name The name of this UMLTemplate.

id The unique id given to this UMLTemplate.

type The type of this UMLTemplate.

Definition at line 24 of file template.cpp.
References UMLClassifierListItem::setTypeName().
Referenced by clone().

UMLTemplate::UMLTemplate ( const UMLObject * parent )

Sets up a template.

Parameters:

parent The parent of this UMLTemplate (i.e. its concept).

Definition at line 31 of file template.cpp.

UMLTemplate::~UMLTemplate ( ) [virtual]

destructor

Definition at line 36 of file template.cpp.

Member Function Documentation

bool UMLTemplate::operator== ( UMLTemplate & rhs )

Overloaded '==' operator.

Definition at line 52 of file template.cpp.
References UMLObject::m_pSecondary.

void UMLTemplate::copyInto ( UMLTemplate * rhs ) const [virtual]

Copy the internal presentation of this object into the new object.

Definition at line 65 of file template.cpp.
References UMLClassifierListItem::copyInto().
Referenced by clone().

UMLObject * UMLTemplate::clone ( ) const [virtual]

Make a clone of this object.

Implements UMLClassifierListItem.
Definition at line 70 of file template.cpp.
References clone(), copyInto(), and UMLTemplate().
Referenced by clone().

QString UMLTemplate::toString ( Uml::Signature_Type sig = Uml::st_NoSig ) [virtual]

Returns a string representation of the UMLTemplate.

Parameters:

sig Currently unused.

Returns:
Returns a string representation of the UMLTemplate.

Reimplemented from UMLClassifierListItem.
Definition at line 38 of file template.cpp.
References UMLObject::getName().
Referenced by UMLListView::createChildUMLObject(), and UMLListViewItem::okRename().

QString UMLTemplate::getTypeName ( ) [virtual]

Overrides method from UMLClassifierListItem.
Returns the type name of the UMLTemplate. If the template parameter is a class, there is no separate type object. In this case, getTypeName() returns "class".

Returns:
The type name of the UMLClassifierListItem.

Reimplemented from UMLClassifierListItem.
Definition at line 46 of file template.cpp.
References UMLObject::getName().
Referenced by UMLTemplateDialog::setupDialog().

bool UMLTemplate::showPropertiesDialog ( QWidget * parent ) [virtual]

Display the properties configuration dialog for the template.

Returns:
Success status.

Implements UMLClassifierListItem.
Definition at line 92 of file template.cpp.

void UMLTemplate::saveToXMI ( QDomDocument & qDoc,

QDomElement & qElement

) [virtual]

Writes the <UML:TemplateParameter> XMI element.

Implements UMLObject.
Definition at line 79 of file template.cpp.
References UMLObject::getID(), and UMLObject::save().

bool UMLTemplate::load ( QDomElement & element ) [protected, virtual]

Loads the <UML:TemplateParameter> XMI element.

Reimplemented from UMLObject.
Definition at line 87 of file template.cpp.

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

umbrello API Documentation

UMLTemplate Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation