umbrello API Documentation

JavaCodeComment Class Reference

class JavaCodeComment A Java code comment. More...

#include <javacodecomment.h>

Inheritance diagram for JavaCodeComment:

CodeComment TextBlock List of all members.

Public Member Functions

 JavaCodeComment (CodeDocument *doc, const QString &text="")
 Constructors.
virtual ~JavaCodeComment ()
 Empty Destructor.
QString toString ()
virtual QString unformatText (const QString &text, const QString &indent="")
 UnFormat a long text string.
virtual QString getNewEditorLine (int amount)
 a special version here because we want to not only indent the new line, but to add the "//" sequence as well.

Detailed Description

class JavaCodeComment A Java 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 31 of file javacodecomment.h.


Constructor & Destructor Documentation

JavaCodeComment::JavaCodeComment CodeDocument doc,
const QString &  text = ""
[explicit]
 

Constructors.

Definition at line 22 of file javacodecomment.cpp.

JavaCodeComment::~JavaCodeComment  )  [virtual]
 

Empty Destructor.

Definition at line 28 of file javacodecomment.cpp.


Member Function Documentation

QString JavaCodeComment::toString  )  [virtual]
 

Returns:
QString

Reimplemented from TextBlock.

Definition at line 67 of file javacodecomment.cpp.

References TextBlock::getIndentationString(), TextBlock::getText(), and TextBlock::getWriteOutText().

QString JavaCodeComment::unformatText const QString &  text,
const QString &  indent = ""
[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 53 of file javacodecomment.cpp.

References TextBlock::unformatText().

QString JavaCodeComment::getNewEditorLine int  amount  )  [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 45 of file javacodecomment.cpp.

References TextBlock::getIndentationString().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:05 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003