umbrello API Documentation

RubyCodeComment Class Reference

class RubyCodeComment A Ruby code comment. More...

#include <rubycodecomment.h>

Inheritance diagram for RubyCodeComment:

CodeComment TextBlock List of all members.

Public Member Functions

 RubyCodeComment (CodeDocument *doc, const QString &text="")
 Constructors.
virtual ~RubyCodeComment ()
 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 "#" as well.

Detailed Description

class RubyCodeComment A Ruby code comment.

There are two styles of comments: these are simply started with a hash and no terminating characters, or delimited by '=begin' and '=end' tags at the start of lines

Definition at line 34 of file rubycodecomment.h.


Constructor & Destructor Documentation

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

Constructors.

Definition at line 26 of file rubycodecomment.cpp.

RubyCodeComment::~RubyCodeComment  )  [virtual]
 

Empty Destructor.

Definition at line 32 of file rubycodecomment.cpp.


Member Function Documentation

QString RubyCodeComment::toString  )  [virtual]
 

Returns:
QString

Reimplemented from TextBlock.

Definition at line 70 of file rubycodecomment.cpp.

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

QString RubyCodeComment::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 57 of file rubycodecomment.cpp.

References TextBlock::unformatText().

QString RubyCodeComment::getNewEditorLine int  amount  )  [virtual]
 

a special version here because we want to not only indent the new line, but to add the "#" as well.

Reimplemented from TextBlock.

Definition at line 49 of file rubycodecomment.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