KNS::Entry Class Reference

KNewStuff data entry container. More...

#include <entry.h>


Public Member Functions
QString	author () const
QString	authorEmail () const
QDomElement	createDomElement (QDomDocument &, QDomElement &parent)
int	downloads ()
	Entry (const QDomElement &)
	Entry ()
QString	fullName ()
QStringList	langs ()
QString	license () const
QString	name (const QString &lang) const
QString	name () const
void	parseDomElement (const QDomElement &)
KURL	payload (const QString &lang=QString::null) const
KURL	preview (const QString &lang=QString::null) const
int	rating ()
int	release () const
QDate	releaseDate () const
void	setAuthor (const QString &)
void	setAuthorEmail (const QString &)
void	setDownloads (int)
void	setLicence (const QString &)
void	setName (const QString &, const QString &)
void	setName (const QString &)
void	setPayload (const KURL &, const QString &lang=QString::null)
void	setPreview (const KURL &, const QString &lang=QString::null)
void	setRating (int)
void	setRelease (int)
void	setReleaseDate (const QDate &)
void	setSummary (const QString &, const QString &lang=QString::null)
void	setType (const QString &)
void	setVersion (const QString &)
QString	summary (const QString &lang=QString::null) const
QString	type () const
QString	version () const
	~Entry ()
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 ( )

Definition at line 92 of file entry.cpp.

Entry::Entry ( const QDomElement & e )

Constructor.

Definition at line 98 of file entry.cpp.

Entry::~Entry ( )

Destructor.

Definition at line 104 of file entry.cpp.

Member Function Documentation

QDomElement Entry::addElement	(	QDomDocument &	doc,
		QDomElement &	parent,
		const QString &	tag,
		const QString &	value
	)			`[protected]`

Definition at line 377 of file entry.cpp.

QString Entry::author ( ) const

Retrieve the author's name of the object.

Returns:: object author

Definition at line 148 of file entry.cpp.

QString Entry::authorEmail ( ) const

Retrieve the author's email address of the object.

Returns:: object author email address

Definition at line 59 of file entry.cpp.

QDomElement Entry::createDomElement	(	QDomDocument &	doc,
		QDomElement &	parent
	)

For internal use only.

Definition at line 344 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 282 of file entry.cpp.

QString Entry::fullName ( )

Return the full name for the meta information.

It is constructed as name-version-release.

Definition at line 287 of file entry.cpp.

QStringList Entry::langs ( )

Return the list of languages this object supports.

Definition at line 295 of file entry.cpp.

QString Entry::license ( ) const

Retrieve the license name of the object.

Returns:: object license

Definition at line 159 of file entry.cpp.

QString Entry::name ( const QString & lang ) const

Retrieve the internationalised name of the data object.

Returns:: object name (potentially translated)

Definition at line 69 of file entry.cpp.

QString Entry::name ( ) const

Retrieve the name of the data object.

Returns:: object name

Definition at line 126 of file entry.cpp.

void Entry::parseDomElement ( const QDomElement & element )

For internal use only.

Definition at line 300 of file entry.cpp.

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 227 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 250 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 271 of file entry.cpp.

int Entry::release ( ) const

Retrieve the release number of the object.

Returns:: object release

Definition at line 203 of file entry.cpp.

QDate Entry::releaseDate ( ) const

Retrieve the date of the object's publication.

Returns:: object release date

Definition at line 214 of file entry.cpp.

void Entry::setAuthor ( const QString & author )

Sets the full name of the object's author.

Definition at line 143 of file entry.cpp.

void Entry::setAuthorEmail ( const QString & email )

Sets the email address of the object's author.

Definition at line 64 of file entry.cpp.

void Entry::setDownloads ( int downloads )

Sets the number of downloads.

For internal use only.

Definition at line 277 of file entry.cpp.

void Entry::setLicence ( const QString & license )

Sets the license (abbreviation) applicable to the object.

Definition at line 154 of file entry.cpp.

void Entry::setName	(	const QString &	name,
		const QString &	lang
	)

Sets the (internationalised) name for this data object.

Definition at line 83 of file entry.cpp.

void Entry::setName ( const QString & name )

Sets the (unique) name for this data object.

Definition at line 121 of file entry.cpp.

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

Sets the object's file.

Definition at line 220 of file entry.cpp.

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

Sets the object's preview file, if available.

This should be a picture file.

Definition at line 243 of file entry.cpp.

void Entry::setRating ( int rating )

Sets the rating between 0 (worst) and 10 (best).

For internal use only.

Definition at line 266 of file entry.cpp.

void Entry::setRelease ( int release )

Sets the release number, which is increased for feature-equal objects with the same version number, but slightly updated contents.

Definition at line 198 of file entry.cpp.

void Entry::setReleaseDate ( const QDate & d )

Sets the release date.

Definition at line 209 of file entry.cpp.

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

Sets a short description on what the object is all about.

Definition at line 165 of file entry.cpp.

void Entry::setType ( const QString & type )

Sets the application type, e.g.

'kdesktop/wallpaper'.

Definition at line 132 of file entry.cpp.

void Entry::setVersion ( const QString & version )

Sets the version number.

Definition at line 187 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 172 of file entry.cpp.

QString Entry::type ( ) const

Retrieve the type of the data object.

Returns:: object type

Definition at line 137 of file entry.cpp.

QString Entry::version ( ) const

Retrieve the version string of the object.

Returns:: object version

Definition at line 192 of file entry.cpp.

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

KNewStuff

KNS::Entry Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

KNewStuff

API Reference