umbrello
docwindow.h

00001 /***************************************************************************
00002  *                                                                         *
00003  *   This program is free software; you can redistribute it and/or modify  *
00004  *   it under the terms of the GNU General Public License as published by  *
00005  *   the Free Software Foundation; either version 2 of the License, or     *
00006  *   (at your option) any later version.                                   *
00007  *                                                                         *
00008  *   copyright (C) 2002-2006                                               *
00009  *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
00010  ***************************************************************************/
00011 
00012 #ifndef DOCWINDOW_H
00013 #define DOCWINDOW_H
00014 
00015 #include <qwidget.h>
00016 
00017 class AssociationWidget;
00018 class QGroupBox;
00019 class QMultiLineEdit;
00020 class UMLObject;
00021 class UMLDoc;
00022 class UMLView;
00023 class UMLWidget;
00024 
00030 class DocWindow : public QWidget {
00031     Q_OBJECT
00032 public:
00036     explicit DocWindow( UMLDoc * doc, QWidget *parent = 0, const char *name = 0 );
00037 
00041     ~DocWindow();
00042 
00056     void showDocumentation( UMLObject * object, bool overwrite = false );
00057 
00062     void showDocumentation( UMLView * view, bool overwrite = false );
00063 
00069     void showDocumentation( UMLWidget * widget, bool overwrite = false );
00070 
00076     void showDocumentation( AssociationWidget * widget, bool overwrite = false );
00077 
00090     void updateDocumentation( bool clear = false, bool startup = false );
00091 
00092 
00096     void newDocumentation( );
00097 
00101     bool isTyping();
00102 
00103 public slots:
00104 
00110     void slotAssociationRemoved(AssociationWidget* association);
00111 
00117     void slotWidgetRemoved(UMLWidget* widget);
00118 
00119 private:
00124     enum Showing_Type {
00125         st_Project,
00126         st_UMLView,
00127         st_UMLObject,
00128         st_UMLWidget,
00129         st_Association
00130     };
00131 
00135     UMLObject * m_pUMLObject;
00136 
00140     UMLView * m_pUMLView;
00141 
00145     UMLDoc * m_pUMLDoc;
00146 
00150     UMLWidget * m_pUMLWidget;
00151 
00155     AssociationWidget * m_pAssocWidget;
00156 
00160     Showing_Type m_Showing;
00161 
00162     //visual widgets
00163     QMultiLineEdit      * m_pDocMLE;
00164     QGroupBox   * m_pDocGB;
00165 
00166 };
00167 
00168 #endif
umbrello API Documentation

docwindow.h
