umbrello API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

CPPCodeComment Class Reference

class CPPCodeComment A CPP code comment. More...

#include <cppcodecomment.h>

Inheritance diagram for CPPCodeComment:

CodeComment TextBlock List of all members.

Public Member Functions

 CPPCodeComment (CodeDocument *doc, const QString &text="")
 Constructors.
virtual ~CPPCodeComment ()
 Empty Destructor.
virtual void saveToXMI (QDomDocument &doc, QDomElement &root)
 Save the XMI representation of this object.
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 CPPCodeComment 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 31 of file cppcodecomment.h.

Constructor & Destructor Documentation

CPPCodeComment::CPPCodeComment (  CodeDocument *  doc,
const QString &  text = ""
)  [explicit]
 

Constructors.

Definition at line 27 of file cppcodecomment.cpp.

CPPCodeComment::~CPPCodeComment (   )  [virtual]
 

Empty Destructor.

Definition at line 33 of file cppcodecomment.cpp.

Member Function Documentation

void CPPCodeComment::saveToXMI (  QDomDocument &  doc,
QDomElement &  root
)  [virtual]
 

Save the XMI representation of this object.

Reimplemented from CodeComment.

Definition at line 53 of file cppcodecomment.cpp.

References TextBlock::setAttributesOnNode().

QString CPPCodeComment::toString (   )  [virtual]
 

Returns:
QString

Reimplemented from TextBlock.

Definition at line 63 of file cppcodecomment.cpp.

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

QString CPPCodeComment::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 87 of file cppcodecomment.cpp.

References TextBlock::unformatText().

QString CPPCodeComment::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 79 of file cppcodecomment.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:04 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003