umbrello  2.39.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
This class represents an association inside a diagram. Bugs and comments to umbrello-devel@kde....
Definition: associationwidget.h:47
Definition: docwindow.h:25
UMLWidget * m_pUMLWidget
The UMLWidget we are going to show documentation.
Definition: docwindow.h:67
~DocWindow()
Definition: docwindow.cpp:108
QLabel * m_typeLabel
label for type icon
Definition: docwindow.h:72
bool m_focusEnabled
Definition: docwindow.h:76
QLabel * m_nameLabel
label for name text
Definition: docwindow.h:73
void toForeground()
Definition: docwindow.cpp:463
void slotTextChanged()
Definition: docwindow.cpp:407
void updateLabel(const QString &name=QString())
Definition: docwindow.cpp:424
UMLDoc * m_pUMLDoc
The Project we are going to show documentation.
Definition: docwindow.h:66
UMLScene * m_pUMLScene
The UMLScene we are going to show documentation.
Definition: docwindow.h:65
void setFocus()
Definition: docwindow.cpp:327
void reset()
Definition: docwindow.cpp:305
void slotAssociationRemoved(AssociationWidget *association)
Definition: docwindow.cpp:381
bool isModified() const
Definition: docwindow.cpp:336
DocWindow(UMLDoc *doc, QWidget *parent=0)
Definition: docwindow.cpp:68
bool isTyping() const
Definition: docwindow.cpp:319
AssociationWidget * m_pAssocWidget
The association we are going to show documentation.
Definition: docwindow.h:68
UMLObject * m_pUMLObject
The UMLObject we are going to show documentation.
Definition: docwindow.h:64
void slotWidgetRemoved(UMLWidget *widget)
Definition: docwindow.cpp:397
void showDocumentation(UMLObject *object, bool overwrite=false)
Definition: docwindow.cpp:125
void updateDocumentation(bool clear=false, bool startup=false)
Definition: docwindow.cpp:268
KTextEdit * m_docTE
documentation widget
Definition: docwindow.h:75
QLabel * createPixmapLabel()
Definition: docwindow.cpp:453
ModifiedWidget * m_modifiedWidget
label for modified flag icon
Definition: docwindow.h:74
ShowingType
Definition: docwindow.h:56
@ st_Association
Definition: docwindow.h:61
@ st_UMLObject
Definition: docwindow.h:59
@ st_UMLWidget
Definition: docwindow.h:60
@ st_UMLScene
Definition: docwindow.h:58
@ st_Project
Definition: docwindow.h:57
void slotFocusEnabledChanged(int state)
Definition: docwindow.cpp:415
ShowingType m_Showing
Which type of documentation we are showing.
Definition: docwindow.h:70
Definition: docwindow.cpp:37
Definition: umldoc.h:63
The base class for UML objects.
Definition: umlobject.h:70
Definition: umlscene.h:65
The base class for graphical UML objects.
Definition: umlwidget.h:36