• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

umbrello/umbrello

  • sources
  • kde-4.12
  • kdesdk
  • umbrello
  • umbrello
docwindow.h
Go to the documentation of this file.
1 /***************************************************************************
2  * This program is free software; you can redistribute it and/or modify *
3  * it under the terms of the GNU General Public License as published by *
4  * the Free Software Foundation; either version 2 of the License, or *
5  * (at your option) any later version. *
6  * *
7  * copyright (C) 2002-2013 *
8  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
9  ***************************************************************************/
10 
11 #ifndef DOCWINDOW_H
12 #define DOCWINDOW_H
13 
14 #include <QWidget>
15 
16 class AssociationWidget;
17 class KTextEdit;
18 class QLabel;
19 class UMLObject;
20 class UMLDoc;
21 class UMLScene;
22 class UMLWidget;
23 
28 class DocWindow : public QWidget
29 {
30  Q_OBJECT
31 public:
32  explicit DocWindow(UMLDoc * doc, QWidget *parent = 0);
33  ~DocWindow();
34 
35  void showDocumentation(UMLObject * object, bool overwrite = false);
36  void showDocumentation(UMLScene * scene, bool overwrite = false);
37  void showDocumentation(UMLWidget * widget, bool overwrite = false);
38  void showDocumentation(AssociationWidget * widget, bool overwrite = false);
39 
40  void updateDocumentation(bool clear = false, bool startup = false);
41 
42  void reset();
43 
44  bool isTyping();
45 
46 public slots:
47  void slotAssociationRemoved(AssociationWidget* association);
48  void slotWidgetRemoved(UMLWidget* widget);
49 
50 private slots:
51  void slotTextChanged();
52 
53 private:
58  enum ShowingType {
59  st_Project,
60  st_UMLScene,
61  st_UMLObject,
62  st_UMLWidget,
63  st_Association
64  };
65 
66  UMLObject *m_pUMLObject;
67  UMLScene *m_pUMLScene;
68  UMLDoc *m_pUMLDoc;
69  UMLWidget *m_pUMLWidget;
70  AssociationWidget *m_pAssocWidget;
71 
72  ShowingType m_Showing;
73 
74  QLabel *m_typeLabel;
75  QLabel *m_nameLabel;
76  QLabel *m_modifiedLabel;
77  KTextEdit *m_docTE;
78 
79  bool isModified();
80  QLabel* createPixmapLabel();
81  void updateLabel(const QString &name = QString());
82 };
83 
84 #endif
DocWindow::~DocWindow
~DocWindow()
Destructor.
Definition: docwindow.cpp:70
DocWindow::showDocumentation
void showDocumentation(UMLObject *object, bool overwrite=false)
Called when a widget wishes to display its documentation in the doc window.
Definition: docwindow.cpp:87
QWidget
DocWindow::updateDocumentation
void updateDocumentation(bool clear=false, bool startup=false)
Call when you wish move changes in the doc window back into the members documentation.
Definition: docwindow.cpp:205
DocWindow::reset
void reset()
Re-initializes the class for a new document.
Definition: docwindow.cpp:238
UMLObject
This class is the non-graphical version of UMLWidget.
Definition: umlobject.h:41
AssociationWidget
This class represents an association inside a diagram.
Definition: associationwidget.h:50
DocWindow::slotWidgetRemoved
void slotWidgetRemoved(UMLWidget *widget)
A widget was removed from the UMLScene.
Definition: docwindow.cpp:324
DocWindow::DocWindow
DocWindow(UMLDoc *doc, QWidget *parent=0)
Constructor.
Definition: docwindow.cpp:35
DocWindow
Definition: docwindow.h:28
DocWindow::slotAssociationRemoved
void slotAssociationRemoved(AssociationWidget *association)
An association was removed from the UMLScene.
Definition: docwindow.cpp:308
UMLScene
UMLScene instances represent diagrams.
Definition: umlscene.h:70
KTextEdit
DocWindow::isTyping
bool isTyping()
Checks if the user is typing in the documentation edit window.
Definition: docwindow.cpp:252
UMLDoc
UMLDoc provides a document object for a document-view model.
Definition: umldoc.h:63
UMLWidget
This is the base class for nearly all graphical widgets.
Definition: umlwidget.h:40
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:05:59 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

umbrello/umbrello

Skip menu "umbrello/umbrello"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal