• 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
  • cpp
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-2013 *
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 = "");
35 
39  virtual ~CPPCodeDocumentation ();
40 
44  virtual void saveToXMI (QDomDocument & doc, QDomElement & root);
45 
49  QString toString () const;
50 
54  virtual QString unformatText (const QString & text, const QString & indent = "");
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::~CPPCodeDocumentation
virtual ~CPPCodeDocumentation()
Empty Destructor.
Definition: cppcodedocumentation.cpp:29
codecomment.h
CPPCodeDocumentation::toString
QString toString() const
Definition: cppcodedocumentation.cpp:47
CPPCodeDocumentation::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: cppcodedocumentation.cpp:78
CodeDocument
A document containing the code for one file.
Definition: codedocument.h:32
CPPCodeDocumentation::CPPCodeDocumentation
CPPCodeDocumentation(CodeDocument *doc, const QString &text="")
Constructors.
Definition: cppcodedocumentation.cpp:24
CPPCodeDocumentation
class CPPCodeDocumentation A CPP code comment.
Definition: cppcodedocumentation.h:27
CPPCodeDocumentation::firstEditableLine
virtual int firstEditableLine()
Ush.
Definition: cppcodedocumentation.cpp:87
CPPCodeDocumentation::saveToXMI
virtual void saveToXMI(QDomDocument &doc, QDomElement &root)
Save the XMI representation of this object.
Definition: cppcodedocumentation.cpp:36
CPPCodeDocumentation::unformatText
virtual QString unformatText(const QString &text, const QString &indent="")
UnFormat a long text string.
Definition: cppcodedocumentation.cpp:108
CPPCodeDocumentation::lastEditableLine
virtual int lastEditableLine()
Definition: cppcodedocumentation.cpp:95
CodeComment
Text which will be comments.
Definition: codecomment.h:23
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:05:59 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