KDE 4.0 API Reference umbrello/umbrello
UMLDoc Class Reference
#include <umldoc.h>
Detailed Description
UMLDoc provides a document object for a document-view model.The UMLDoc class provides a document object that can be used in conjunction with the classes UMLApp and UMLView to create a document-view model for standard KDE applications based on KApplication and KMainWindow. Thereby, the document object is created by the UMLApp instance and contains the document structure with the according methods for manipulation of the document data by UMLView objects. Also, UMLDoc contains the methods for serialization of the document data from and to files.
Definition at line 66 of file umldoc.h.
Constructor & Destructor Documentation
| UMLDoc::UMLDoc | ( | ) |
| UMLDoc::~UMLDoc | ( | ) |
Member Function Documentation
| void UMLDoc::init | ( | ) |
Initialize the UMLDoc.
To be called after the constructor, before anything else.
Definition at line 101 of file umldoc.cpp.
| void UMLDoc::addView | ( | UMLView * | view | ) |
Adds a view to the document which represents the document contents.
Usually this is your main view.
- Parameters:
-
view Pointer to the UMLView to add.
Definition at line 139 of file umldoc.cpp.
| void UMLDoc::removeView | ( | UMLView * | view, | |
| bool | enforceOneView = true | |||
| ) |
Removes a view from the list of currently connected views.
- Parameters:
-
view Pointer to the UMLView to remove. enforceOneView switch to determine if we have a current view or not. most of the time, we DO want this, except when exiting the program.
Definition at line 165 of file umldoc.cpp.
| void UMLDoc::setMainViewID | ( | Uml::IDType | viewID | ) |
| void UMLDoc::setModified | ( | bool | _m = true |
) |
Sets the modified flag for the document after a modifying action on the view connected to the document.
- Parameters:
-
_m The value to set the modified flag to.
Definition at line 1928 of file umldoc.cpp.
| bool UMLDoc::isModified | ( | ) | [inline] |
| bool UMLDoc::saveModified | ( | ) |
"save modified" - Asks the user for saving if the document is modified.
- Returns:
- True if document can be closed.
Definition at line 219 of file umldoc.cpp.
| bool UMLDoc::newDocument | ( | ) |
Initializes the document generally.
- Returns:
- True if operation successful.
Definition at line 307 of file umldoc.cpp.
| void UMLDoc::closeDocument | ( | ) |
| bool UMLDoc::openDocument | ( | const KUrl & | url, | |
| const char * | format = 0 | |||
| ) |
Loads the document by filename and format and emits the updateViews() signal.
- Parameters:
-
url The filename in KUrl format. format The format (optional.)
- Returns:
- True if operation successful.
Definition at line 332 of file umldoc.cpp.
| bool UMLDoc::saveDocument | ( | const KUrl & | url, | |
| const char * | format = 0 | |||
| ) |
Saves the document using the given filename and format.
- Parameters:
-
url The filename in KUrl format. format The format (optional.)
- Returns:
- True if operation successful.
insert some checks in saveToXMI to detect a failed save attempt
Definition at line 501 of file umldoc.cpp.
| const KUrl & UMLDoc::url | ( | ) | const |
Returns the KUrl of the document.
- Returns:
- The KUrl of this UMLDoc.
Definition at line 215 of file umldoc.cpp.
| void UMLDoc::setUrl | ( | const KUrl & | url | ) |
Sets the URL of the document.
- Parameters:
-
url The KUrl to set.
Definition at line 210 of file umldoc.cpp.
| void UMLDoc::setupSignals | ( | ) |
Sets up the signals needed by the program for it to work.
Definition at line 650 of file umldoc.cpp.
| bool UMLDoc::isUnique | ( | const QString & | name | ) |
Returns true if the given name is unique within its scope.
- Parameters:
-
name The name to check.
- Returns:
- True if name is unique.
Definition at line 769 of file umldoc.cpp.
| bool UMLDoc::isUnique | ( | const QString & | name, | |
| UMLPackage * | package | |||
| ) |
Returns true if the given name is unique within its scope of given package.
- Parameters:
-
name The name to check. package The UMLPackage in which we have to determine the unique-ness
- Returns:
- True if name is unique.
Definition at line 804 of file umldoc.cpp.
| UMLStereotype * UMLDoc::findOrCreateStereotype | ( | const QString & | name | ) |
| UMLAssociation * UMLDoc::createUMLAssociation | ( | UMLObject * | a, | |
| UMLObject * | b, | |||
| Uml::Association_Type | type | |||
| ) |
Creates an association between two UMLObjects.
NOTE: this method does not check if the association is valid / legal
- Parameters:
-
a The UMLObject "A" for the association (source) b The UMLObject "B" for the association (destination) type The association's type
- Returns:
- The Association created
Definition at line 878 of file umldoc.cpp.
| void UMLDoc::addAssociation | ( | UMLAssociation * | pAssoc | ) |
Adds an association.
- Parameters:
-
pAssoc Pointer to the UMLAssociation to add.
Definition at line 889 of file umldoc.cpp.
| void UMLDoc::removeAssociation | ( | UMLAssociation * | pAssoc, | |
| bool | doSetModified = true | |||
| ) |
Removes an association.
- Parameters:
-
pAssoc Pointer to the UMLAssociation to remove. doSetModified Whether to mark the document as modified (default: true.)
Definition at line 840 of file umldoc.cpp.
| UMLAssociation * UMLDoc::findAssociation | ( | Uml::Association_Type | assocType, | |
| const UMLObject * | roleAObj, | |||
| const UMLObject * | roleBObj, | |||
| bool * | swap = NULL | |||
| ) |
Finds an association.
- Parameters:
-
assocType Type of the UMLAssociation to seek. roleAObj Pointer to the role A UMLCanvasObject. roleBObj Pointer to the role B UMLCanvasObject. swap Optional pointer to boolean. The bool is set to true if the assocation matched with swapped roles, else it is set to false.
- Returns:
- Pointer to the UMLAssociation found or NULL if not found.
Definition at line 856 of file umldoc.cpp.
| UMLView * UMLDoc::createDiagram | ( | UMLFolder * | folder, | |
| Uml::Diagram_Type | type, | |||
| bool | askForName = true | |||
| ) |
Creates a diagram of the given type.
- Parameters:
-
folder The folder in which tp create the diagram. type The type of diagram to create. askForName If true shows a dialog box asking for name, else uses a default name.
- Returns:
- Pointer to the UMLView of the new diagram.
Definition at line 966 of file umldoc.cpp.
| void UMLDoc::removeUMLObject | ( | UMLObject * | o | ) |
Removes an UMLObject from the current file.
If this object is being represented on a diagram it will also delete all those representations.
- Parameters:
-
o Pointer to the UMLObject to delete.
Definition at line 1128 of file umldoc.cpp.
| void UMLDoc::renameDiagram | ( | Uml::IDType | id | ) |
Used to rename a document.
This method takes care of everything. You just need to give the ID of the diagram to the method.
- Parameters:
-
id The ID of the diagram to rename.
Definition at line 1001 of file umldoc.cpp.
| void UMLDoc::renameUMLObject | ( | UMLObject * | o | ) |
Used to rename a UMLObject.
The UMLObject is to be an actor, use case or concept.
- Parameters:
-
o The object to rename.
Definition at line 1026 of file umldoc.cpp.
| void UMLDoc::renameChildUMLObject | ( | UMLObject * | o | ) |
Used to rename an operation or attribute of a concept.
- Parameters:
-
o The attribute or operation to rename.
Definition at line 1046 of file umldoc.cpp.
| void UMLDoc::changeCurrentView | ( | Uml::IDType | id | ) |
Changes the current view (diagram) to the view with the given ID.
- Parameters:
-
id The ID of the view to change to.
Definition at line 1076 of file umldoc.cpp.
| void UMLDoc::removeDiagram | ( | Uml::IDType | id | ) |
Deletes a diagram from the current file.
- Parameters:
-
id The ID of the diagram to delete.
Definition at line 1088 of file umldoc.cpp.
| UMLObject * UMLDoc::findObjectById | ( | Uml::IDType | id | ) |
Used to find a reference to a UMLObject by its ID.
- Parameters:
-
id The UMLObject to find.
- Returns:
- Pointer to the UMLObject found, or NULL if not found.
Definition at line 676 of file umldoc.cpp.
| UMLObject * UMLDoc::findUMLObject | ( | const QString & | name, | |
| Uml::Object_Type | type = Uml::ot_UMLObject, |
|||
| UMLObject * | currentObj = NULL | |||
| ) |
Used to find a UMLObject by its type and name.
- Parameters:
-
name The name of the UMLObject to find. type Object_Type of the object to find (optional.) When the given type is ot_UMLObject the type is disregarded, i.e. the given name is the only search criterion. currentObj Object relative to which to search (optional.) If given then the enclosing scope(s) of this object are searched before the global scope.
- Returns:
- Pointer to the UMLObject found, or NULL if not found.
Definition at line 697 of file umldoc.cpp.
| UMLClassifier * UMLDoc::findUMLClassifier | ( | const QString & | name | ) |
Used to find a UMLClassifier by its name.
- Parameters:
-
name The name of the UMLObject to find.
Definition at line 715 of file umldoc.cpp.
| UMLStereotype * UMLDoc::findStereotype | ( | const QString & | name | ) |
Finds a UMLStereotype by its name.
- Parameters:
-
name The name of the UMLStereotype to find.
- Returns:
- Pointer to the UMLStereotype found, or NULL if not found.
Definition at line 822 of file umldoc.cpp.
| UMLView * UMLDoc::findView | ( | Uml::IDType | id | ) |
Finds a view (diagram) by the ID given to method.
- Parameters:
-
id The ID of the view to search for.
- Returns:
- Pointer to the view found, or NULL if not found.
Definition at line 660 of file umldoc.cpp.
| UMLView * UMLDoc::findView | ( | Uml::Diagram_Type | type, | |
| const QString & | name, | |||
| bool | searchAllScopes = false | |||
| ) |
Finds a view (diagram) 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: false.)
- Returns:
- Pointer to the view found, or NULL if not found.
Definition at line 670 of file umldoc.cpp.
| void UMLDoc::setName | ( | const QString & | name | ) |
| QString UMLDoc::getName | ( | ) | const |
| Uml::IDType UMLDoc::getModelID | ( | ) | const |
Return the m_modelID (currently this a fixed value: Umbrello supports only a single document.
)
Definition at line 1201 of file umldoc.cpp.
| void UMLDoc::saveToXMI | ( | QIODevice & | file | ) | [virtual] |
This method is called for saving the given model as a XMI file.
It is virtual and calls the corresponding saveToXMI() functions of the derived classes.
- Parameters:
-
file The file to be saved to.
bugs.kde.org/56184 comment by M. Alanen 2004-12-19: " XMI.model requires xmi.version. (or leave the whole XMI.model out, it's not required) " QDomElement model = doc.createElement( "XMI.model" ); QFile* qfile = dynamic_cast<QFile*>(&file); if (qfile) { QString modelName = qfile->name(); modelName = modelName.section('/', -1 ); modelName = modelName.section('.', 0, 0); model.setAttribute( "xmi.name", modelName ); model.setAttribute( "href", qfile->name() ); }
See comment on <XMI.model> above header.appendChild( model );
Definition at line 1205 of file umldoc.cpp.
| short UMLDoc::getEncoding | ( | QIODevice & | file | ) |
Checks the given XMI file if it was saved with correct Unicode encoding set or not.
- Parameters:
-
file The file to be checked.
Definition at line 1344 of file umldoc.cpp.
| bool UMLDoc::loadFromXMI | ( | QIODevice & | file, | |
| short | encode = ENC_UNKNOWN | |||
| ) | [virtual] |
Load a given XMI model from a file.
If the encoding of the file is already known it can be passed to the function. If this info isn't given, loadFromXMI will check which encoding was used.
- Parameters:
-
file The file to be loaded. encode The encoding used.
Definition at line 1419 of file umldoc.cpp.
| bool UMLDoc::validateXMIHeader | ( | QDomNode & | headerNode | ) |
Ensures the XMI file is a valid UML file.
Currently only checks for metamodel=UML.
- Parameters:
-
headerNode The <XMI.header> node
Definition at line 1599 of file umldoc.cpp.
| bool UMLDoc::loadUMLObjectsFromXMI | ( | QDomElement & | element | ) |
Loads all UML objects from XMI into the current UMLDoc.
- Returns:
- True if operation successful.
Definition at line 1616 of file umldoc.cpp.
| void UMLDoc::loadExtensionsFromXMI | ( | QDomNode & | node | ) |
Loads umbrello specific extensions from XMI to the UMLDoc.
The extension tags are: "docsettings", "diagrams", "listview", and "codegeneration".
Definition at line 1731 of file umldoc.cpp.
| bool UMLDoc::loadDiagramsFromXMI | ( | QDomNode & | node | ) |
Loads all diagrams from XMI into the current UMLDoc.
- Returns:
- True if operation successful.
Definition at line 1788 of file umldoc.cpp.
| void UMLDoc::signalDiagramRenamed | ( | UMLView * | pView | ) |
| void UMLDoc::removeAllViews | ( | ) |
Call to remove all the views (diagrams) in the current file.
Definition at line 1834 of file umldoc.cpp.
| void UMLDoc::signalUMLObjectCreated | ( | UMLObject * | o | ) |
Signal that a UMLObject has been created.
- Parameters:
-
o The object that has been created.
Definition at line 1183 of file umldoc.cpp.
| UMLFolder* UMLDoc::getDatatypeFolder | ( | ) | [inline] |
| UMLClassifierList UMLDoc::getConcepts | ( | bool | includeNested = true |
) |
Returns a list of the concepts in this UMLDoc.
- Parameters:
-
includeNested Whether to include the concepts from nested packages (default: true.)
- Returns:
- List of UML concepts.
Definition at line 1851 of file umldoc.cpp.
| UMLClassifierList UMLDoc::getClasses | ( | bool | includeNested = true |
) |
Returns a list of the classes in this UMLDoc.
- Parameters:
-
includeNested Whether to include the concepts from nested packages (default: true.)
- Returns:
- List of UML classes.
Definition at line 1857 of file umldoc.cpp.
| UMLClassifierList UMLDoc::getClassesAndInterfaces | ( | bool | includeNested = true |
) |
Returns a list of the classes and interfaces in this UMLDoc.
- Parameters:
-
includeNested Whether to include the concepts from nested packages (default: true.)
- Returns:
- List of UML concepts.
Definition at line 1863 of file umldoc.cpp.
| UMLEntityList UMLDoc::getEntities | ( | bool | includeNested = true |
) |
Returns a list of the entities in this UMLDoc.
- Parameters:
-
includeNested Whether to include the entities from nested packages (default: true.)
- Returns:
- List of UML Entities.
Definition at line 1869 of file umldoc.cpp.
| UMLClassifierList UMLDoc::getInterfaces | ( | bool | includeNested = true |
) |
Returns a list of the interfaces in this UMLDoc.
- Parameters:
-
includeNested Whether to include the concepts from nested packages (default: true.)
- Returns:
- List of UML interfaces.
Definition at line 1875 of file umldoc.cpp.
| UMLClassifierList UMLDoc::getDatatypes | ( | ) |
Returns a list of the datatypes in this UMLDoc.
- Returns:
- List of datatypes.
Definition at line 1881 of file umldoc.cpp.
| UMLAssociationList UMLDoc::getAssociations | ( | ) |
Returns a list of the associations in this UMLDoc.
- Returns:
- List of UML associations.
Definition at line 1892 of file umldoc.cpp.
| UMLPackageList UMLDoc::getPackages | ( | bool | includeNested = true |
) |
Returns a list of the packages in this UMLDoc,.
- Returns:
- List of UMLPackages.
Definition at line 1844 of file umldoc.cpp.
| void UMLDoc::print | ( | QPrinter * | pPrinter, | |
| DiagramPrintPage * | selectPage | |||
| ) |
Controls the printing of the program.
- Parameters:
-
pPrinter The printer (object) to use.
Definition at line 1903 of file umldoc.cpp.
| UMLViewList UMLDoc::getViewIterator | ( | ) |
Return the list of views for this document.
- Returns:
- List of UML views.
Definition at line 1921 of file umldoc.cpp.
| bool UMLDoc::assignNewIDs | ( | UMLObject * | Obj | ) |
Assigns an already created UMLObject a new ID.
If the object is a classifier then the operations/attributes are also assigned new IDs.
- Parameters:
-
Obj Pointer to the UMLObject to add.
- Returns:
- True if operation successful.
Definition at line 1935 of file umldoc.cpp.
| bool UMLDoc::addUMLObject | ( | UMLObject * | object | ) |
Adds a UMLObject thats already created but doesn't change any ids or signal.
Adds a UMLObject thats already created but doesn't change any ids or signal.
Use AddUMLObjectPaste if pasting.
- Parameters:
-
object The object to add.
- Returns:
- True if the object was actually added.
Definition at line 726 of file umldoc.cpp.
| bool UMLDoc::addUMLView | ( | UMLView * | pView | ) |
Adds an already created UMLView to the document, it gets assigned a new ID, if its name is already in use then the function appends a number to it to differentiate it from the others; this number is incremental so if number 1 is in use then it tries 2 and then 3 and so on.
Adds an already created UMLView to the document, it gets assigned a new ID.
- Parameters:
-
pView Pointer to the UMLView to add.
- Returns:
- True if operation successful.
Definition at line 2028 of file umldoc.cpp.
| UMLFolder * UMLDoc::getRootFolder | ( | Uml::Model_Type | mt | ) |
| Uml::Model_Type UMLDoc::rootFolderType | ( | UMLObject * | obj | ) |
Return the corresponding Model_Type if the given object is one of the root folders.
When the given object is not one of the root folders then return Uml::N_MODELTYPES.
Definition at line 1980 of file umldoc.cpp.
| UMLFolder * UMLDoc::currentRoot | ( | ) |
Return the currently selected root folder.
This will be an element from the m_root[] array.
Definition at line 1109 of file umldoc.cpp.
| void UMLDoc::setCurrentRoot | ( | Uml::Model_Type | rootType | ) |
Set the current root folder.
- Parameters:
-
rootType The type of the root folder to set. The element from m_root[] which is indexed by this type is selected.
Definition at line 1124 of file umldoc.cpp.
| IDChangeLog * UMLDoc::getChangeLog | ( | ) | [virtual] |
Read property of IDChangeLog* m_pChangeLog.
- Returns:
- Pointer to the IDChangeLog object.
Definition at line 1990 of file umldoc.cpp.
| void UMLDoc::endPaste | ( | ) |
Closes a paste session, deletes the ChangeLog.
Closes a Paste session, Deletes the ChangeLog.
Definition at line 2007 of file umldoc.cpp.
| void UMLDoc::beginPaste | ( | ) |
Opens a Paste session, deletes the old ChangeLog and creates an empty one.
Opens a Paste session, Deletes the Old ChangeLog and Creates an empty one.
Definition at line 1997 of file umldoc.cpp.
| Uml::IDType UMLDoc::assignNewID | ( | Uml::IDType | OldID | ) |
Assigns a New ID to an Object, and also logs the assignment to its internal ChangeLog.
Assigns a New ID to an Object, and also logs the assignment to its internal ChangeLog.
- Parameters:
-
OldID The present ID of the object.
- Returns:
- The new ID assigned to the object.
Definition at line 2016 of file umldoc.cpp.
| QString UMLDoc::getDocumentation | ( | ) | const [inline] |
| void UMLDoc::setDocumentation | ( | const QString & | doc | ) | [inline] |
| void UMLDoc::activateAllViews | ( | ) |
Activate all the diagrams/views after loading so all their widgets keep their IDs.
Definition at line 2051 of file umldoc.cpp.
| void UMLDoc::settingsChanged | ( | Settings::OptionState | optionState | ) |
| int UMLDoc::getFileVersion | ( | void | ) | [inline] |
| QString UMLDoc::uniqViewName | ( | const Uml::Diagram_Type | type | ) |
Returns a name for the new object, appended with a number if the default name is taken e.g.
class diagram, class diagram_1 etc
Definition at line 924 of file umldoc.cpp.
| bool UMLDoc::loading | ( | ) | const |
| void UMLDoc::setLoading | ( | bool | state = true |
) |
| bool UMLDoc::closing | ( | ) | const |
| void UMLDoc::addDefaultDatatypes | ( | ) |
Calls the active code generator to create its default datatypes.
Definition at line 2131 of file umldoc.cpp.
| void UMLDoc::createDatatype | ( | const QString & | name | ) |
Add a datatype if it doesn't already exist.
Used by code generators and attribute dialog.
Definition at line 2143 of file umldoc.cpp.
| UMLStereotype * UMLDoc::findStereotypeById | ( | Uml::IDType | id | ) |
| void UMLDoc::addStereotype | ( | UMLStereotype * | s | ) |
| void UMLDoc::removeStereotype | ( | UMLStereotype * | s | ) |
| void UMLDoc::addDefaultStereotypes | ( | ) |
Add a stereotype if it doesn't already exist.
Used by code generators, operations and attribute dialog.
Definition at line 2219 of file umldoc.cpp.
| const UMLStereotypeList & UMLDoc::getStereotypes | ( | ) |
Returns a list of the stereotypes in this UMLDoc.
- Returns:
- List of UML stereotypes.
Definition at line 2225 of file umldoc.cpp.
| void UMLDoc::writeToStatusBar | ( | const QString & | text | ) |
| void UMLDoc::resolveTypes | ( | ) |
| ListPopupMenu::Menu_Type UMLDoc::getPopupMenuSelection | ( | QAction * | action | ) |
Find and return the user selected type of the popup menu.
See also m_pTabPopupMenu and slotDiagramPopupMenu
Definition at line 2210 of file umldoc.cpp.
| void UMLDoc::slotRemoveUMLObject | ( | UMLObject * | o | ) | [slot] |
Definition at line 759 of file umldoc.cpp.
| void UMLDoc::slotAutoSave | ( | ) | [slot] |
Make a popup menu for the tabs signalled from tabWidget's contextMenu().
Definition at line 2153 of file umldoc.cpp.
| void UMLDoc::sigDiagramCreated | ( | Uml::IDType | id | ) | [signal] |
| void UMLDoc::sigDiagramRemoved | ( | Uml::IDType | id | ) | [signal] |
| void UMLDoc::sigDiagramRenamed | ( | Uml::IDType | t | ) | [signal] |
| void UMLDoc::sigDiagramChanged | ( | Uml::Diagram_Type | ) | [signal] |
| void UMLDoc::sigObjectCreated | ( | UMLObject * | ) | [signal] |
| void UMLDoc::sigObjectRemoved | ( | UMLObject * | ) | [signal] |
| void UMLDoc::sigResetStatusbarProgress | ( | ) | [signal] |
Reset the status bar.
| void UMLDoc::sigSetStatusbarProgressSteps | ( | int | totalSteps | ) | [signal] |
Set the total range of the progressbar.
- Parameters:
-
totalSteps Total range of the progressbar (0..totalSteps)
| void UMLDoc::sigSetStatusbarProgress | ( | int | stepPosition | ) | [signal] |
Set the progress position of the progressbar.
- Parameters:
-
stepPosition The step position to set.
| void UMLDoc::sigWriteToStatusBar | ( | const QString & | text | ) | [signal] |
Write text to the status bar.
| void UMLDoc::sigCurrentViewChanged | ( | ) | [signal] |
The diagram being displayed has changed.
UMLApp uses this to keep its menu items state up to date.
The documentation for this class was generated from the following files:
