umbrello  2.32.2
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  * 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) 2003 Brian Thomas <thomas@mail630.gsfc.nasa.gov> *
8  * copyright (C) 2004-2020 *
9  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
10  ***************************************************************************/
11 
12 #ifndef CPPCODEDOCUMENTATION_H
13 #define CPPCODEDOCUMENTATION_H
14 
15 #include "codecomment.h"
16 
17 #include <QString>
18 
19 class CodeDocument;
20 
27 class CPPCodeDocumentation : virtual public CodeComment
28 {
29 public:
30 
34  explicit CPPCodeDocumentation (CodeDocument * doc, const QString & text = QString());
35 
39  virtual ~CPPCodeDocumentation ();
40 
44  virtual void saveToXMI1(QXmlStreamWriter& writer);
45 
49  QString toString () const;
50 
54  virtual QString unformatText (const QString & text, const QString & indent = QString());
55 
59  virtual QString getNewEditorLine (int amount);
60 
68  virtual int firstEditableLine();
69  virtual int lastEditableLine();
70 
71 protected:
72 
73 private:
74 
75 };
76 
77 #endif // CPPCODEDOCUMENTATION_H
cppcodedocumentation.h
TextBlock::getWriteOutText
bool getWriteOutText() const
Definition: textblock.cpp:141
CPPCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Definition: cppcodedocumentation.cpp:87
CodeComment
Definition: codecomment.h:23
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2288
CodeGenerationPolicy::MultiLine
@ MultiLine
Definition: codegenerationpolicy.h:50
TextBlock::getIndentationString
QString getIndentationString(int level=0) const
Definition: textblock.cpp:193
CPPCodeDocumentation::toString
QString toString() const
Definition: cppcodedocumentation.cpp:47
CPPCodeDocumentation
Definition: cppcodedocumentation.h:27
CodeDocument
Definition: codedocument.h:33
CPPCodeDocumentation::CPPCodeDocumentation
CPPCodeDocumentation(CodeDocument *doc, const QString &text=QString())
Definition: cppcodedocumentation.cpp:24
CPPCodeDocumentation::~CPPCodeDocumentation
virtual ~CPPCodeDocumentation()
Definition: cppcodedocumentation.cpp:29
CPPCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: cppcodedocumentation.cpp:108
CPPCodeDocumentation::saveToXMI1
virtual void saveToXMI1(QXmlStreamWriter &writer)
Definition: cppcodedocumentation.cpp:36
CPPCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: cppcodedocumentation.cpp:95
codegenerationpolicy.h
CodeGenerationPolicy
Definition: codegenerationpolicy.h:29
CodeGenerationPolicy::getCommentStyle
CommentStyle getCommentStyle()
Definition: codegenerationpolicy.cpp:104
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:280
TextBlock::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: textblock.cpp:253
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::setAttributesOnNode
virtual void setAttributesOnNode(QXmlStreamWriter &writer)
Definition: textblock.cpp:322
TextBlock::getNewLineEndingChars
static QString getNewLineEndingChars()
Definition: textblock.cpp:172
CPPCodeDocumentation::getNewEditorLine
virtual QString getNewEditorLine(int amount)
Definition: cppcodedocumentation.cpp:78
codegenerator.h
TextBlock::getText
QString getText() const
Definition: textblock.cpp:99
codecomment.h