umbrello  2.32.2
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 
11 class AssociationWidget;
12 class KTextEdit;
13 class ModifiedWidget;
14 class QLabel;
15 class UMLObject;
16 class UMLDoc;
17 class UMLScene;
18 class UMLWidget;
19 
24 class DocWindow : public QWidget
25 {
26  Q_OBJECT
27 public:
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 
43 public slots:
44  void slotAssociationRemoved(AssociationWidget* association);
45  void slotWidgetRemoved(UMLWidget* widget);
46 
47 private slots:
48  void slotTextChanged();
49  void slotFocusEnabledChanged(int state);
50 
51 private:
56  enum ShowingType {
62  };
63 
69 
71 
72  QLabel *m_typeLabel;
73  QLabel *m_nameLabel;
75  KTextEdit *m_docTE;
77 
78  bool isModified() const;
79  QLabel* createPixmapLabel();
80  void updateLabel(const QString &name = QString());
81  void toForeground();
82 };
83 
84 #endif
DocWindow::st_UMLScene
@ st_UMLScene
Definition: docwindow.h:58
Icon_Utils::it_Document_Edit
@ it_Document_Edit
Definition: icon_utils.h:222
ModifiedWidget::ModifiedWidget
ModifiedWidget(DocWindow *_parent)
Definition: docwindow.cpp:39
AssociationWidget
This class represents an association inside a diagram. Bugs and comments to umbrello-devel@kde....
Definition: associationwidget.h:46
docwindow.h
UMLObject::name
QString name() const
Definition: umlobject.cpp:206
DocWindow::slotFocusEnabledChanged
void slotFocusEnabledChanged(int state)
Definition: docwindow.cpp:414
UMLWidget
The base class for graphical UML objects.
Definition: umlwidget.h:35
DocWindow::~DocWindow
~DocWindow()
Definition: docwindow.cpp:108
WidgetBase::name
QString name() const
Definition: widgetbase.cpp:316
WidgetBase::setDocumentation
virtual void setDocumentation(const QString &doc)
Definition: widgetbase.cpp:301
DocWindow::m_pAssocWidget
AssociationWidget * m_pAssocWidget
The association we are going to show documentation.
Definition: docwindow.h:68
DocWindow::m_focusEnabled
bool m_focusEnabled
Definition: docwindow.h:76
WidgetBase::umlScene
UMLScene * umlScene() const
Definition: widgetbase.cpp:169
DocWindow::ShowingType
ShowingType
Definition: docwindow.h:56
DocWindow::DocWindow
DocWindow(UMLDoc *doc, QWidget *parent=0)
Definition: docwindow.cpp:68
DocWindow::st_UMLObject
@ st_UMLObject
Definition: docwindow.h:59
DocWindow::st_Project
@ st_Project
Definition: docwindow.h:57
WidgetBase::toIcon
static Icon_Utils::IconType toIcon(WidgetType wt)
Definition: widgetbase.cpp:1342
DocWindow::m_pUMLDoc
UMLDoc * m_pUMLDoc
The Project we are going to show documentation.
Definition: docwindow.h:66
DocWindow::slotAssociationRemoved
void slotAssociationRemoved(AssociationWidget *association)
Definition: docwindow.cpp:380
DocWindow::updateDocumentation
void updateDocumentation(bool clear=false, bool startup=false)
Definition: docwindow.cpp:268
Icon_Utils::it_Diagram_Class
@ it_Diagram_Class
Definition: icon_utils.h:111
DocWindow::isTyping
bool isTyping() const
Definition: docwindow.cpp:318
UMLObject
The base class for UML objects.
Definition: umlobject.h:69
UMLObject::baseType
ObjectType baseType() const
Definition: umlobject.cpp:392
DocWindow::m_docTE
KTextEdit * m_docTE
documentation widget
Definition: docwindow.h:75
UMLObject::asUMLFolder
UMLFolder * asUMLFolder()
Definition: umlobject.cpp:1398
AssociationWidget::name
QString name() const
Definition: associationwidget.cpp:869
DocWindow::m_modifiedWidget
ModifiedWidget * m_modifiedWidget
label for modified flag icon
Definition: docwindow.h:74
Icon_Utils::it_Home
@ it_Home
Definition: icon_utils.h:34
WidgetBase::umlObject
UMLObject * umlObject() const
Definition: widgetbase.cpp:189
UMLObject::toIcon
static Icon_Utils::IconType toIcon(ObjectType t)
Definition: umlobject.cpp:1257
UMLDoc::documentation
QString documentation() const
Definition: umldoc.cpp:3257
DocWindow::m_typeLabel
QLabel * m_typeLabel
label for type icon
Definition: docwindow.h:72
DocWindow::m_nameLabel
QLabel * m_nameLabel
label for name text
Definition: docwindow.h:73
umlwidget.h
DocWindow
Definition: docwindow.h:24
DocWindow::isModified
bool isModified() const
Definition: docwindow.cpp:335
DocWindow::toForeground
void toForeground()
Definition: docwindow.cpp:462
folder.h
i18n
#define i18n
Definition: main.cpp:34
DocWindow::updateLabel
void updateLabel(const QString &name=QString())
Definition: docwindow.cpp:423
DocWindow::slotWidgetRemoved
void slotWidgetRemoved(UMLWidget *widget)
Definition: docwindow.cpp:396
UMLFolder::localName
QString localName() const
Definition: folder.cpp:76
DocWindow::slotTextChanged
void slotTextChanged()
Definition: docwindow.cpp:406
WidgetBase::documentation
QString documentation() const
Definition: widgetbase.cpp:276
Icon_Utils::it_Association
@ it_Association
Definition: icon_utils.h:91
Icon_Utils::SmallIcon
QPixmap SmallIcon(IconType type)
Definition: icon_utils.cpp:26
MyProject\connect
connect()
Definition: namespaces-multiple.php:5
UMLObject::doc
QString doc() const
Definition: umlobject.cpp:430
DocWindow::st_Association
@ st_Association
Definition: docwindow.h:61
ModifiedWidget::mousePressEvent
virtual void mousePressEvent(QMouseEvent *ev)
Definition: docwindow.cpp:55
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:275
UMLDoc::name
QString name() const
Definition: umldoc.cpp:2006
UMLDoc
Definition: umldoc.h:69
DocWindow::m_pUMLScene
UMLScene * m_pUMLScene
The UMLScene we are going to show documentation.
Definition: docwindow.h:65
UMLDoc::setModified
void setModified(bool modified=true)
Definition: umldoc.cpp:3107
UMLFolder
Non-graphical management of objects and diagrams of a Folder.
Definition: folder.h:29
UMLScene::setDocumentation
void setDocumentation(const QString &doc)
Definition: umlscene.cpp:360
ModifiedWidget
Definition: docwindow.cpp:36
DocWindow::st_UMLWidget
@ st_UMLWidget
Definition: docwindow.h:60
associationwidget.h
UMLObject::setDoc
void setDoc(const QString &d)
Definition: umlobject.cpp:450
DocWindow::showDocumentation
void showDocumentation(UMLObject *object, bool overwrite=false)
Definition: docwindow.cpp:125
DocWindow::setFocus
void setFocus()
Definition: docwindow.cpp:326
uError
#define uError()
Definition: debug_utils.h:109
DocWindow::createPixmapLabel
QLabel * createPixmapLabel()
Definition: docwindow.cpp:452
umlscene.h
Icon_Utils::IconType
IconType
Definition: icon_utils.h:32
uml.h
DocWindow::m_Showing
ShowingType m_Showing
Which type of documentation we are showing.
Definition: docwindow.h:70
debug_utils.h
icon_utils.h
UMLScene::name
QString name() const
Definition: umlscene.cpp:406
UMLDoc::setDocumentation
void setDocumentation(const QString &doc)
Definition: umldoc.cpp:3267
UMLScene
Definition: umlscene.h:64
UMLWidget::updateGeometry
void updateGeometry(bool withAssocs=true)
Definition: umlwidget.cpp:1822
umlobject.h
DocWindow::m_pUMLObject
UMLObject * m_pUMLObject
The UMLObject we are going to show documentation.
Definition: docwindow.h:64
Icon_Utils::it_Code_Gen_Wizard
@ it_Code_Gen_Wizard
Definition: icon_utils.h:220
DocWindow::reset
void reset()
Definition: docwindow.cpp:304
ModifiedWidget::setModified
void setModified(bool state)
Definition: docwindow.cpp:47
UMLObject::ot_Folder
@ ot_Folder
Definition: umlobject.h:99
UMLScene::documentation
QString documentation() const
Definition: umlscene.cpp:352
WidgetBase::baseType
WidgetType baseType() const
Definition: widgetbase.cpp:122
umldoc.h
ModifiedWidget::parent
DocWindow * parent
Definition: docwindow.cpp:62
DocWindow::m_pUMLWidget
UMLWidget * m_pUMLWidget
The UMLWidget we are going to show documentation.
Definition: docwindow.h:67