• 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
  • codeimport
import_utils.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) 2005-2013 *
8  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
9  ***************************************************************************/
10 
11 #ifndef IMPORT_UTILS_H
12 #define IMPORT_UTILS_H
13 
14 #include "basictypes.h"
15 #include "umlattributelist.h"
16 
17 #include <QStringList>
18 
19 class UMLObject;
20 class UMLClassifier;
21 class UMLPackage;
22 class UMLOperation;
23 class UMLEnum;
24 
30 namespace Import_Utils {
31 
32  UMLObject* createUMLObject(UMLObject::ObjectType type,
33  const QString& name,
34  UMLPackage *parentPkg = NULL,
35  const QString& comment = QString(),
36  const QString& stereotype = QString());
37 
38  void putAtGlobalScope(bool yesno);
39 
40  void setRelatedClassifier(UMLClassifier *c);
41 
42  void assignUniqueIdOnCreation(bool yesno);
43 
44  UMLObject* insertAttribute(UMLClassifier *klass, Uml::Visibility::Enum scope,
45  const QString& name,
46  const QString& type,
47  const QString& comment = QString(),
48  bool isStatic = false);
49  UMLObject* insertAttribute(UMLClassifier *klass, Uml::Visibility::Enum scope,
50  const QString& name,
51  UMLClassifier *attrType,
52  const QString& comment /* ="" */,
53  bool isStatic /* =false */);
54 
55  UMLOperation* makeOperation(UMLClassifier *parent, const QString &name);
56 
57  void insertMethod(UMLClassifier *klass, UMLOperation* &op,
58  Uml::Visibility::Enum scope, const QString& type,
59  bool isStatic, bool isAbstract,
60  bool isFriend = false, bool isConstructor = false,
61  const QString& comment = QString());
62 
63  UMLAttribute* addMethodParameter(UMLOperation *method,
64  const QString& type,
65  const QString& name);
66 
67  void addEnumLiteral(UMLEnum *enumType, const QString &literal,
68  const QString &comment = QString());
69 
70  void createGeneralization(UMLClassifier *child, UMLClassifier *parent);
71  void createGeneralization(UMLClassifier *child, const QString &parentName);
72 
73  QString formatComment(const QString &comment);
74 
75  QStringList includePathList();
76 
77  void addIncludePath(const QString& path);
78 
79  bool newUMLObjectWasCreated();
80 
81  bool isDatatype(const QString& name, UMLPackage *parentPkg = NULL);
82 
83 } // end namespace Import_Utils
84 
85 #endif
UMLPackage
This class contains the non-graphical information required for a UML Package.
Definition: package.h:32
UMLClassifier
This class defines the non-graphical information required for a UML Classifier (ie a class or interfa...
Definition: classifier.h:39
Import_Utils::newUMLObjectWasCreated
bool newUMLObjectWasCreated()
Returns whether the last createUMLObject() actually created a new object or just returned an existing...
Definition: import_utils.cpp:112
Uml::Visibility::Enum
Enum
Definition: basictypes.h:56
Import_Utils::insertAttribute
UMLObject * insertAttribute(UMLClassifier *owner, Uml::Visibility::Enum scope, const QString &name, UMLClassifier *attrType, const QString &comment, bool isStatic)
Create a UMLAttribute and insert it into the document.
Definition: import_utils.cpp:364
UMLAttribute
This class is used to set up information for an attribute.
Definition: attribute.h:27
UMLObject
This class is the non-graphical version of UMLWidget.
Definition: umlobject.h:41
Import_Utils::putAtGlobalScope
void putAtGlobalScope(bool yesno)
Control whether an object which is newly created by createUMLObject() is put at the global scope...
Definition: import_utils.cpp:82
Import_Utils::createUMLObject
UMLObject * createUMLObject(UMLObject::ObjectType type, const QString &inName, UMLPackage *parentPkg, const QString &comment, const QString &stereotype)
Find or create a document object.
Definition: import_utils.cpp:169
umlattributelist.h
Import_Utils::insertMethod
void insertMethod(UMLClassifier *klass, UMLOperation *&op, Uml::Visibility::Enum scope, const QString &type, bool isStatic, bool isAbstract, bool isFriend, bool isConstructor, const QString &comment)
Insert the UMLOperation into the given classifier.
Definition: import_utils.cpp:435
Import_Utils::addMethodParameter
UMLAttribute * addMethodParameter(UMLOperation *method, const QString &type, const QString &name)
Add an argument to a UMLOperation.
Definition: import_utils.cpp:507
Import_Utils::isDatatype
bool isDatatype(const QString &name, UMLPackage *parentPkg)
Returns true if a type is an actual Datatype.
Definition: import_utils.cpp:596
Import_Utils::formatComment
QString formatComment(const QString &comment)
Strip comment lines of leading whitespace and stars.
Definition: import_utils.cpp:120
Import_Utils::addIncludePath
void addIncludePath(const QString &path)
Add a path to the include path list.
Definition: import_utils.cpp:587
Import_Utils::setRelatedClassifier
void setRelatedClassifier(UMLClassifier *c)
Set a related classifier for creation of dependencies on template parameters in createUMLObject().
Definition: import_utils.cpp:91
UMLEnum
This class contains the non-graphical information required for a UML Enum.
Definition: enum.h:28
Import_Utils::makeOperation
UMLOperation * makeOperation(UMLClassifier *parent, const QString &name)
Create a UMLOperation.
Definition: import_utils.cpp:354
UMLOperation
This class represents an operation in the UML model.
Definition: operation.h:24
UMLObject::ObjectType
ObjectType
Definition: umlobject.h:47
Import_Utils::assignUniqueIdOnCreation
void assignUniqueIdOnCreation(bool yesno)
Control whether the creation methods solicit a new unique ID for the created object.
Definition: import_utils.cpp:103
Import_Utils::addEnumLiteral
void addEnumLiteral(UMLEnum *enumType, const QString &literal, const QString &comment)
Add an enum literal to an UMLEnum.
Definition: import_utils.cpp:528
Import_Utils::createGeneralization
void createGeneralization(UMLClassifier *child, UMLClassifier *parent)
Create a generalization from the given child classifier to the given parent classifier.
Definition: import_utils.cpp:538
basictypes.h
Import_Utils::includePathList
QStringList includePathList()
Return the list of paths set by previous calls to addIncludePath() and the environment variable UMBRE...
Definition: import_utils.cpp:574
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