KDevelop API Documentation

KDevLicense Class Reference

#include <kdevlicense.h>

Collaboration diagram for KDevLicense:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KDevLicense (const QString &name, const QString &fileName)
 Constructs a KDevLicense and loads the given file into m_rawLines.
QString assemble (KDevFile::CommentingStyle commentingStyle, const QString &author, const QString &email, int leadingSpaces)
 Assembles the license to a string suiteable for replacement of a $LICENSE$ tag.
QString name () const
 returns the name of this license.
QStringList copyFiles ()
 returns list of files tat must be present in the project's root directory if any source files uses this license.

Private Member Functions

void readFile (const QString &fileName)

Private Attributes

QString m_name
 Name of this license.
QStringList m_rawLines
 Raw lines of the license.
QStringList m_copyFiles
 List of files that must be added to the project, if any file in the project uses this license.

Constructor & Destructor Documentation

KDevLicense::KDevLicense const QString name,
const QString fileName
 

Constructs a KDevLicense and loads the given file into m_rawLines.

Definition at line 26 of file kdevlicense.cpp.

References readFile().


Member Function Documentation

QString KDevLicense::assemble KDevFile::CommentingStyle  commentingStyle,
const QString author,
const QString email,
int  leadingSpaces
 

Assembles the license to a string suiteable for replacement of a $LICENSE$ tag.

Definition at line 61 of file kdevlicense.cpp.

References m_rawLines.

Referenced by AppWizardDialog::licenseChanged().

QStringList KDevLicense::copyFiles  )  [inline]
 

returns list of files tat must be present in the project's root directory if any source files uses this license.

Definition at line 52 of file kdevlicense.h.

Referenced by AppWizardDialog::accept().

QString KDevLicense::name  )  const [inline]
 

returns the name of this license.

Definition at line 46 of file kdevlicense.h.

void KDevLicense::readFile const QString fileName  )  [private]
 

Definition at line 32 of file kdevlicense.cpp.

References m_copyFiles, and m_rawLines.

Referenced by KDevLicense().


Member Data Documentation

QStringList KDevLicense::m_copyFiles [private]
 

List of files that must be added to the project, if any file in the project uses this license.

Definition at line 71 of file kdevlicense.h.

Referenced by readFile().

QString KDevLicense::m_name [private]
 

Name of this license.

Definition at line 61 of file kdevlicense.h.

QStringList KDevLicense::m_rawLines [private]
 

Raw lines of the license.

Should contain no spaces at the start or end of each line.

Definition at line 66 of file kdevlicense.h.

Referenced by assemble(), and readFile().


The documentation for this class 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 Wed Mar 23 00:22:44 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003