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

Sets up attribute information. More...

#include <umlenumliteral.h>

Inheritance diagram for UMLEnumLiteral:
Collaboration diagram for UMLEnumLiteral:

Public Member Functions

 UMLEnumLiteral (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None, const QString &v=QString())
 
 UMLEnumLiteral (UMLObject *parent)
 
bool operator== (const UMLEnumLiteral &rhs) const
 
virtual void copyInto (UMLObject *lhs) const
 
virtual UMLObject * clone () const
 
virtual ~UMLEnumLiteral ()
 
QString value () const
 
void setValue (const QString &v)
 
QString toString (Uml::SignatureType::Enum sig=Uml::SignatureType::NoSig, bool withStereotype=false) const
 
virtual void saveToXMI (QXmlStreamWriter &writer)
 
virtual bool showPropertiesDialog (QWidget *parent=nullptr)
 
- 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)
 
UMLClassifier * getType () const
 
void setTypeName (const QString &type)
 
virtual QString getTypeName () const
 
- 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)
 
UMLStereotype * umlStereotype () const
 
QStringList & tags ()
 
QString package (const QString &separator=QString(), bool includeRoot=false) const
 
UMLPackageList packages (bool includeRoot=false) const
 
bool setUMLPackage (UMLPackage *pPkg)
 
UMLPackage * umlPackage () const
 
void setUMLParent (UMLObject *parent)
 
UMLObject * umlParent () 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
 
UMLActor * asUMLActor ()
 
UMLArtifact * asUMLArtifact ()
 
UMLAssociation * asUMLAssociation ()
 
UMLAttribute * asUMLAttribute ()
 
UMLCanvasObject * asUMLCanvasObject ()
 
UMLCategory * asUMLCategory ()
 
UMLCheckConstraint * asUMLCheckConstraint ()
 
UMLClassifier * asUMLClassifier ()
 
UMLClassifierListItem * asUMLClassifierListItem ()
 
UMLClassifierSet * asUMLClassifierSet ()
 
UMLComponent * asUMLComponent ()
 
UMLDatatype * asUMLDatatype ()
 
UMLEntity * asUMLEntity ()
 
UMLEntityAttribute * asUMLEntityAttribute ()
 
UMLEntityConstraint * asUMLEntityConstraint ()
 
UMLEnum * asUMLEnum ()
 
UMLEnumLiteral * asUMLEnumLiteral ()
 
UMLFolder * asUMLFolder ()
 
UMLForeignKeyConstraint * asUMLForeignKeyConstraint ()
 
UMLInstance * asUMLInstance ()
 
UMLInstanceAttribute * asUMLInstanceAttribute ()
 
UMLNode * asUMLNode ()
 
UMLObject * asUMLObject ()
 
UMLOperation * asUMLOperation ()
 
UMLPackage * asUMLPackage ()
 
UMLPort * asUMLPort ()
 
UMLRole * asUMLRole ()
 
UMLStereotype * asUMLStereotype ()
 
UMLTemplate * asUMLTemplate ()
 
UMLUniqueConstraint * asUMLUniqueConstraint ()
 
UMLUseCase * asUMLUseCase ()
 
const UMLActor * asUMLActor () const
 
const UMLArtifact * asUMLArtifact () const
 
const UMLAssociation * asUMLAssociation () const
 
const UMLAttribute * asUMLAttribute () const
 
const UMLCanvasObject * asUMLCanvasObject () const
 
const UMLCategory * asUMLCategory () const
 
const UMLCheckConstraint * asUMLCheckConstraint () const
 
const UMLClassifier * asUMLClassifier () const
 
const UMLClassifierListItem * asUMLClassifierListItem () const
 
const UMLClassifierSet * asUMLClassifierSet () const
 
const UMLComponent * asUMLComponent () const
 
const UMLDatatype * asUMLDatatype () const
 
const UMLEntity * asUMLEntity () const
 
const UMLEntityAttribute * asUMLEntityAttribute () const
 
const UMLEntityConstraint * asUMLEntityConstraint () const
 
const UMLEnum * asUMLEnum () const
 
const UMLEnumLiteral * asUMLEnumLiteral () const
 
const UMLFolder * asUMLFolder () const
 
const UMLForeignKeyConstraint * asUMLForeignKeyConstraint () const
 
const UMLInstance * asUMLInstance () const
 
const UMLInstanceAttribute * asUMLInstanceAttribute () const
 
const UMLNode * asUMLNode () const
 
const UMLObject * asUMLObject () const
 
const UMLOperation * asUMLOperation () const
 
const UMLPackage * asUMLPackage () const
 
const UMLPort * asUMLPort () const
 
const UMLRole * asUMLRole () const
 
const UMLStereotype * asUMLStereotype () const
 
const UMLTemplate * asUMLTemplate () const
 
const UMLUniqueConstraint * asUMLUniqueConstraint () const
 
const UMLUseCase * asUMLUseCase () const
 

Protected Member Functions

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

Protected Attributes

QString m_Value
 
- Protected Attributes inherited from UMLObject
Uml::ID::Type m_nId
 object's id
 
QString m_Doc
 object's documentation
 
QPointer< UMLStereotype > m_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< UMLObject > m_pSecondary
 
QString m_SecondaryId
 
QString m_SecondaryFallback
 
QStringList m_TaggedValues
 
UMLObjectPrivate * m_d
 private data
 

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)
 

Detailed Description

Sets up attribute information.

This class is used to set up information for an enum literal. Enum literals are the values that enums can be set to.

Author
Paul Hensgen phens.nosp@m.gen@.nosp@m.techi.nosp@m.e.co.nosp@m.m
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

◆ UMLEnumLiteral() [1/2]

UMLEnumLiteral::UMLEnumLiteral ( UMLObject * parent,
const QString & name,
Uml::ID::Type id = Uml::ID::None,
const QString & v = QString() )

Sets up an enum literal.

Parameters
parentThe parent of this UMLEnumLiteral.
nameThe name of this UMLEnumLiteral.
idThe unique id given to this UMLEnumLiteral.
vThe numeric representation value of this UMLEnumLiteral. CAVEAT: 1) This does not conform to the UML standard. 2) Programming language specific: Not all languages support enum representations.
Here is the call graph for this function:

◆ UMLEnumLiteral() [2/2]

UMLEnumLiteral::UMLEnumLiteral ( UMLObject * parent)
explicit

Sets up an enum literal.

Parameters
parentThe parent of this UMLEnumLiteral.
Here is the call graph for this function:

◆ ~UMLEnumLiteral()

UMLEnumLiteral::~UMLEnumLiteral ( )
virtual

Destructor.

Member Function Documentation

◆ clone()

UMLObject * UMLEnumLiteral::clone ( ) const
virtual

Make a clone of this object.

Implements UMLClassifierListItem.

Here is the call graph for this function:

◆ copyInto()

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

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

Reimplemented from UMLClassifierListItem.

Here is the call graph for this function:

◆ load1()

bool UMLEnumLiteral::load1 ( QDomElement & element)
protectedvirtual

Loads the <UML:EnumLiteral> XMI element (empty.)

Reimplemented from UMLObject.

◆ operator==()

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

Overloaded '==' operator

Here is the call graph for this function:

◆ saveToXMI()

void UMLEnumLiteral::saveToXMI ( QXmlStreamWriter & writer)
virtual

Creates the <UML:EnumLiteral> XMI element.

Reimplemented from UMLObject.

Here is the call graph for this function:

◆ setValue()

void UMLEnumLiteral::setValue ( const QString & v)

Sets the value of the UMLEnumLiteral.

Parameters
vThe value of the Enum Literal.
Here is the call graph for this function:

◆ showPropertiesDialog()

bool UMLEnumLiteral::showPropertiesDialog ( QWidget * parent = nullptr)
virtual

Display the properties configuration dialog for the enum literal.

Reimplemented from UMLObject.

◆ toString()

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

Returns a string representation of the UMLEnumLiteral.

Parameters
sigIf true will show the attribute type and value.
Returns
Returns a string representation of the UMLEnumLiteral.

Reimplemented from UMLClassifierListItem.

Here is the call graph for this function:

◆ value()

QString UMLEnumLiteral::value ( ) const

Returns the value of the UMLEnumLiteral.

Returns
The value of the Enum Literal.

Member Data Documentation

◆ m_Value

QString UMLEnumLiteral::m_Value
protected

Value is an extension to the UML 2.5 metamodel. It manage the internal representation of enumeration value in system programming languages.


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