class UMLDoc

Public Methods

•  UMLDoc (QWidget *parent, const char *name=0)
•  ~UMLDoc ()
• void  addView (UMLView *view)
• void  removeView (UMLView *view)
• void  setModified (bool _m=true)
• bool  isModified ()
• bool  saveModified ()
• void  deleteContents ()
• bool  newDocument ()
• void  closeDocument ()
• bool  openDocument (const KURL& url, const char *format=0)
• bool  saveDocument (const KURL& url, const char *format=0)
• const KURL&  URL () const
• void  setURL (const KURL& url)
• void  setupSignals ()
• void  setupListView (MyListView *lv)
• void  createUMLObject (UMLObject_Type type)
• void  createUMLObject (UMLObject * o, UMLObject_Type type)
• void  createDiagram (Diagram_Type type, bool askForName = true)
• void  renameDiagram (int id)
• void  renameUMLObject (UMLObject *o)
• void  renameChildUMLObject (UMLObject *o)
• void  changeCurrentView (int id)
• void  removeDiagram (int id)
• void  removeUMLObject (UMLObject*o)
• UMLObject*  findUMLObject (int id)
• UMLObject*  findUMLObject (UMLObject_Type type, QString name)
• UMLView *  findView (int id)
• UMLView *  findView (Diagram_Type type, QString name)
• int  getUniqueID ()
• void  showProperties (UMLObject *o, int page = 0, bool assoc = false)
• bool  serialize (QDataStream *s, bool archive)
• bool  saveToXMI ( QFile &file )
• bool  loadFromXMI ( QFile & file )
• bool  loadUMLObjectsFromXMI ( QDomNode & node )
• bool  loadDiagramsFromXMI ( QDomNode & node )
• void  signalChildUMLObjectUpdate (UMLObject *o)
• void  signalChildUMLObjectCreated (UMLObject *o)
• void  signalDiagramRenamed (UMLView * pView )
• void  removeAllViews ()
• void  signalUMLObjectCreated (UMLObject * o)
• void  signalUMLObjectChanged (UMLObject * o)
• void  showProperties (ObjectWidget * o)
• void  showProperties (UMLWidget * o)
• UMLView *  getCurrentView ()
• MyListView *  getListView ()
• QList<UMLConcept>  getConcepts ()
• void  print (KPrinter * pPrinter)
• const QList<UMLView> & getViewIterator () const
• bool  AddUMLObject (UMLObject* Obj)
• bool  AddUMLView (UMLViewData * pViewData )
• virtual IDChangeLog*  getChangeLog ()
• void  EndPaste ()
• void  BeginPaste ()
• int  AssignNewID (int OldID)
• DocWindow *  getDocWindow ()
• QString  getDoc ()
• void  setDoc ( QString doc )
• bool  activateView ( int viewID )
• bool  activateAllViews ()
• void  getAssciationListAllViews ( UMLView * view, UMLObject * object, AssociationWidgetDataList & list )
• void  EditCopy ()
• void  EditCut ()
• void  EditPaste ()
• bool  getPasteState ()
• bool  getCutCopyState ()
• void  addUMLObject ( UMLObject * object )
• QSplitter *  getSplitter ()
• void  settingsChanged (SettingsDlg::OptionState optionState)

Public Slots

• void  slotUpdateAllViews (UMLView *sender)
• void  slotAutoSave ()

Signals

• void  sigChildObjectChanged (UMLObject *)
• void  sigObjectChanged (UMLObject *)
• void  sigDiagramRenamed (int t)
• void  sigDiagramChanged (Uml::Diagram_Type)
• void  sigUpdateItem (int id)
• void  sigChildObjectCreated (UMLObject *)
• void  sigDiagramRemoved (int id)
• void  sigObjectRemoved (UMLObject *)
• void  sigDiagramCreated (int id)
• void  sigObjectCreated (UMLObject *)
• void  sigWidgetUpdated (UMLObject *)
• void  sigResetStatusbarProgress ()
• void  sigSetStatusbarProgressSteps (int totalSteps)
• void  sigSetStatusbarProgress (int stepPosition)
• void  sigWriteToStatusBar (const QString &text)

Public Members

• friend class ClassImport
• friend class UMLDrag
• static QList *pViewList
• InfoWidget * infoWidget
• MyListView *listView

Detailed Description

* This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * *************************************************************************

Constructor for the fileclass of the application

Destructor for the fileclass of the application

adds a view to the document which represents the document contents. Usually this is your main view.

removes a view from the list of currently connected views

sets the modified flag for the document after a modifying action on the view connected to the document.

returns if the document is modified or not. Use this to determine if your document needs saving by the user on closing.

