umbrello  2.31.0
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
Signals | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
UMLEnum Class Reference

Non-graphical Information for an Enum. More...

#include <enum.h>

Inheritance diagram for UMLEnum:
UMLClassifier UMLPackage UMLCanvasObject UMLObject

Signals

void enumLiteralAdded (UMLClassifierListItem *)
 
void enumLiteralRemoved (UMLClassifierListItem *)
 
- Signals inherited from UMLClassifier
void operationAdded (UMLClassifierListItem *)
 
void operationRemoved (UMLClassifierListItem *)
 
void templateAdded (UMLClassifierListItem *)
 
void templateRemoved (UMLClassifierListItem *)
 
void attributeAdded (UMLClassifierListItem *)
 
void attributeRemoved (UMLClassifierListItem *)
 
- Signals inherited from UMLCanvasObject
void sigAssociationEndAdded (UMLAssociation *assoc)
 
void sigAssociationEndRemoved (UMLAssociation *assoc)
 
- Signals inherited from UMLObject
void modified ()
 

Public Member Functions

 UMLEnum (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLEnum ()
 
bool operator== (const UMLEnum &rhs) const
 
virtual void copyInto (UMLObject *lhs) const
 
virtual UMLObjectclone () const
 
UMLObjectcreateEnumLiteral (const QString &name=QString())
 
UMLObjectaddEnumLiteral (const QString &name, Uml::ID::Type id=Uml::ID::None, const QString &value=QString())
 
bool addEnumLiteral (UMLEnumLiteral *literal, IDChangeLog *Log=0)
 
bool addEnumLiteral (UMLEnumLiteral *literal, int position)
 
int removeEnumLiteral (UMLEnumLiteral *literal)
 
int enumLiterals ()
 
void signalEnumLiteralRemoved (UMLClassifierListItem *elit)
 
virtual void saveToXMI1 (QDomDocument &qDoc, QDomElement &qElement)
 
virtual UMLClassifierListItemmakeChildObject (const QString &xmiTag)
 
- Public Member Functions inherited from UMLClassifier
 UMLClassifier (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLClassifier ()
 
virtual void setNameCmd (const QString &strName)
 
virtual UMLAttributecreateAttribute (const QString &name=QString(), UMLObject *type=0, Uml::Visibility::Enum vis=Uml::Visibility::Private, const QString &init=QString())
 
UMLAttributeaddAttribute (const QString &name, Uml::ID::Type id=Uml::ID::None)
 
UMLAttributeaddAttribute (const QString &name, UMLObject *type, Uml::Visibility::Enum scope)
 
bool addAttribute (UMLAttribute *att, IDChangeLog *log=0, int position=-1)
 
int removeAttribute (UMLAttribute *att)
 
UMLAttributeList getAttributeList () const
 
UMLAttributeList getAttributeList (Uml::Visibility::Enum scope) const
 
UMLAttributeList getAttributeListStatic (Uml::Visibility::Enum scope) const
 
UMLOperationcreateOperation (const QString &name=QString(), bool *isExistingOp=0, Model_Utils::NameAndType_List *params=0)
 
bool addOperation (UMLOperation *op, int position=-1)
 
bool addOperation (UMLOperation *op, IDChangeLog *log)
 
UMLOperationcheckOperationSignature (const QString &name, UMLAttributeList opParams, UMLOperation *exemptOp=0)
 
int removeOperation (UMLOperation *op)
 
int operations ()
 
UMLOperationList getOpList (bool includeInherited=false, UMLClassifierSet *alreadyTraversed=0)
 
UMLObjectcreateTemplate (const QString &name=QString())
 
UMLTemplateaddTemplate (const QString &name, Uml::ID::Type id=Uml::ID::None)
 
bool addTemplate (UMLTemplate *newTemplate, IDChangeLog *log=0)
 
bool addTemplate (UMLTemplate *templt, int position)
 
int removeTemplate (UMLTemplate *umltemplate)
 
UMLTemplatefindTemplate (const QString &name)
 
int templates ()
 
UMLTemplateList getTemplateList () const
 
int takeItem (UMLClassifierListItem *item)
 
virtual UMLClassifierListItemList getFilteredList (UMLObject::ObjectType ot) const
 
virtual bool resolveRef ()
 
UMLOperationList findOperations (const QString &n)
 
virtual UMLObjectfindChildObjectById (Uml::ID::Type id, bool considerAncestors=false)
 
UMLOperationfindOperation (const QString &name, Model_Utils::NameAndType_List params)
 
UMLClassifierList findSuperClassConcepts (ClassifierType type=ALL)
 
UMLClassifierList findSubClassConcepts (ClassifierType type=ALL)
 
virtual bool acceptAssociationType (Uml::AssociationType::Enum type)
 
void setBaseType (UMLObject::ObjectType ot)
 
bool isInterface () const
 
bool hasAbstractOps ()
 
bool hasAssociations ()
 
bool hasAttributes ()
 
bool hasStaticAttributes ()
 
bool hasMethods ()
 
bool hasAccessorMethods ()
 
bool hasOperationMethods ()
 
bool hasVectorFields ()
 
virtual UMLAssociationList getUniAssociationToBeImplemented ()
 
- Public Member Functions inherited from UMLPackage
 UMLPackage (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLPackage ()
 
bool addObject (UMLObject *pObject)
 
void removeObject (UMLObject *pObject)
 
virtual void removeAllObjects ()
 
UMLObjectListcontainedObjects ()
 
void addAssocToConcepts (UMLAssociation *assoc)
 
void removeAssocFromConcepts (UMLAssociation *assoc)
 
UMLObjectfindObject (const QString &name)
 
UMLObjectfindObjectById (Uml::ID::Type id)
 
void appendPackages (UMLPackageList &packages, bool includeNested=true)
 
void appendClassifiers (UMLClassifierList &classifiers, bool includeNested=true)
 
void appendClassesAndInterfaces (UMLClassifierList &classifiers, bool includeNested=true)
 
void appendEntities (UMLEntityList &entities, bool includeNested=true)
 
- Public Member Functions inherited from UMLCanvasObject
 UMLCanvasObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLCanvasObject ()
 
bool operator== (const UMLCanvasObject &rhs) const
 
bool addAssociationEnd (UMLAssociation *assoc)
 
bool hasAssociation (UMLAssociation *assoc)
 
int removeAssociationEnd (UMLAssociation *assoc)
 
void removeAllAssociationEnds ()
 
int associations ()
 
UMLAssociationList getAssociations ()
 
UMLAssociationList getSpecificAssocs (Uml::AssociationType::Enum assocType)
 
UMLClassifierList getSuperClasses (bool withRealizations=true)
 
UMLClassifierList getSubClasses ()
 
virtual UMLAssociationList getRealizations ()
 
UMLAssociationList getAggregations ()
 
UMLAssociationList getCompositions ()
 
UMLAssociationList getRelationships ()
 
virtual UMLObjectfindChildObject (const QString &n, UMLObject::ObjectType t=UMLObject::ot_UMLObject)
 
virtual QString uniqChildName (const UMLObject::ObjectType type, const QString &prefix=QString())
 
virtual void removeAllChildObjects ()
 
UMLObjectListsubordinates () 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
 
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 ()
 
QString package (const QString &separator=QString(), bool includeRoot=false)
 
UMLPackageList packages (bool includeRoot=false) const
 
bool setUMLPackage (UMLPackage *pPkg)
 
UMLPackageumlPackage () const
 
void setUMLParent (UMLObject *parent)
 
UMLObjectumlParent () const
 
virtual void setName (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 showPropertiesDialog (QWidget *parent=0)
 
virtual bool loadFromXMI1 (QDomElement &element)
 
bool loadStereotype (QDomElement &element)
 
void setStatic (bool bStatic)
 
bool isStatic () const
 
void setSecondaryId (const QString &id)
 
QString secondaryId () const
 
void setSecondaryFallback (const QString &id)
 
QString secondaryFallback () const
 
QDomElement save1 (const QString &tag, QDomDocument &qDoc)
 
bool isUMLActor ()
 
bool isUMLArtifact ()
 
bool isUMLAssociation ()
 
bool isUMLAttribute ()
 
bool isUMLCategory ()
 
bool isUMLCheckConstraint ()
 
bool isUMLClassifier ()
 
bool isUMLComponent ()
 
bool isUMLDatatype ()
 
bool isUMLEntity ()
 
bool isUMLEntityAttribute ()
 
bool isUMLEntityConstraint ()
 
bool isUMLEnum ()
 
bool isUMLEnumLiteral ()
 
bool isUMLFolder ()
 
bool isUMLForeignKeyConstraint ()
 
bool isUMLInstance ()
 
bool isUMLInstanceAttribute ()
 
bool isUMLNode ()
 
bool isUMLObject ()
 
bool isUMLOperation ()
 
bool isUMLPackage ()
 
bool isUMLPort ()
 
bool isUMLRole ()
 
bool isUMLStereotype ()
 
bool isUMLTemplate ()
 
bool isUMLUniqueConstraint ()
 
bool isUMLUseCase ()
 
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 ()
 

Protected Member Functions

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

Private Member Functions

void init ()
 

Additional Inherited Members

- Public Types inherited from UMLClassifier
enum  ClassifierType { ALL = 0, CLASS, INTERFACE, DATATYPE }
 
- 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 ()
 
- 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 UMLPackage
UMLObjectList m_objects
 
- Protected Attributes inherited from UMLObject
Uml::ID::Type m_nId
 object's id More...
 
QString m_Doc
 object's documentation More...
 
QPointer< UMLStereotypem_pStereotype
 stereotype of the object if applicable More...
 
QString m_name
 objects name More...
 
ObjectType m_BaseType
 objects type More...
 
Uml::Visibility::Enum m_visibility
 objects visibility More...
 
bool m_bAbstract
 state of whether the object is abstract or not More...
 
bool m_bStatic
 flag for instance scope More...
 
bool m_bInPaste
 caller sets this true when in paste operation More...
 
bool m_bCreationWasSignalled
 auxiliary to maybeSignalObjectCreated() More...
 
QPointer< UMLObjectm_pSecondary
 
QString m_SecondaryId
 
QString m_SecondaryFallback
 
UMLObjectPrivatem_d
 private data More...
 

Detailed Description

Non-graphical Information for an Enum.

This class contains the non-graphical information required for a UML Enum. This class inherits from UMLClassifier which contains most of the information.

Author
Jonathan Riddell 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

◆ UMLEnum()

UMLEnum::UMLEnum ( const QString &  name = QString(),
Uml::ID::Type  id = Uml::ID::None 
)
explicit

Sets up an enum.

Parameters
nameThe name of the Enum.
idThe unique id of the Enum.

◆ ~UMLEnum()

UMLEnum::~UMLEnum ( )
virtual

Standard destructor.

Member Function Documentation

◆ addEnumLiteral() [1/3]

UMLObject * UMLEnum::addEnumLiteral ( const QString &  name,
Uml::ID::Type  id = Uml::ID::None,
const QString &  value = QString() 
)

Adds an enumliteral to the enum.

Parameters
nameThe name of the enumliteral.
idThe id of the enumliteral (optional.) If omitted a new ID is assigned internally.
Returns
Pointer to the UMLEnumliteral created.

◆ addEnumLiteral() [2/3]

bool UMLEnum::addEnumLiteral ( UMLEnumLiteral literal,
IDChangeLog Log = 0 
)

Adds an already created enumliteral. The enumliteral object must not belong to any other concept.

Parameters
literalPointer to the UMLEnumLiteral.
LogPointer to the IDChangeLog.
Returns
True if the enumliteral was successfully added.

◆ addEnumLiteral() [3/3]

bool UMLEnum::addEnumLiteral ( UMLEnumLiteral literal,
int  position 
)

Adds an enumliteral to the enum, at the given position. If position is negative or too large, the enumliteral is added to the end of the list. TODO: give default value -1 to position (append) - now it conflicts with the method above..

Parameters
literalPointer to the UMLEnumLiteral.
positionPosition index for the insertion.
Returns
True if the enumliteral was successfully added.

◆ clone()

UMLObject * UMLEnum::clone ( ) const
virtual

Make a clone of this object.

Reimplemented from UMLClassifier.

◆ copyInto()

void UMLEnum::copyInto ( UMLObject lhs) const
virtual

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

Reimplemented from UMLClassifier.

◆ createEnumLiteral()

UMLObject * UMLEnum::createEnumLiteral ( const QString &  name = QString())

Creates a literal for the enum.

Returns
The UMLEnum created

◆ enumLiteralAdded

void UMLEnum::enumLiteralAdded ( UMLClassifierListItem )
signal

◆ enumLiteralRemoved

void UMLEnum::enumLiteralRemoved ( UMLClassifierListItem )
signal

◆ enumLiterals()

int UMLEnum::enumLiterals ( )

Returns the number of enumliterals for the class.

Returns
The number of enumliterals for the class.

◆ init()

void UMLEnum::init ( )
private

Initializes key variables of the class.

◆ load1()

bool UMLEnum::load1 ( QDomElement &  element)
protectedvirtual

Loads the <UML:Enum> element including its enumliterals.

Reimplemented from UMLClassifier.

◆ makeChildObject()

UMLClassifierListItem * UMLEnum::makeChildObject ( const QString &  xmiTag)
virtual

Create a new ClassifierListObject (enumLiteral) according to the given XMI tag. Returns NULL if the string given does not contain one of the tags <UML:EnumLiteral> Used by the clipboard for paste operation. Reimplemented from UMLClassifier for UMLEnum

Reimplemented from UMLClassifier.

◆ operator==()

bool UMLEnum::operator== ( const UMLEnum rhs) const

Overloaded '==' operator.

◆ removeEnumLiteral()

int UMLEnum::removeEnumLiteral ( UMLEnumLiteral literal)

Removes an enumliteral from the class.

Parameters
literalThe enumliteral to remove.
Returns
Count of the remaining enumliterals after removal. Returns -1 if the given enumliteral was not found.

◆ saveToXMI1()

void UMLEnum::saveToXMI1 ( QDomDocument &  qDoc,
QDomElement &  qElement 
)
virtual

Creates the <UML:Enum> element including its enumliterals.

Reimplemented from UMLClassifier.

◆ signalEnumLiteralRemoved()

void UMLEnum::signalEnumLiteralRemoved ( UMLClassifierListItem elit)

Emit the enumLiteralRemoved signal.


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