umbrello
folder.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) 2006                                                    *
00009  *   Umbrello UML Modeller Authors <uml-devel@uml.sf.net>                  *
00010  ***************************************************************************/
00011 
00012 #ifndef UMLFOLDER_H
00013 #define UMLFOLDER_H
00014 
00015 #include "package.h"
00016 #include "umlviewlist.h"
00017 #include "optionstate.h"
00018 
00034 class UMLFolder : public UMLPackage {
00035     Q_OBJECT
00036 public:
00044     explicit UMLFolder(const QString & name = "", Uml::IDType id = Uml::id_None);
00045 
00049     virtual ~UMLFolder();
00050 
00054     virtual void init();
00055 
00059     virtual UMLObject* clone() const;
00060 
00067     void setLocalName(const QString& localName);
00068 
00073     QString getLocalName();
00074 
00078     void addView(UMLView *view);
00079 
00083     void removeView(UMLView *view);
00084 
00092     void appendViews(UMLViewList& viewList, bool includeNested = true);
00093 
00099     void activateViews();
00100 
00107     UMLView *findView(Uml::IDType id);
00108 
00117     UMLView * findView(Uml::Diagram_Type type, const QString &name, bool searchAllScopes = true);
00118 
00122     void setViewOptions(const Settings::OptionState& optionState);
00123 
00127     void removeAllViews();
00128 
00132     void setFolderFile(const QString& fileName);
00133 
00137     QString getFolderFile();
00138 
00144     void saveToXMI( QDomDocument & qDoc, QDomElement & qElement );
00145 
00146 protected:
00152     void saveContents(QDomDocument& qDoc, QDomElement& qElement);
00153 
00160     void save(QDomDocument& qDoc, QDomElement& qElement);
00161 
00166     bool loadDiagramsFromXMI(QDomNode& diagrams);
00167 
00179     bool loadFolderFile(const QString& path);
00180 
00184     bool load(QDomElement & element);
00185 
00186 private:
00187     QString m_localName;  
00188 
00195     QString m_folderFile;
00196     UMLViewList m_diagrams;
00197 };
00198 
00199 #endif
umbrello API Documentation

folder.h
