• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

umbrello/umbrello

  • sources
  • kde-4.12
  • kdesdk
  • umbrello
  • umbrello
  • codegenerators
  • ruby
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-2013 *
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 
20 class RubyClassifierCodeDocument;
21 
29 class RubyCodeDocumentation : virtual public CodeComment
30 {
31 public:
32 
36  explicit RubyCodeDocumentation (RubyClassifierCodeDocument * doc, const QString & text = "");
37 
41  virtual ~RubyCodeDocumentation ();
42 
46  virtual void saveToXMI (QDomDocument & doc, QDomElement & root);
47 
51  QString toString () const;
52 
57  virtual QString unformatText (const QString & text, const QString & indent = "");
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
class RubyCodeDocumentation A Ruby code comment.
Definition: rubycodedocumentation.h:29
codecomment.h
RubyCodeDocumentation::RubyCodeDocumentation
RubyCodeDocumentation(RubyClassifierCodeDocument *doc, const QString &text="")
Constructors.
Definition: rubycodedocumentation.cpp:24
RubyCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent="")
UnFormat a long text string.
Definition: rubycodedocumentation.cpp:99
RubyClassifierCodeDocument
class RubyClassifierCodeDocument A Ruby UMLClassifier Code Document.
Definition: rubyclassifiercodedocument.h:36
RubyCodeDocumentation::toString
QString toString() const
Definition: rubycodedocumentation.cpp:41
RubyCodeDocumentation::getNewEditorLine
virtual QString getNewEditorLine(int amount)
A special version here because we want to not only indent the new line, but to add the "# " sequence ...
Definition: rubycodedocumentation.cpp:72
RubyCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Ush.
Definition: rubycodedocumentation.cpp:81
RubyCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: rubycodedocumentation.cpp:89
RubyCodeDocumentation::~RubyCodeDocumentation
virtual ~RubyCodeDocumentation()
Empty Destructor.
Definition: rubycodedocumentation.cpp:29
CodeComment
Text which will be comments.
Definition: codecomment.h:23
RubyCodeDocumentation::saveToXMI
virtual void saveToXMI(QDomDocument &doc, QDomElement &root)
Save the XMI representation of this object.
Definition: rubycodedocumentation.cpp:33
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:00 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

umbrello/umbrello

Skip menu "umbrello/umbrello"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal