umbrello  2.35.1
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
cppcodedocumentation.h
Go to the documentation of this file.
1 /*
2  SPDX-License-Identifier: GPL-2.0-or-later
3 
4  SPDX-FileCopyrightText: 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov>
5  SPDX-FileCopyrightText: 2004-2021 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
6 */
7 
8 #ifndef CPPCODEDOCUMENTATION_H
9 #define CPPCODEDOCUMENTATION_H
10 
11 #include "codecomment.h"
12 
13 #include <QString>
14 
15 class CodeDocument;
16 
23 class CPPCodeDocumentation : virtual public CodeComment
24 {
25 public:
26 
30  explicit CPPCodeDocumentation (CodeDocument * doc, const QString & text = QString());
31 
35  virtual ~CPPCodeDocumentation ();
36 
40  virtual void saveToXMI(QXmlStreamWriter& writer);
41 
45  QString toString () const;
46 
50  virtual QString unformatText (const QString & text, const QString & indent = QString());
51 
55  virtual QString getNewEditorLine (int amount);
56 
64  virtual int firstEditableLine();
65  virtual int lastEditableLine();
66 
67 protected:
68 
69 private:
70 
71 };
72 
73 #endif // CPPCODEDOCUMENTATION_H
cppcodedocumentation.h
TextBlock::getWriteOutText
bool getWriteOutText() const
Definition: textblock.cpp:137
CPPCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Definition: cppcodedocumentation.cpp:83
CodeComment
Definition: codecomment.h:19
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2459
CodeGenerationPolicy::MultiLine
@ MultiLine
Definition: codegenerationpolicy.h:46
TextBlock::getIndentationString
QString getIndentationString(int level=0) const
Definition: textblock.cpp:189
CPPCodeDocumentation::toString
QString toString() const
Definition: cppcodedocumentation.cpp:43
CPPCodeDocumentation
Definition: cppcodedocumentation.h:23
CodeDocument
Definition: codedocument.h:29
CPPCodeDocumentation::saveToXMI
virtual void saveToXMI(QXmlStreamWriter &writer)
Definition: cppcodedocumentation.cpp:32
CPPCodeDocumentation::CPPCodeDocumentation
CPPCodeDocumentation(CodeDocument *doc, const QString &text=QString())
Definition: cppcodedocumentation.cpp:20
CPPCodeDocumentation::~CPPCodeDocumentation
virtual ~CPPCodeDocumentation()
Definition: cppcodedocumentation.cpp:25
CPPCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: cppcodedocumentation.cpp:104
CPPCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: cppcodedocumentation.cpp:91
codegenerationpolicy.h
CodeGenerationPolicy
Definition: codegenerationpolicy.h:25
CodeGenerationPolicy::getCommentStyle
CommentStyle getCommentStyle()
Definition: codegenerationpolicy.cpp:100
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:349
TextBlock::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: textblock.cpp:249
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:317
TextBlock::getNewLineEndingChars
static QString getNewLineEndingChars()
Definition: textblock.cpp:168
CPPCodeDocumentation::getNewEditorLine
virtual QString getNewEditorLine(int amount)
Definition: cppcodedocumentation.cpp:74
codegenerator.h
TextBlock::getText
QString getText() const
Definition: textblock.cpp:95
codecomment.h