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  SPDX-License-Identifier: GPL-2.0-or-later
3 
4  SPDX-FileCopyrightText: 2007 Jari-Matti Mäkelä <jmjm@iki.fi>
5  SPDX-FileCopyrightText: 2008-2020 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
6 */
7 
8 #ifndef DCODEDOCUMENTATION_H
9 #define DCODEDOCUMENTATION_H
10 
11 #include "codecomment.h"
12 
13 #include <QString>
14 
15 class CodeDocument;
16 
23 class DCodeDocumentation : virtual public CodeComment
24 {
25 public:
26 
30  explicit DCodeDocumentation (CodeDocument * doc, const QString & text = QString());
31 
35  virtual ~DCodeDocumentation ();
36 
40  virtual void saveToXMI1(QXmlStreamWriter& writer);
41 
50  QString toString () const;
51 
56  virtual QString unformatText (const QString & text, const QString & indent = QString());
57 
62  virtual QString getNewEditorLine (int amount);
63 
72  virtual int firstEditableLine();
73  virtual int lastEditableLine();
74 
75 };
76 
77 #endif // DCODEDOCUMENTATION_H
TextBlock::getWriteOutText
bool getWriteOutText() const
Definition: textblock.cpp:137
DCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Definition: dcodedocumentation.cpp:79
DCodeDocumentation::~DCodeDocumentation
virtual ~DCodeDocumentation()
Definition: dcodedocumentation.cpp:25
CodeComment
Definition: codecomment.h:19
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2283
CodeGenerationPolicy::MultiLine
@ MultiLine
Definition: codegenerationpolicy.h:46
TextBlock::getIndentationString
QString getIndentationString(int level=0) const
Definition: textblock.cpp:189
DCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: dcodedocumentation.cpp:87
CodeDocument
Definition: codedocument.h:29
DCodeDocumentation::getNewEditorLine
virtual QString getNewEditorLine(int amount)
Definition: dcodedocumentation.cpp:70
DCodeDocumentation::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: dcodedocumentation.cpp:29
dcodedocumentation.h
DCodeDocumentation::toString
QString toString() const
Definition: dcodedocumentation.cpp:37
DCodeDocumentation
Definition: dcodedocumentation.h:23
codegenerationpolicy.h
CodeGenerationPolicy
Definition: codegenerationpolicy.h:25
CodeGenerationPolicy::getCommentStyle
CommentStyle getCommentStyle()
Definition: codegenerationpolicy.cpp:100
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:275
TextBlock::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: textblock.cpp:249
DCodeDocumentation::DCodeDocumentation
DCodeDocumentation(CodeDocument *doc, const QString &text=QString())
Definition: dcodedocumentation.cpp:20
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:284
uml.h
TextBlock::setAttributesOnNode
virtual void setAttributesOnNode(QXmlStreamWriter &writer)
Definition: textblock.cpp:318
TextBlock::getNewLineEndingChars
static QString getNewLineEndingChars()
Definition: textblock.cpp:168
DCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: dcodedocumentation.cpp:101
codegenerator.h
TextBlock::getText
QString getText() const
Definition: textblock.cpp:95
codecomment.h