DocWindow Class Reference

#include <docwindow.h>

List of all members.

Public Slots

void slotAssociationRemoved (AssociationWidget *association)

An association was removed from the UMLView.

void slotWidgetRemoved (UMLWidget *widget)

A widget was removed from the UMLView.

Public Member Functions

DocWindow (UMLDoc *doc, QWidget *parent=0, const char *name=0)

Constructor.

~DocWindow ()

Deconstructor.

void showDocumentation (UMLObject *object, bool overwrite=false)

Called when a widget wishes to display its documentation in the doc window.

void showDocumentation (UMLView *view, bool overwrite=false)

This method is the same as the one for UMLObjects except it displays documentation for a diagram.

void showDocumentation (UMLWidget *widget, bool overwrite=false)

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)

This method is the same as the one for UMLObjects except it displays documentation for an association instance (AssociationWidget).

void updateDocumentation (bool clear=false, bool startup=false)

Call when you wish move changes in the doc window back into the members documentation.

void newDocumentation ()

Re-initializes the class for a new document.

bool isTyping ()

Checks if the user is typing in the documentation edit window.

Detailed Description

Author:: Paul Hensgen Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org

Definition at line 30 of file docwindow.h.

Constructor & Destructor Documentation

DocWindow::DocWindow ( UMLDoc * doc,

QWidget * parent = 0,

const char * name = 0

) [explicit]

Constructor.

Definition at line 29 of file docwindow.cpp.
References updateDocumentation().

DocWindow::~DocWindow ( )

Deconstructor.

Definition at line 54 of file docwindow.cpp.

Member Function Documentation

void DocWindow::showDocumentation ( UMLObject * object,

bool overwrite = false

)

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 whose version is more up to date.
Definition at line 56 of file docwindow.cpp.
References UMLDoc::getDocumentation(), AssociationWidget::setText(), and updateDocumentation().
Referenced by UMLListView::moveObject(), UMLListView::popupMenuSel(), UMLWidget::showProperties(), UMLObject::showProperties(), StateWidget::showProperties(), ObjectWidget::showProperties(), ActivityWidget::showProperties(), and UMLListView::slotObjectCreated().

void DocWindow::showDocumentation ( UMLView * view,

bool overwrite = false

)

This method is the same as the one for UMLObjects except it displays documentation for a diagram.

Definition at line 145 of file docwindow.cpp.
References UMLDoc::getDocumentation(), AssociationWidget::setText(), and updateDocumentation().

void DocWindow::showDocumentation ( UMLWidget * widget,

bool overwrite = false

)

This method is the same as the one for UMLObjects except it displays documentation for an object instance (StateWidget/ ObjectWidget).

Definition at line 160 of file docwindow.cpp.
References UMLDoc::getDocumentation(), and updateDocumentation().

void DocWindow::showDocumentation ( AssociationWidget * widget,

bool overwrite = false

)

This method is the same as the one for UMLObjects except it displays documentation for an association instance (AssociationWidget).

Definition at line 175 of file docwindow.cpp.
References UMLDoc::getDocumentation(), and updateDocumentation().

void DocWindow::updateDocumentation ( bool clear = false,

bool startup = false

)

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.

Parameters:

clear If true, show the documentation of current project

startup If true, no setModified(true) calls will be done and nothing is pushed to the undo stack

Definition at line 72 of file docwindow.cpp.
References UMLDoc::getDocumentation(), and UMLDoc::setDocumentation().
Referenced by DocWindow(), UMLListView::popupMenuSel(), UMLDoc::removeDiagram(), UMLDoc::removeUMLObject(), showDocumentation(), UMLWidget::showProperties(), UMLObject::showProperties(), StateWidget::showProperties(), ObjectWidget::showProperties(), ActivityWidget::showProperties(), slotAssociationRemoved(), UMLListView::slotDiagramRemoved(), UMLListView::slotObjectRemoved(), and slotWidgetRemoved().

void DocWindow::newDocumentation ( )

Re-initializes the class for a new document.

Definition at line 190 of file docwindow.cpp.
References UMLDoc::getDocumentation(), and AssociationWidget::setText().
Referenced by UMLDoc::closeDocument().

bool DocWindow::isTyping ( )

Checks if the user is typing in the documentation edit window.

Definition at line 199 of file docwindow.cpp.

void DocWindow::slotAssociationRemoved ( AssociationWidget * association ) [slot]

An association was removed from the UMLView.
If the association removed was the association which documentation is being shown, m_pAssocWidget is set to 0.
Definition at line 207 of file docwindow.cpp.
References WidgetBase::getUMLObject(), and updateDocumentation().

void DocWindow::slotWidgetRemoved ( UMLWidget * widget ) [slot]

A widget was removed from the UMLView.
If the association removed was the association which documentation is being shown, m_pUMLWidget is set to 0.
Definition at line 217 of file docwindow.cpp.
References WidgetBase::getUMLObject(), and updateDocumentation().

The documentation for this class was generated from the following files:


Public Slots
void	slotAssociationRemoved (AssociationWidget *association)
	An association was removed from the UMLView.
void	slotWidgetRemoved (UMLWidget *widget)
	A widget was removed from the UMLView.
Public Member Functions
	DocWindow (UMLDoc doc, QWidget parent=0, const char *name=0)
	Constructor.
	~DocWindow ()
	Deconstructor.
void	showDocumentation (UMLObject *object, bool overwrite=false)
	Called when a widget wishes to display its documentation in the doc window.
void	showDocumentation (UMLView *view, bool overwrite=false)
	This method is the same as the one for UMLObjects except it displays documentation for a diagram.
void	showDocumentation (UMLWidget *widget, bool overwrite=false)
	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)
	This method is the same as the one for UMLObjects except it displays documentation for an association instance (AssociationWidget).
void	updateDocumentation (bool clear=false, bool startup=false)
	Call when you wish move changes in the doc window back into the members documentation.
void	newDocumentation ()
	Re-initializes the class for a new document.
bool	isTyping ()
	Checks if the user is typing in the documentation edit window.

umbrello API Documentation

DocWindow Class Reference

Public Slots

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation