|
|
| DocWindow ( UMLDoc * doc, QWidget *parent = 0, const char *name = 0 )
| DocWindow |
Constructor
| ~DocWindow ()
| ~DocWindow |
Deconstructor
| void showDocumentation ( UMLObject * object, bool overwrite = false )
| showDocumentation |
Called when a widget wishes to display its documentation in the doc window. If there was already documentation there, that will be updated before being removed from the view.
Also call this function if you update the documentation in another place, such as a properties dialog. Just set overwrite to true.
Overwrite is used when you believe that the documentation window is already displaying documentation for the widget you wish to display. Overwrite just determines who's version is more up to date.
| void showDocumentation ( UMLView * view, bool overwrite = false )
| showDocumentation |
This method is the same as the one for UMLObjects except it displays documentation for a diagram.
| void showDocumentation ( UMLWidget * widget, bool overwrite = false )
| showDocumentation |
This method is the same as the one for UMLObjects except it displays documentation for an object instance (StateWidget/ ObjectWidget).
| void showDocumentation ( AssociationWidget * widget, bool overwrite = false )
| showDocumentation |
This method is the same as the one for UMLObjects except it displays documentation for an association instance (AssociationWidget).
| void updateDocumentation ( bool clear = false )
| updateDocumentation |
Call when you wish move changes in the doc window back into the members documentation.
If clear is true the doc window will display the documentation for the current project instead of the widget documentation.
This is usually called before displaying a properties dialog.
| void newDocumentation ( )
| newDocumentation |
Re-inializes the class for a new document.