KNS::Entry Class Reference

KNewStuff data entry container. More...

#include <entry.h>

List of all members.

Public Member Functions

Entry (const QDomElement &)

~Entry ()

void setName (const QString &)

QString name () const

void setType (const QString &)

QString type () const

void setAuthor (const QString &)

QString author () const

void setLicence (const QString &)

QString license () const

void setSummary (const QString &, const QString &lang=QString::null)

QString summary (const QString &lang=QString::null) const

void setVersion (const QString &)

QString version () const

void setRelease (int)

int release () const

void setReleaseDate (const QDate &)

QDate releaseDate () const

void setPayload (const KURL &, const QString &lang=QString::null)

KURL payload (const QString &lang=QString::null) const

void setPreview (const KURL &, const QString &lang=QString::null)

KURL preview (const QString &lang=QString::null) const

void setRating (int)

int rating ()

void setDownloads (int)

int downloads ()

QString fullName ()

QStringList langs ()

void parseDomElement (const QDomElement &)

QDomElement createDomElement (QDomDocument &, QDomElement &parent)

Protected Member Functions

QDomElement addElement (QDomDocument &doc, QDomElement &parent, const QString &tag, const QString &value)

Detailed Description

KNewStuff data entry container.

This class provides accessor methods to the data objects as used by KNewStuff. It should probably not be used directly by the application.

Author:: Cornelius Schumacher (schumacher@kde.org)

Maintainer:: Josef Spillner (spillner@kde.org)

Definition at line 44 of file entry.h.

Constructor & Destructor Documentation

Entry::Entry ( const QDomElement & )

Constructor.
Definition at line 31 of file entry.cpp.

Entry::~Entry ( )

Destructor.
Definition at line 36 of file entry.cpp.

Member Function Documentation

void Entry::setName ( const QString & )

Sets the (unique) name for this data object.
Definition at line 41 of file entry.cpp.

QString Entry::name ( ) const

Retrieve the name of the data object.

Returns:
object name
Definition at line 46 of file entry.cpp.
Referenced by KNS::DownloadDialog::addEntry(), and fullName().

void Entry::setType ( const QString & )

Sets the application type, e.g.
'kdesktop/wallpaper'. Definition at line 52 of file entry.cpp.

QString Entry::type ( ) const

Retrieve the type of the data object.

Returns:
object type
Definition at line 57 of file entry.cpp.

void Entry::setAuthor ( const QString & )

Sets the full name of the object's author.
Definition at line 63 of file entry.cpp.

QString Entry::author ( ) const

Retrieve the author's name of the object.

Returns:
object author
Definition at line 68 of file entry.cpp.

void Entry::setLicence ( const QString & )

Sets the license (abbreviation) applicable to the object.
Definition at line 74 of file entry.cpp.

QString Entry::license ( ) const

Retrieve the license name of the object.

Returns:
object license
Definition at line 79 of file entry.cpp.

void Entry::setSummary ( const QString & ,

const QString & lang = QString::null

)

Sets a short description on what the object is all about.
Definition at line 85 of file entry.cpp.

QString Entry::summary ( const QString & lang = QString::null ) const

Retrieve a short description about the object.

Parameters:

lang preferred language, or QString::null for KDE default

Returns:
object description
Definition at line 92 of file entry.cpp.

void Entry::setVersion ( const QString & )

Sets the version number.
Definition at line 105 of file entry.cpp.

QString Entry::version ( ) const

Retrieve the version string of the object.

Returns:
object version
Definition at line 110 of file entry.cpp.
Referenced by KNS::DownloadDialog::addEntry(), and fullName().

void Entry::setRelease ( int )

Sets the release number, which is increased for feature-equal objects with the same version number, but slightly updated contents.
Definition at line 116 of file entry.cpp.

int Entry::release ( ) const

Retrieve the release number of the object.

Returns:
object release
Definition at line 121 of file entry.cpp.
Referenced by fullName().

void Entry::setReleaseDate ( const QDate & )

Sets the release date.
Definition at line 127 of file entry.cpp.

QDate Entry::releaseDate ( ) const

Retrieve the date of the object's publication.

Returns:
object release date
Definition at line 132 of file entry.cpp.
Referenced by KNS::DownloadDialog::addEntry().

void Entry::setPayload ( const KURL & ,

const QString & lang = QString::null

)

Sets the object's file.
Definition at line 138 of file entry.cpp.
Referenced by KNS::Engine::upload().

KURL Entry::payload ( const QString & lang = QString::null ) const

Retrieve the file name of the object.

Parameters:

lang preferred language, or QString::null for KDE default

Returns:
object filename
Definition at line 145 of file entry.cpp.
References payload().
Referenced by KNS::Engine::download(), and payload().

void Entry::setPreview ( const KURL & ,

const QString & lang = QString::null

)

Sets the object's preview file, if available.
This should be a picture file. Definition at line 155 of file entry.cpp.

KURL Entry::preview ( const QString & lang = QString::null ) const

Retrieve the file name of an image containing a preview of the object.

Parameters:

lang preferred language, or QString::null for KDE default

Returns:
object preview filename
Definition at line 162 of file entry.cpp.
References preview().
Referenced by preview().

void Entry::setRating ( int )

Sets the rating between 0 (worst) and 10 (best).
Definition at line 172 of file entry.cpp.

int Entry::rating ( )

Retrieve the rating for the object, which has been determined by its users and thus might change over time.

Returns:
object rating
Definition at line 177 of file entry.cpp.
Referenced by KNS::DownloadDialog::addEntry().

void Entry::setDownloads ( int )

Sets the number of downloads.
Definition at line 183 of file entry.cpp.

int Entry::downloads ( )

Retrieve the download count for the object, which has been determined by its hosting sites and thus might change over time.

Returns:
object download count
Definition at line 188 of file entry.cpp.
Referenced by KNS::DownloadDialog::addEntry().

QString Entry::fullName ( )

Return the full name for the meta information.
It is constructed as name-version-release. Definition at line 193 of file entry.cpp.
References name(), release(), and version().
Referenced by KNewStuffGeneric::downloadDestination(), and KNS::Engine::upload().

QStringList Entry::langs ( )

Return the list of languages this object supports.
Definition at line 198 of file entry.cpp.
Referenced by KNS::Engine::upload().

The documentation for this class was generated from the following files:


Public Member Functions
	Entry (const QDomElement &)
	~Entry ()
void	setName (const QString &)
QString	name () const
void	setType (const QString &)
QString	type () const
void	setAuthor (const QString &)
QString	author () const
void	setLicence (const QString &)
QString	license () const
void	setSummary (const QString &, const QString &lang=QString::null)
QString	summary (const QString &lang=QString::null) const
void	setVersion (const QString &)
QString	version () const
void	setRelease (int)
int	release () const
void	setReleaseDate (const QDate &)
QDate	releaseDate () const
void	setPayload (const KURL &, const QString &lang=QString::null)
KURL	payload (const QString &lang=QString::null) const
void	setPreview (const KURL &, const QString &lang=QString::null)
KURL	preview (const QString &lang=QString::null) const
void	setRating (int)
int	rating ()
void	setDownloads (int)
int	downloads ()
QString	fullName ()
QStringList	langs ()
void	parseDomElement (const QDomElement &)
QDomElement	createDomElement (QDomDocument &, QDomElement &parent)
Protected Member Functions
QDomElement	addElement (QDomDocument &doc, QDomElement &parent, const QString &tag, const QString &value)

korganizer Library API Documentation

KNS::Entry Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation