umbrello  2.31.0
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
rubycodedocumentation.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 *
8  * Richard Dale <Richard_Dale@tipitina.demon.co.uk> *
9  * copyright (C) 2006-2020 *
10  * Umbrello UML Modeller Authors <umbrello-devel@kde.org> *
11  ***************************************************************************/
12 
13 #ifndef RUBYCODEDOCUMENTATION_H
14 #define RUBYCODEDOCUMENTATION_H
15 
16 #include "codecomment.h"
17 
18 #include <QString>
19 
21 
29 class RubyCodeDocumentation : virtual public CodeComment
30 {
31 public:
32 
36  explicit RubyCodeDocumentation (RubyClassifierCodeDocument * doc, const QString & text = QString());
37 
41  virtual ~RubyCodeDocumentation ();
42 
46  virtual void saveToXMI1 (QDomDocument & doc, QDomElement & root);
47 
51  QString toString () const;
52 
57  virtual QString unformatText (const QString & text, const QString & indent = QString());
58 
63  virtual QString getNewEditorLine (int amount);
64 
73  virtual int firstEditableLine();
74  virtual int lastEditableLine();
75 
76 protected:
77 
78 private:
79 
80 };
81 
82 #endif // RUBYCODEDOCUMENTATION_H
RubyCodeDocumentation
Definition: rubycodedocumentation.h:29
TextBlock::getWriteOutText
bool getWriteOutText() const
Definition: textblock.cpp:141
RubyCodeDocumentation::RubyCodeDocumentation
RubyCodeDocumentation(RubyClassifierCodeDocument *doc, const QString &text=QString())
Definition: rubycodedocumentation.cpp:24
RubyCodeDocumentation::toString
QString toString() const
Definition: rubycodedocumentation.cpp:41
CodeComment
Definition: codecomment.h:23
UMLApp::commonPolicy
CodeGenerationPolicy * commonPolicy() const
Definition: uml.cpp:2274
CodeGenerationPolicy::MultiLine
@ MultiLine
Definition: codegenerationpolicy.h:50
TextBlock::getIndentationString
QString getIndentationString(int level=0) const
Definition: textblock.cpp:193
RubyCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: rubycodedocumentation.cpp:89
RubyCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Definition: rubycodedocumentation.cpp:81
RubyCodeDocumentation::~RubyCodeDocumentation
virtual ~RubyCodeDocumentation()
Definition: rubycodedocumentation.cpp:29
CodeDocument
Definition: codedocument.h:32
RubyCodeDocumentation::getNewEditorLine
virtual QString getNewEditorLine(int amount)
Definition: rubycodedocumentation.cpp:72
rubyclassifiercodedocument.h
RubyCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent=QString())
Definition: rubycodedocumentation.cpp:99
CodeGenerationPolicy
Definition: codegenerationpolicy.h:29
rubycodedocumentation.h
CodeGenerationPolicy::getCommentStyle
CommentStyle getCommentStyle()
Definition: codegenerationpolicy.cpp:104
UMLApp::app
static UMLApp * app()
Definition: uml.cpp:269
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
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
RubyClassifierCodeDocument
Definition: rubyclassifiercodedocument.h:36
RubyCodeDocumentation::saveToXMI1
virtual void saveToXMI1(QDomDocument &doc, QDomElement &root)
Definition: rubycodedocumentation.cpp:33
TextBlock::getText
QString getText() const
Definition: textblock.cpp:99
codecomment.h
rubycodegenerationpolicy.h