"save modified" - asks the user for saving if the document is modified

deletes the document's contents

initializes the document generally

closes the acutal document

loads the document by filename and format and emits the updateViews() signal

saves the document under filename and format.

[const]

returns the KURL of the document

sets the URL of the document

Sets up the signals needed by the program for it to work.

Gains a link to the list view so that it can set the signals up required by this class.

Creates a UMLObject of the given type.

Parameters:

type	The type of UMLObject to create. Used to create Actors, Use Cases and concepts.

Creates either an operation or attribute for the parent concept.

Parameters:

o	The parent object
type	The type to create, either an operation or attribute.

Creates a diagram of the given type.

Parameters:

type	The type of diagram to create.
askForName	If true shows a dialog box asking for name, else uses a default name.

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.

Used to rename a UMLObject. The UMLObject is to be an actor, use case or concept.

Parameters:

o	The object to rename.

Used to rename an operation or attribute of a concept.

Parameters:

o	The attribute or operation to rename.

Changes the current view (diagram) to the view with the given ID.

Parameters:

id	The ID of the view to change to.

Deletes a diagram from the current file.

Parameters:

id	The ID of the diagram to delete.

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	The object to delete.

Used to find a reference to a UMLObject by its ID.

Parameters:

id	The UMLObject to find.

Returns: Returns a reference to the UMLObject found. If not found it returns 0.

Used to find a UMLObject by its' type and name.

Parameters:

type	The type of UMLObject to find.
name	The name of the UMLObject to find.

Returns: Returns a reference to the UMLObject found. If not found it returns 0.

Finds a view (diagram) by the ID given to method.

Parameters:

id	The ID of the view to search for.

Returns: Returns a reference to the view found. If not found returns 0.

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.

Returns: Returns a reference to the view found. If not found returns 0.

Used to give a unique ID to any sort of object.

Returns: Returns a unique ID.

This method is called if you wish to see the properties of a UMLObject. A dialog box will be displayed from which you can change the objects properties.

Parameters:

o	The object to show properties for.
page	The page to show.
assoc	Whether to show association page.

Use to save or load this classes information

Parameters:

s	Pointer to the datastream (file) to save/load from.
archive	If true will save the classes information, else will load the information.

This method is called when a child UMLObject has been updated. This will cause the document to emit the relevant signals.

Parameters:

o	The object that has been updated.

This method is called when a child UMLObject has been created. This will cause the document to emit the relevant signals.

Parameters:

o	The object that has been created.

Signal a view/diagram has been renamed.

Call to remove all the views (diagrams) in the current file.

Signal that a UMLObject has been created.

Parameters:

o	The object that has been created.

Signal that a UMLObject has been changed.

Parameters:

o	The object that has been changed.

Show a properties dialog for an ObjectWidget.

Parameters:

o	The ObjectWidget to represent.

Show a properties dialog for an UMLWidget.

Parameters:

o	The UMLWidget to represent.

Returns the current view.

Returns: Returns the current view.

Returns the list view.

Returns: Returns the list view.

Returns a list of concepts

Returns: Returns a list of concepts

Controls the printing of the program.

Parameters:

pPrinter

The printer (object) to use.

[const]

Return the list of views for this document

Adds an already created UMLObject 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, 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

[virtual]

Read property of IDChangeLog* m_pChangeLog.

Closes a Paste session, Deletes the ChangeLog

Opens a Paste session, Deletes the Old ChangeLog and Creates an empty one

Assigns a New ID to an Object, and also logs the assignment to its internal ChangeLog

Returns the document window.

Returns the documentation for the project.

Sets the documentation for the project.

Activate a diagram after loading a new document

Parameters:

viewID

View's ID to Activate

Returns: Return true on success Activation

Activate all the diagrams/views after loading so all their widgets keep their ids.

Puts into the list variable a list of associations on all diagrams that contain the given object. The view is given so it doesn't check it's association list to save time.

Passes onto UMLApp that an event equivalent to edit copy has occured.

Passes onto UMLApp that an event equivalent to edit cut has occured.

Passes onto UMLApp that an event equivalent to edit paste has occured.

Returns the paste state

Returns the state on Cut/Copy

Adds a UMLObject thats already created but doesn't change any ids or signal. Used by the list view. Use the other AddUMLObject if pasting.

Returns the splitter widget used between the views and the listview.

Sets the default settings to the given settings.

[slot]

calls repaint() on all views connected to the document object and is called by the view by which the document has been changed. As this view normally repaints itself, it is excluded from the paintEvent.

[slot]

Called after a specified time to autosave the document.

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

[signal]

Reset the status bar

[signal]

[signal]

[signal]

Write text to the status bar