umbrello API Documentation

UMLStereotype Class Reference

This class is used to set up information for a stereotype. Sets up stereotype information. More...

#include <stereotype.h>

Inheritance diagram for UMLStereotype:

UMLObject List of all members.

Public Member Functions

 UMLStereotype (const QString &name, Uml::IDType id=Uml::id_None)
 Sets up a stereotype.
 UMLStereotype ()
 Sets up a stereotype.
bool operator== (UMLStereotype &rhs)
 Overloaded '==' operator.
virtual ~UMLStereotype ()
 destructor
virtual void copyInto (UMLStereotype *rhs) const
 Copy the internal presentation of this object into the new object.
virtual UMLObjectclone () const
 Make a clone of this object.
void incrRefCount ()
 Increments the reference count for this stereotype.
void decrRefCount ()
 Decrements the reference count for this stereotype.
int refCount () const
 Returns the reference count for this stereotype.
void saveToXMI (QDomDocument &qDoc, QDomElement &qElement)
 Saves to the <UML:StereoType> XMI element.
bool showPropertiesDialog (QWidget *parent)
 Display the properties configuration dialog for the stereotype (just a line edit).

Protected Attributes

int m_refCount
 Each stereotype object is reference counted, i.e.

Detailed Description

This class is used to set up information for a stereotype. Sets up stereotype information.

Stereotypes are used essentially as properties of attributes and operations etc.

Author:
Jonathan Riddell

Oliver Kellogg Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org

Definition at line 28 of file stereotype.h.


Constructor & Destructor Documentation

UMLStereotype::UMLStereotype const QString &  name,
Uml::IDType  id = Uml::id_None
[explicit]
 

Sets up a stereotype.

Parameters:
name The name of this UMLStereotype.
id The unique id given to this UMLStereotype.

Definition at line 24 of file stereotype.cpp.

References UMLDoc::findStereotype(), UMLApp::getDocument(), and m_refCount.

UMLStereotype::UMLStereotype  ) 
 

Sets up a stereotype.

Definition at line 35 of file stereotype.cpp.

References m_refCount.

Referenced by clone().

UMLStereotype::~UMLStereotype  )  [virtual]
 

destructor

Definition at line 40 of file stereotype.cpp.


Member Function Documentation

bool UMLStereotype::operator== UMLStereotype rhs  ) 
 

Overloaded '==' operator.

Definition at line 42 of file stereotype.cpp.

void UMLStereotype::copyInto UMLStereotype rhs  )  const [virtual]
 

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

Definition at line 54 of file stereotype.cpp.

References UMLObject::copyInto().

Referenced by clone().

UMLObject * UMLStereotype::clone  )  const [virtual]
 

Make a clone of this object.

Implements UMLObject.

Definition at line 59 of file stereotype.cpp.

References clone(), copyInto(), and UMLStereotype().

Referenced by clone().

void UMLStereotype::incrRefCount  ) 
 

Increments the reference count for this stereotype.

Definition at line 83 of file stereotype.cpp.

References m_refCount.

Referenced by UMLObject::loadFromXMI(), and UMLObject::resolveRef().

void UMLStereotype::decrRefCount  ) 
 

Decrements the reference count for this stereotype.

Definition at line 87 of file stereotype.cpp.

References m_refCount.

Referenced by UMLObject::setUMLStereotype().

int UMLStereotype::refCount  )  const
 

Returns the reference count for this stereotype.

Definition at line 91 of file stereotype.cpp.

References m_refCount.

Referenced by UMLObject::setUMLStereotype().

void UMLStereotype::saveToXMI QDomDocument &  qDoc,
QDomElement &  qElement
[virtual]
 

Saves to the <UML:StereoType> XMI element.

Implements UMLObject.

Definition at line 68 of file stereotype.cpp.

References UMLObject::save().

bool UMLStereotype::showPropertiesDialog QWidget *  parent  ) 
 

Display the properties configuration dialog for the stereotype (just a line edit).

Definition at line 74 of file stereotype.cpp.

References UMLObject::getName(), and UMLObject::setName().


Member Data Documentation

int UMLStereotype::m_refCount [protected]
 

Each stereotype object is reference counted, i.e.

client code manages it such that it comes into existence as soon as there is at least one user, and ceases existing when the number of users drops to 0. m_refCount reflects the number of users. It is externally managed, i.e. client code must take care to call incrRefCount() and decrRefCount() as appropriate.

Definition at line 100 of file stereotype.h.

Referenced by decrRefCount(), incrRefCount(), refCount(), and UMLStereotype().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:08 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003