umbrello  2.32.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
dcodedocumentation.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) 2007 Jari-Matti Mäkelä <jmjm@iki.fi> *
8  * copyright (C) 2008-2020 *
9  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
10  ***************************************************************************/
11 
12 #ifndef DCODEDOCUMENTATION_H
13 #define DCODEDOCUMENTATION_H
14 
15 #include "codecomment.h"
16 
17 #include <QString>
18 
19 class CodeDocument;
20 
27 class DCodeDocumentation : virtual public CodeComment
28 {
29 public:
30 
34  explicit DCodeDocumentation (CodeDocument * doc, const QString & text = QString());
35 
39  virtual ~DCodeDocumentation ();
40 
44  virtual void saveToXMI1 (QDomDocument & doc, QDomElement & root);
45 
54  QString toString () const;
55 
60  virtual QString unformatText (const QString & text, const QString & indent = QString());
61 
66  virtual QString getNewEditorLine (int amount);
67 
76  virtual int firstEditableLine();
77  virtual int lastEditableLine();
78 
79 };
80 
81 #endif // DCODEDOCUMENTATION_H
TextBlock::getWriteOutText
bool getWriteOutText() const
Definition: textblock.cpp:141
DCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Definition: dcodedocumentation.cpp:83
DCodeDocumentation::~DCodeDocumentation
virtual ~DCodeDocumentation()
Definition: dcodedocumentation.cpp:29
CodeComment
Definition: codecomment.h:24
DCodeDocumentation::saveToXMI1
virtual void saveToXMI1(QDomDocument &doc, QDomElement &root)
Definition: dcodedocumentation.cpp:33
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2283
CodeGenerationPolicy::MultiLine
@ MultiLine
Definition: codegenerationpolicy.h:50
TextBlock::getIndentationString
QString getIndentationString(int level=0) const
Definition: textblock.cpp:193
DCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: dcodedocumentation.cpp:91
CodeDocument
Definition: codedocument.h:33
DCodeDocumentation::getNewEditorLine
virtual QString getNewEditorLine(int amount)
Definition: dcodedocumentation.cpp:74
dcodedocumentation.h
DCodeDocumentation::toString
QString toString() const
Definition: dcodedocumentation.cpp:41
DCodeDocumentation
Definition: dcodedocumentation.h:28
codegenerationpolicy.h
CodeGenerationPolicy
Definition: codegenerationpolicy.h:30
CodeGenerationPolicy::getCommentStyle
CommentStyle getCommentStyle()
Definition: codegenerationpolicy.cpp:104
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:278
TextBlock::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: textblock.cpp:253
TextBlock::setAttributesOnNode
virtual void setAttributesOnNode(QDomDocument &doc, QDomElement &blockElement)
Definition: textblock.cpp:322
DCodeDocumentation::DCodeDocumentation
DCodeDocumentation(CodeDocument *doc, const QString &text=QString())
Definition: dcodedocumentation.cpp:24
codedocument.h
TextBlock::formatMultiLineText
static QString formatMultiLineText(const QString &work, const QString &linePrefix, const QString &breakStr, bool addBreak=true, bool lastLineHasBreak=true)
Definition: textblock.cpp:288
uml.h
TextBlock::getNewLineEndingChars
static QString getNewLineEndingChars()
Definition: textblock.cpp:172
DCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: dcodedocumentation.cpp:105
codegenerator.h
TextBlock::getText
QString getText() const
Definition: textblock.cpp:99
codecomment.h