umbrello/umbrello
#include <cppcodedocumentation.h>
Public Member Functions | |
CPPCodeDocumentation (CodeDocument *doc, const QString &text="") | |
virtual | ~CPPCodeDocumentation () |
virtual int | firstEditableLine () |
virtual QString | getNewEditorLine (int amount) |
virtual int | lastEditableLine () |
virtual void | saveToXMI (QDomDocument &doc, QDomElement &root) |
QString | toString () const |
virtual QString | unformatText (const QString &text, const QString &indent="") |
Public Member Functions inherited from CodeComment | |
CodeComment (CodeDocument *doc, const QString &comment="") | |
virtual | ~CodeComment () |
virtual void | loadFromXMI (QDomElement &root) |
Public Member Functions inherited from TextBlock | |
TextBlock (CodeDocument *parent, const QString &text="") | |
virtual | ~TextBlock () |
void | appendText (const QString &text) |
bool | canDelete () const |
int | getIndentationLevel () const |
QString | getIndentationString (int level=0) const |
CodeDocument * | getParentDocument () const |
QString | getTag () const |
QString | getText () const |
bool | getWriteOutText () const |
virtual void | setAttributesFromObject (TextBlock *obj) |
void | setIndentationLevel (int level) |
void | setTag (const QString &value) |
void | setText (const QString &text) |
void | setWriteOutText (bool write) |
Additional Inherited Members | |
Static Public Member Functions inherited from TextBlock | |
static QString | decodeText (const QString &text, const QString &endLine) |
static QString | encodeText (const QString &text, const QString &endLine) |
static QString | formatMultiLineText (const QString &work, const QString &linePrefix, const QString &breakStr, bool addBreak=true, bool lastLineHasBreak=true) |
static QString | getIndentation () |
static QString | getNewLineEndingChars () |
Protected Member Functions inherited from TextBlock | |
virtual void | release () |
virtual void | setAttributesFromNode (QDomElement &root) |
virtual void | setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement) |
void | setCanDelete (bool canDelete) |
Detailed Description
class CPPCodeDocumentation A CPP code comment.
There is only a single styles of comments: these are simply started with double slash sequence and no terminating characters
Definition at line 27 of file cppcodedocumentation.h.
Constructor & Destructor Documentation
|
explicit |
Constructors.
Definition at line 24 of file cppcodedocumentation.cpp.
|
virtual |
Empty Destructor.
Definition at line 29 of file cppcodedocumentation.cpp.
Member Function Documentation
|
virtual |
Ush.
These are terrifically bad and must one day go away. Both methods indicate the range of lines in this textblock which may be edited by the codeeditor (assuming that any are actually editable). The default case is no lines are editable. The line numbering starts with '0' and a '-1' means no line qualifies.
Reimplemented from TextBlock.
Definition at line 87 of file cppcodedocumentation.cpp.
|
virtual |
a special version here because we want to not only indent the new line, but to add the " * " sequence as well.
Reimplemented from TextBlock.
Definition at line 78 of file cppcodedocumentation.cpp.
|
virtual |
- See also
- firstEditableLine
Reimplemented from TextBlock.
Definition at line 95 of file cppcodedocumentation.cpp.
|
virtual |
Save the XMI representation of this object.
Reimplemented from CodeComment.
Definition at line 36 of file cppcodedocumentation.cpp.
|
virtual |
- Returns
- QString
Reimplemented from TextBlock.
Definition at line 47 of file cppcodedocumentation.cpp.
|
virtual |
UnFormat a long text string.
Typically, this means removing the indentaion (linePrefix) and/or newline chars from each line.
Reimplemented from TextBlock.
Definition at line 108 of file cppcodedocumentation.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.