KDevelop API Documentation

ChangeLogEntry Struct Reference

A class which abstracts the building of an entry in the ChangeLog file (it formats name, e-mail and text). More...

#include <changelog.h>

Collaboration diagram for ChangeLogEntry:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ChangeLogEntry ()
 ~ChangeLogEntry ()
void addLine (const QString &aLine)
 Add a single line to the lines for this entry.
void addLines (const QStringList &someLines)
 Add a bunch of lines for this entry.
QString toString (const QString &startLineString=QString::null) const
 Pretty format for this entry: you may insert a line tag (such as tab ("\t") or 4 spaces (" ") or whatever you want (such as "\t * ").
void addToLog (const QString &logFilePath, const bool prepend=true, const QString &startLineString="\t")
 Once the entry is completed one would like to write on a file! (You may add on start of file prepend == true, or append on tail (prepend == false).

Public Attributes

QString authorName
QString authorEmail
QString date
QStringList lines

Detailed Description

A class which abstracts the building of an entry in the ChangeLog file (it formats name, e-mail and text).

Author:
Mario Scalas

Definition at line 22 of file changelog.h.


Constructor & Destructor Documentation

ChangeLogEntry::ChangeLogEntry  ) 
 

Definition at line 20 of file changelog.cpp.

References authorEmail, authorName, date, KEMailSettings::defaultProfileName(), KEMailSettings::getSetting(), and KEMailSettings::setProfile().

ChangeLogEntry::~ChangeLogEntry  ) 
 

Definition at line 31 of file changelog.cpp.


Member Function Documentation

void ChangeLogEntry::addLine const QString aLine  ) 
 

Add a single line to the lines for this entry.

Definition at line 35 of file changelog.cpp.

References lines.

void ChangeLogEntry::addLines const QStringList someLines  ) 
 

Add a bunch of lines for this entry.

Definition at line 40 of file changelog.cpp.

References lines.

Referenced by CvsServicePartImpl::commit().

void ChangeLogEntry::addToLog const QString logFilePath,
const bool  prepend = true,
const QString startLineString = "\t"
 

Once the entry is completed one would like to write on a file! (You may add on start of file prepend == true, or append on tail (prepend == false).

Definition at line 51 of file changelog.cpp.

References streamCopy(), and toString().

Referenced by CvsServicePartImpl::commit().

QString ChangeLogEntry::toString const QString startLineString = QString::null  )  const
 

Pretty format for this entry: you may insert a line tag (such as tab ("\t") or 4 spaces (" ") or whatever you want (such as "\t * ").

Definition at line 109 of file changelog.cpp.

References authorEmail, authorName, date, and lines.

Referenced by addToLog(), and CvsServicePartImpl::commit().


Member Data Documentation

QString ChangeLogEntry::authorEmail
 

Definition at line 39 of file changelog.h.

Referenced by ChangeLogEntry(), and toString().

QString ChangeLogEntry::authorName
 

Definition at line 39 of file changelog.h.

Referenced by ChangeLogEntry(), and toString().

QString ChangeLogEntry::date
 

Definition at line 39 of file changelog.h.

Referenced by ChangeLogEntry(), and toString().

QStringList ChangeLogEntry::lines
 

Definition at line 42 of file changelog.h.

Referenced by addLine(), addLines(), and toString().


The documentation for this struct was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:37:31 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003