umbrello/umbrello
#include <docwindow.h>
Public Slots | |
void | slotAssociationRemoved (AssociationWidget *association) |
void | slotWidgetRemoved (UMLWidget *widget) |
Public Member Functions | |
DocWindow (UMLDoc *doc, QWidget *parent=0) | |
~DocWindow () | |
bool | isTyping () |
void | reset () |
void | showDocumentation (UMLObject *object, bool overwrite=false) |
void | showDocumentation (UMLScene *scene, bool overwrite=false) |
void | showDocumentation (UMLWidget *widget, bool overwrite=false) |
void | showDocumentation (AssociationWidget *widget, bool overwrite=false) |
void | updateDocumentation (bool clear=false, bool startup=false) |
Detailed Description
Definition at line 28 of file docwindow.h.
Constructor & Destructor Documentation
Constructor.
Definition at line 35 of file docwindow.cpp.
DocWindow::~DocWindow | ( | ) |
Destructor.
Definition at line 70 of file docwindow.cpp.
Member Function Documentation
bool DocWindow::isTyping | ( | ) |
Checks if the user is typing in the documentation edit window.
Definition at line 252 of file docwindow.cpp.
void DocWindow::reset | ( | ) |
Re-initializes the class for a new document.
Definition at line 238 of file docwindow.cpp.
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 87 of file docwindow.cpp.
void DocWindow::showDocumentation | ( | UMLScene * | scene, |
bool | overwrite = false |
||
) |
This method is the same as the one for UMLObjects except it displays documentation for a diagram.
Definition at line 114 of file docwindow.cpp.
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 142 of file docwindow.cpp.
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 170 of file docwindow.cpp.
|
slot |
An association was removed from the UMLScene.
If the association removed was the association which documentation is being shown, m_pAssocWidget is set to 0.
Definition at line 308 of file docwindow.cpp.
|
slot |
A widget was removed from the UMLScene.
If the association removed was the association which documentation is being shown, m_pUMLWidget is set to 0.
Definition at line 324 of file docwindow.cpp.
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 205 of file docwindow.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.