umbrello 25.04.3
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
UMLTemplate Class Reference

Sets up template information. More...

#include <template.h>

Inheritance diagram for UMLTemplate:
UMLClassifierListItem UMLObject

Public Member Functions

 UMLTemplate (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None, const QString &type=QStringLiteral("class"))
 UMLTemplate (UMLObject *parent)
bool operator== (const UMLTemplate &rhs) const
virtual void copyInto (UMLObject *lhs) const
virtual UMLObjectclone () const
virtual ~UMLTemplate ()
QString toString (Uml::SignatureType::Enum sig=Uml::SignatureType::NoSig, bool withStereotype=false) const
virtual QString getTypeName () const
virtual bool showPropertiesDialog (QWidget *parent)
void saveToXMI (QXmlStreamWriter &writer)
Public Member Functions inherited from UMLClassifierListItem
 UMLClassifierListItem (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 UMLClassifierListItem (UMLObject *parent)
virtual ~UMLClassifierListItem ()
virtual void setType (UMLObject *type)
UMLClassifiergetType () const
void setTypeName (const QString &type)
Public Member Functions inherited from UMLObject
 UMLObject (const UMLObject &other)
 UMLObject (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 UMLObject (UMLObject *parent)
 UMLObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
virtual ~UMLObject ()
bool operator== (const UMLObject &rhs) const
virtual void setBaseType (ObjectType ot)
ObjectType baseType () const
QLatin1String baseTypeStr () const
virtual void setID (Uml::ID::Type NewID)
virtual Uml::ID::Type id () const
QString doc () const
bool hasDoc () const
void setDoc (const QString &d)
void setVisibility (Uml::Visibility::Enum visibility)
void setVisibilityCmd (Uml::Visibility::Enum visibility)
Uml::Visibility::Enum visibility () const
void setStereotype (const QString &_name)
void setStereotypeCmd (const QString &_name)
QString stereotype (bool includeAdornments=false) const
void setUMLStereotype (UMLStereotype *stereo)
UMLStereotypeumlStereotype () const
QStringList & tags ()
QString package (const QString &separator=QString(), bool includeRoot=false) const
UMLPackageList packages (bool includeRoot=false) const
bool setUMLPackage (UMLPackage *pPkg)
UMLPackageumlPackage () const
void setUMLParent (UMLObject *parent)
UMLObjectumlParent () const
virtual void setName (const QString &strName)
virtual void setNameCmd (const QString &strName)
QString name () const
virtual QString fullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const
void setAbstract (bool bAbstract)
bool isAbstract () const
virtual bool resolveRef ()
virtual bool loadFromXMI (QDomElement &element)
bool loadStereotype (QDomElement &element)
void setStatic (bool bStatic)
bool isStatic () const
virtual bool acceptAssociationType (Uml::AssociationType::Enum) const
void setSecondaryId (const QString &id)
QString secondaryId () const
void setSecondaryFallback (const QString &id)
QString secondaryFallback () const
void save1 (QXmlStreamWriter &writer, const QString &type, const QString &tag=QString())
bool isUMLActor () const
bool isUMLArtifact () const
bool isUMLAssociation () const
bool isUMLAttribute () const
bool isUMLCategory () const
bool isUMLCheckConstraint () const
bool isUMLClassifier () const
bool isUMLComponent () const
bool isUMLDatatype () const
bool isUMLEntity () const
bool isUMLEntityAttribute () const
bool isUMLEntityConstraint () const
bool isUMLEnum () const
bool isUMLEnumLiteral () const
bool isUMLFolder () const
bool isUMLForeignKeyConstraint () const
bool isUMLInstance () const
bool isUMLInstanceAttribute () const
bool isUMLNode () const
bool isUMLObject () const
bool isUMLOperation () const
bool isUMLPackage () const
bool isUMLPort () const
bool isUMLRole () const
bool isUMLStereotype () const
bool isUMLTemplate () const
bool isUMLUniqueConstraint () const
bool isUMLUseCase () const
UMLActorasUMLActor ()
UMLArtifactasUMLArtifact ()
UMLAssociationasUMLAssociation ()
UMLAttributeasUMLAttribute ()
UMLCanvasObjectasUMLCanvasObject ()
UMLCategoryasUMLCategory ()
UMLCheckConstraintasUMLCheckConstraint ()
UMLClassifierasUMLClassifier ()
UMLClassifierListItemasUMLClassifierListItem ()
UMLClassifierSetasUMLClassifierSet ()
UMLComponentasUMLComponent ()
UMLDatatypeasUMLDatatype ()
UMLEntityasUMLEntity ()
UMLEntityAttributeasUMLEntityAttribute ()
UMLEntityConstraintasUMLEntityConstraint ()
UMLEnumasUMLEnum ()
UMLEnumLiteralasUMLEnumLiteral ()
UMLFolderasUMLFolder ()
UMLForeignKeyConstraintasUMLForeignKeyConstraint ()
UMLInstanceasUMLInstance ()
UMLInstanceAttributeasUMLInstanceAttribute ()
UMLNodeasUMLNode ()
UMLObjectasUMLObject ()
UMLOperationasUMLOperation ()
UMLPackageasUMLPackage ()
UMLPortasUMLPort ()
UMLRoleasUMLRole ()
UMLStereotypeasUMLStereotype ()
UMLTemplateasUMLTemplate ()
UMLUniqueConstraintasUMLUniqueConstraint ()
UMLUseCaseasUMLUseCase ()
const UMLActorasUMLActor () const
const UMLArtifactasUMLArtifact () const
const UMLAssociationasUMLAssociation () const
const UMLAttributeasUMLAttribute () const
const UMLCanvasObjectasUMLCanvasObject () const
const UMLCategoryasUMLCategory () const
const UMLCheckConstraintasUMLCheckConstraint () const
const UMLClassifierasUMLClassifier () const
const UMLClassifierListItemasUMLClassifierListItem () const
const UMLClassifierSetasUMLClassifierSet () const
const UMLComponentasUMLComponent () const
const UMLDatatypeasUMLDatatype () const
const UMLEntityasUMLEntity () const
const UMLEntityAttributeasUMLEntityAttribute () const
const UMLEntityConstraintasUMLEntityConstraint () const
const UMLEnumasUMLEnum () const
const UMLEnumLiteralasUMLEnumLiteral () const
const UMLFolderasUMLFolder () const
const UMLForeignKeyConstraintasUMLForeignKeyConstraint () const
const UMLInstanceasUMLInstance () const
const UMLInstanceAttributeasUMLInstanceAttribute () const
const UMLNodeasUMLNode () const
const UMLObjectasUMLObject () const
const UMLOperationasUMLOperation () const
const UMLPackageasUMLPackage () const
const UMLPortasUMLPort () const
const UMLRoleasUMLRole () const
const UMLStereotypeasUMLStereotype () const
const UMLTemplateasUMLTemplate () const
const UMLUniqueConstraintasUMLUniqueConstraint () const
const UMLUseCaseasUMLUseCase () const

Protected Member Functions

bool load1 (QDomElement &element)
Protected Member Functions inherited from UMLObject
void init ()
void maybeSignalObjectCreated ()
void save1end (QXmlStreamWriter &writer)

Additional Inherited Members

Public Types inherited from UMLObject
enum  ObjectType {
  ot_Unknown = -1 , ot_UMLObject = 100 , ot_Actor , ot_UseCase ,
  ot_Package , ot_Interface , ot_Datatype , ot_Enum ,
  ot_Class , ot_Instance , ot_Association , ot_Attribute ,
  ot_Operation , ot_EnumLiteral , ot_Template , ot_Component ,
  ot_Artifact , ot_Node , ot_Stereotype , ot_Role ,
  ot_Entity , ot_EntityAttribute , ot_Folder , ot_EntityConstraint ,
  ot_UniqueConstraint , ot_ForeignKeyConstraint , ot_CheckConstraint , ot_Category ,
  ot_Port , ot_InstanceAttribute , ot_SubSystem
}
Public Slots inherited from UMLObject
void emitModified ()
Signals inherited from UMLObject
void modified ()
Static Public Member Functions inherited from UMLObject
static QString toString (ObjectType ot)
static QString toI18nString (ObjectType t)
static Icon_Utils::IconType toIcon (ObjectType t)
Protected Attributes inherited from UMLObject
Uml::ID::Type m_nId
 object's id
QString m_Doc
 object's documentation
QPointer< UMLStereotypem_pStereotype
 stereotype of the object if applicable
QString m_name
 objects name
ObjectType m_BaseType
 objects type
Uml::Visibility::Enum m_visibility
 objects visibility
bool m_bAbstract
 state of whether the object is abstract or not
bool m_bStatic
 flag for instance scope
bool m_bCreationWasSignalled
 auxiliary to maybeSignalObjectCreated()
QPointer< UMLObjectm_pSecondary
QString m_SecondaryId
QString m_SecondaryFallback
QStringList m_TaggedValues
UMLObjectPrivatem_d
 private data

Detailed Description

Sets up template information.

This class holds information used by template classes, called paramaterised class in UML and a generic in Java. It has a type (usually just "class") and name.

Author
Jonathan Riddell
See also
UMLObject Bugs and comments to umbre.nosp@m.llo-.nosp@m.devel.nosp@m.@kde.nosp@m..org or https://bugs.kde.org

Constructor & Destructor Documentation

◆ UMLTemplate() [1/2]

UMLTemplate::UMLTemplate ( UMLObject * parent,
const QString & name,
Uml::ID::Type id = Uml::ID::None,
const QString & type = QStringLiteral("class") )

Sets up a template.

Parameters
parentThe parent of this UMLTemplate (i.e. its classifier).
nameThe name of this UMLTemplate.
idThe unique id given to this UMLTemplate.
typeThe type of this UMLTemplate.

◆ UMLTemplate() [2/2]

UMLTemplate::UMLTemplate ( UMLObject * parent)
explicit

Sets up a template.

Parameters
parentThe parent of this UMLTemplate (i.e. its classifier).

◆ ~UMLTemplate()

UMLTemplate::~UMLTemplate ( )
virtual

Destructor.

Member Function Documentation

◆ clone()

UMLObject * UMLTemplate::clone ( ) const
virtual

Make a clone of this object.

Implements UMLClassifierListItem.

◆ copyInto()

void UMLTemplate::copyInto ( UMLObject * lhs) const
virtual

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

Reimplemented from UMLClassifierListItem.

◆ getTypeName()

QString UMLTemplate::getTypeName ( ) const
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.

◆ load1()

bool UMLTemplate::load1 ( QDomElement & element)
protectedvirtual

Loads the <UML:TemplateParameter> XMI element.

Reimplemented from UMLObject.

◆ operator==()

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

Overloaded '==' operator.

◆ saveToXMI()

void UMLTemplate::saveToXMI ( QXmlStreamWriter & writer)
virtual

Writes the <UML:TemplateParameter> XMI element.

Reimplemented from UMLObject.

◆ showPropertiesDialog()

bool UMLTemplate::showPropertiesDialog ( QWidget * parent)
virtual

Display the properties configuration dialog for the template.

Returns
Success status.

Reimplemented from UMLObject.

◆ toString()

QString UMLTemplate::toString ( Uml::SignatureType::Enum sig = Uml::SignatureType::NoSig,
bool withStereotype = false ) const
virtual

Returns a string representation of the list item.

Parameters
sigWhat type of operation string to show.
Returns
The string representation of the operation.

Reimplemented from UMLClassifierListItem.


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