umbrello/umbrello
#include <folder.h>
Protected Member Functions | |
bool | load (QDomElement &element) |
bool | loadDiagramsFromXMI (QDomNode &diagrams) |
bool | loadFolderFile (const QString &path) |
void | save (QDomDocument &qDoc, QDomElement &qElement) |
void | saveContents (QDomDocument &qDoc, QDomElement &qElement) |
Protected Member Functions inherited from UMLObject | |
void | init () |
void | maybeSignalObjectCreated () |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Friends | |
QDebug | operator<< (QDebug out, const UMLFolder &item) |
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_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 } |
Public Slots inherited from UMLObject | |
void | emitModified () |
Signals inherited from UMLCanvasObject | |
void | sigAssociationEndAdded (UMLAssociation *assoc) |
void | sigAssociationEndRemoved (UMLAssociation *assoc) |
Signals inherited from UMLObject | |
void | modified () |
Static Public Member Functions inherited from UMLObject | |
static QString | toString (ObjectType ot) |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Protected Attributes inherited from UMLPackage | |
UMLObjectList | m_objects |
Protected Attributes inherited from UMLCanvasObject | |
UMLObjectList | m_List |
Protected Attributes inherited from UMLObject | |
bool | m_bAbstract |
ObjectType | m_BaseType |
bool | m_bCreationWasSignalled |
bool | m_bInPaste |
bool | m_bStatic |
QString | m_Doc |
QString | m_name |
Uml::ID::Type | m_nId |
UMLObject * | m_pSecondary |
UMLStereotype * | m_pStereotype |
UMLPackage * | m_pUMLPackage |
QString | m_SecondaryFallback |
QString | m_SecondaryId |
Uml::Visibility::Enum | m_visibility |
Properties inherited from QObject | |
objectName | |
Detailed Description
This class manages the UMLObjects and UMLViews of a Folder.
This class inherits from UMLPackage which contains most of the information.
The UMLDoc class allocates a fixed instance of this class for each of the predefined Logical, UseCase, Component, Deployment, and Entity-Relationship folders. Further instances are created on demand for user folders.
Non-graphical management of objects and diagrams of a Folder
TODO: This whole class needs a relook regarding view/scene.
Constructor & Destructor Documentation
|
explicit |
Sets up a Folder.
- Parameters
-
name The name of the Folder. id The unique id of the Folder. A new ID will be generated if this argument is left away.
Definition at line 37 of file folder.cpp.
|
virtual |
Empty destructor.
Definition at line 47 of file folder.cpp.
Member Function Documentation
void UMLFolder::activateViews | ( | ) |
Acivate the views in this folder.
"Activation": Some widgets require adjustments after loading from file, those are done here.
Definition at line 126 of file folder.cpp.
void UMLFolder::addView | ( | UMLView * | view | ) |
Add a view to the diagram list.
Definition at line 86 of file folder.cpp.
void UMLFolder::appendViews | ( | UMLViewList & | viewList, |
bool | includeNested = true |
||
) |
Append the views in this folder to the given diagram list.
- Parameters
-
viewList The UMLViewList to which to append the diagrams. includeNested Whether to include diagrams from nested folders (default: true.)
Definition at line 106 of file folder.cpp.
|
virtual |
Make a clone of this object.
Reimplemented from UMLPackage.
Definition at line 56 of file folder.cpp.
UMLView * UMLFolder::findView | ( | Uml::ID::Type | id | ) |
Seek a view of the given ID in this folder.
- Parameters
-
id ID of the view to find.
- Returns
- Pointer to the view if found, NULL if no view found.
Definition at line 152 of file folder.cpp.
UMLView * UMLFolder::findView | ( | Uml::DiagramType::Enum | type, |
const QString & | name, | ||
bool | searchAllScopes = true |
||
) |
Seek a view by the type and name given.
- Parameters
-
type The type of view to find. name The name of the view to find. searchAllScopes Search in all subfolders (default: true.)
- Returns
- Pointer to the view found, or NULL if not found.
Definition at line 183 of file folder.cpp.
QString UMLFolder::folderFile | ( | ) | const |
Get the folder file name for a separate submodel.
Definition at line 255 of file folder.cpp.
|
protectedvirtual |
Loads the owned elements of the <UML:Model>.
Reimplemented from UMLPackage.
Definition at line 447 of file folder.cpp.
|
protected |
Auxiliary to load(): Load the diagrams from the "diagrams" in the <XMI.extension>
Definition at line 371 of file folder.cpp.
|
protected |
Folders in the listview can be marked such that their contents are saved to a separate file.
This method loads the separate folder file. CAVEAT: This is not XMI standard compliant. If standard compliance is an issue then avoid folder files.
- Parameters
-
path Fully qualified file name, i.e. absolute directory plus file name.
- Returns
- True for success.
Definition at line 406 of file folder.cpp.
QString UMLFolder::localName | ( | ) | const |
Return the localized name of this folder.
Only useful for the predefined root folders.
Definition at line 78 of file folder.cpp.
void UMLFolder::removeAllViews | ( | ) |
Remove all views in this folder.
Definition at line 221 of file folder.cpp.
void UMLFolder::removeView | ( | UMLView * | view | ) |
Remove a view from the diagram list.
Definition at line 94 of file folder.cpp.
|
protected |
Auxiliary to saveToXMI(): Creates a <UML:Model> element when saving a predefined modelview, or a <UML:Package> element when saving a user created folder.
Invokes saveContents() with the newly created element.
Definition at line 300 of file folder.cpp.
|
protected |
Auxiliary to saveToXMI(): Save the contained objects and diagrams.
Can be used regardless of whether saving to the main model file or to an external folder file (see m_folderFile.)
Definition at line 265 of file folder.cpp.
|
virtual |
Creates a UML:Model or UML:Package element: UML:Model is created for the predefined fixed folders, UML:Package with stereotype "folder" is created for all else.
Reimplemented from UMLPackage.
Definition at line 318 of file folder.cpp.
void UMLFolder::setFolderFile | ( | const QString & | fileName | ) |
Set the folder file name for a separate submodel.
Definition at line 247 of file folder.cpp.
void UMLFolder::setLocalName | ( | const QString & | localName | ) |
Set the localized name of this folder.
This is set for the predefined root views (Logical, UseCase, Component, Deployment, EntityRelationship, and the Datatypes folder inside the Logical View.)
Definition at line 69 of file folder.cpp.
void UMLFolder::setViewOptions | ( | const Settings::OptionState & | optionState | ) |
Set the options for the views in this folder.
Definition at line 210 of file folder.cpp.
Friends And Related Function Documentation
Overloading operator for debugging output.
Definition at line 538 of file folder.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:40:29 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.