umbrello: umbrello/docwindow.h Source File

umbrello 2.32.3 Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology

docwindow.h
Go to the documentation of this file.
1/*
2 SPDX-License-Identifier: GPL-2.0-or-later
3 SPDX-FileCopyrightText: 2002-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
4*/
5
6#ifndef DOCWINDOW_H
7#define DOCWINDOW_H
8
9#include <QWidget>
10
11class AssociationWidget;
12class KTextEdit;
13class ModifiedWidget;
14class QLabel;
15class UMLObject;
16class UMLDoc;
17class UMLScene;
18class UMLWidget;
19
24 class DocWindow : public QWidget
25{
26 Q_OBJECT
27public:
28 explicit DocWindow(UMLDoc * doc, QWidget *parent = 0);
29 ~DocWindow();
30
31 void showDocumentation(UMLObject * object, bool overwrite = false);
32 void showDocumentation(UMLScene * scene, bool overwrite = false);
33 void showDocumentation(UMLWidget * widget, bool overwrite = false);
34 void showDocumentation(AssociationWidget * widget, bool overwrite = false);
35
36 void updateDocumentation(bool clear = false, bool startup = false);
37
38 void reset();
39
40 bool isTyping() const;
41 void setFocus();
42
43public slots:
44 void slotAssociationRemoved(AssociationWidget* association);
45 void slotWidgetRemoved(UMLWidget* widget);
46
47private slots:
48 void slotTextChanged();
49 void slotFocusEnabledChanged(int state);
50
51private:
56 enum ShowingType {
57 st_Project,
58 st_UMLScene,
59 st_UMLObject,
60 st_UMLWidget,
61 st_Association
62 };
63
64 UMLObject *m_pUMLObject;
65 UMLScene *m_pUMLScene;
66 UMLDoc *m_pUMLDoc;
67 UMLWidget *m_pUMLWidget;
68 AssociationWidget *m_pAssocWidget;
69
70 ShowingType m_Showing;
71
72 QLabel *m_typeLabel;
73 QLabel *m_nameLabel;
74 ModifiedWidget *m_modifiedWidget;
75 KTextEdit *m_docTE;
76 bool m_focusEnabled;
77
78 bool isModified() const;
79 QLabel* createPixmapLabel();
80 void updateLabel(const QString &name = QString());
81 void toForeground();
82};
83
84#endif
AssociationWidget
This class represents an association inside a diagram. Bugs and comments to umbrello-devel@kde....
Definition: associationwidget.h:47
DocWindow
Definition: docwindow.h:25
DocWindow::m_pUMLWidget
UMLWidget * m_pUMLWidget
The UMLWidget we are going to show documentation.
Definition: docwindow.h:67
DocWindow::~DocWindow
~DocWindow()
Definition: docwindow.cpp:108
DocWindow::m_typeLabel
QLabel * m_typeLabel
label for type icon
Definition: docwindow.h:72
DocWindow::m_focusEnabled
bool m_focusEnabled
Definition: docwindow.h:76
DocWindow::m_nameLabel
QLabel * m_nameLabel
label for name text
Definition: docwindow.h:73
DocWindow::toForeground
void toForeground()
Definition: docwindow.cpp:462
DocWindow::slotTextChanged
void slotTextChanged()
Definition: docwindow.cpp:406
DocWindow::updateLabel
void updateLabel(const QString &name=QString())
Definition: docwindow.cpp:423
DocWindow::m_pUMLDoc
UMLDoc * m_pUMLDoc
The Project we are going to show documentation.
Definition: docwindow.h:66
DocWindow::m_pUMLScene
UMLScene * m_pUMLScene
The UMLScene we are going to show documentation.
Definition: docwindow.h:65
DocWindow::setFocus
void setFocus()
Definition: docwindow.cpp:326
DocWindow::reset
void reset()
Definition: docwindow.cpp:304
DocWindow::slotAssociationRemoved
void slotAssociationRemoved(AssociationWidget *association)
Definition: docwindow.cpp:380
DocWindow::isModified
bool isModified() const
Definition: docwindow.cpp:335
DocWindow::DocWindow
DocWindow(UMLDoc *doc, QWidget *parent=0)
Definition: docwindow.cpp:68
DocWindow::isTyping
bool isTyping() const
Definition: docwindow.cpp:318
DocWindow::m_pAssocWidget
AssociationWidget * m_pAssocWidget
The association we are going to show documentation.
Definition: docwindow.h:68
DocWindow::m_pUMLObject
UMLObject * m_pUMLObject
The UMLObject we are going to show documentation.
Definition: docwindow.h:64
DocWindow::slotWidgetRemoved
void slotWidgetRemoved(UMLWidget *widget)
Definition: docwindow.cpp:396
DocWindow::showDocumentation
void showDocumentation(UMLObject *object, bool overwrite=false)
Definition: docwindow.cpp:125
DocWindow::updateDocumentation
void updateDocumentation(bool clear=false, bool startup=false)
Definition: docwindow.cpp:268
DocWindow::m_docTE
KTextEdit * m_docTE
documentation widget
Definition: docwindow.h:75
DocWindow::createPixmapLabel
QLabel * createPixmapLabel()
Definition: docwindow.cpp:452
DocWindow::m_modifiedWidget
ModifiedWidget * m_modifiedWidget
label for modified flag icon
Definition: docwindow.h:74
DocWindow::ShowingType
ShowingType
Definition: docwindow.h:56
DocWindow::st_Association
@ st_Association
Definition: docwindow.h:61
DocWindow::st_UMLObject
@ st_UMLObject
Definition: docwindow.h:59
DocWindow::st_UMLWidget
@ st_UMLWidget
Definition: docwindow.h:60
DocWindow::st_UMLScene
@ st_UMLScene
Definition: docwindow.h:58
DocWindow::st_Project
@ st_Project
Definition: docwindow.h:57
DocWindow::slotFocusEnabledChanged
void slotFocusEnabledChanged(int state)
Definition: docwindow.cpp:414
DocWindow::m_Showing
ShowingType m_Showing
Which type of documentation we are showing.
Definition: docwindow.h:70
ModifiedWidget
Definition: docwindow.cpp:37
UMLDoc
Definition: umldoc.h:70
UMLObject
The base class for UML objects.
Definition: umlobject.h:70
UMLScene
Definition: umlscene.h:65
UMLWidget
The base class for graphical UML objects.
Definition: umlwidget.h:36