#include <docwindow.h>
Used internally to know which type of object we are showing documentation for.
Enumerator |
---|
st_Project |
|
st_UMLScene |
|
st_UMLObject |
|
st_UMLWidget |
|
st_Association |
|
DocWindow::DocWindow |
( |
UMLDoc * |
doc, |
|
|
QWidget * |
parent = 0 |
|
) |
| |
|
explicit |
DocWindow::~DocWindow |
( |
| ) |
|
QLabel * DocWindow::createPixmapLabel |
( |
| ) |
|
|
private |
Creates a QLabel used with a pixmap.
- Returns
- the just created QLabel
bool DocWindow::isModified |
( |
| ) |
const |
|
private |
Checks if the user is typing in the documentation edit window.
bool DocWindow::isTyping |
( |
| ) |
const |
Checks if the user is typing in the documentation edit window.
void DocWindow::reset |
( |
| ) |
|
Re-initializes the class for a new document.
void DocWindow::setFocus |
( |
| ) |
|
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.
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.
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).
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).
An association was removed from the UMLScene. If the association removed was the association whose documentation is being shown, m_pAssocWidget is set to 0.
void DocWindow::slotFocusEnabledChanged |
( |
int |
status | ) |
|
|
privateslot |
Set state of focus enabled support.
void DocWindow::slotTextChanged |
( |
| ) |
|
|
privateslot |
text from the edit field has been changed
void DocWindow::slotWidgetRemoved |
( |
UMLWidget * |
widget | ) |
|
|
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.
void DocWindow::toForeground |
( |
| ) |
|
|
private |
Bring doc window to foreground if it is tabbed with other dock widgets.
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 |
void DocWindow::updateLabel |
( |
const QString & |
name = QString() | ) |
|
|
private |
Updates the info label with the current state. If the given name is empty only the modified icon is set.
KTextEdit* DocWindow::m_docTE |
|
private |
bool DocWindow::m_focusEnabled |
|
private |
label for modified flag icon
QLabel* DocWindow::m_nameLabel |
|
private |
The association we are going to show documentation.
The Project we are going to show documentation.
The UMLObject we are going to show documentation.
The UMLScene we are going to show documentation.
The UMLWidget we are going to show documentation.
Which type of documentation we are showing.
QLabel* DocWindow::m_typeLabel |
|
private |
The documentation for this class was generated from the following files: