KNS::Entry Class Reference

#include <entry.h>

Public Member Functions
	Entry (const TQDomElement &)
	~Entry ()
void	setName (const TQString &)
void	setName (const TQString &, const TQString &)
TQString	name () const
TQString	name (const TQString &lang) const
void	setType (const TQString &)
TQString	type () const
void	setAuthor (const TQString &)
TQString	author () const
void	setAuthorEmail (const TQString &)
TQString	authorEmail () const
void	setLicence (const TQString &)
TQString	license () const
void	setSummary (const TQString &, const TQString &lang=TQString::null)
TQString	summary (const TQString &lang=TQString::null) const
void	setVersion (const TQString &)
TQString	version () const
void	setRelease (int)
int	release () const
void	setReleaseDate (const TQDate &)
TQDate	releaseDate () const
void	setPayload (const KURL &, const TQString &lang=TQString::null)
KURL	payload (const TQString &lang=TQString::null) const
void	setPreview (const KURL &, const TQString &lang=TQString::null)
KURL	preview (const TQString &lang=TQString::null) const
void	setRating (int)
int	rating ()
void	setDownloads (int)
int	downloads ()
TQString	fullName ()
TQStringList	langs ()
void	parseDomElement (const TQDomElement &)
TQDomElement	createDomElement (TQDomDocument &, TQDomElement &parent)

Protected Member Functions
TQDomElement	addElement (TQDomDocument &doc, TQDomElement &parent, const TQString &tag, const TQString &value)

Detailed Description

TDENewStuff data entry container.

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

Author

Cornelius Schumacher (schum.nosp@m.ache.nosp@m.r@kde.nosp@m..org)

Maintainer:

Josef Spillner (spill.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg)

Definition at line 45 of file entry.h.

Constructor & Destructor Documentation

Entry()

Entry::Entry

(

const TQDomElement &

e

)

Constructor.

Definition at line 99 of file entry.cpp.

~Entry()

Entry::~Entry

(

)

Destructor.

Definition at line 105 of file entry.cpp.

Member Function Documentation

author()

TQString Entry::author

(

)

const

Retrieve the author's name of the object.

Returns

object author

Definition at line 149 of file entry.cpp.

authorEmail()

TQString Entry::authorEmail

(

)

const

Retrieve the author's email address of the object.

Returns

object author email address

Definition at line 60 of file entry.cpp.

downloads()

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 283 of file entry.cpp.

fullName()

TQString Entry::fullName

(

)

Return the full name for the meta information.

It is constructed as name-version-release.

Definition at line 288 of file entry.cpp.

langs()

TQStringList Entry::langs

(

)

Return the list of languages this object supports.

Definition at line 296 of file entry.cpp.

license()

TQString Entry::license

(

)

const

Retrieve the license name of the object.

Returns

object license

Definition at line 160 of file entry.cpp.

name() [1/2]

TQString Entry::name

(

)

const

Retrieve the name of the data object.

Returns

object name

Definition at line 127 of file entry.cpp.

name() [2/2]

TQString Entry::name

(

const TQString &

lang

)

const

Retrieve the internationalised name of the data object.

Returns

object name (potentially translated)

Definition at line 70 of file entry.cpp.

payload()

KURL Entry::payload

(

const TQString &

lang = TQString::null

)

const

Retrieve the file name of the object.

Parameters

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

Returns

object filename

Definition at line 228 of file entry.cpp.

preview()

KURL Entry::preview

(

const TQString &

lang = TQString::null

)

const

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

Parameters

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

Returns

object preview filename

Definition at line 251 of file entry.cpp.

rating()

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 272 of file entry.cpp.

release()

int Entry::release

(

)

const

Retrieve the release number of the object.

Returns

object release

Definition at line 204 of file entry.cpp.

releaseDate()

TQDate Entry::releaseDate

(

)

const

Retrieve the date of the object's publication.

Returns

object release date

Definition at line 215 of file entry.cpp.

setAuthor()

void Entry::setAuthor

(

const TQString &

author

)

Sets the full name of the object's author.

Definition at line 144 of file entry.cpp.

setAuthorEmail()

void Entry::setAuthorEmail

(

const TQString &

email

)

Sets the email address of the object's author.

Definition at line 65 of file entry.cpp.

setDownloads()

void Entry::setDownloads

(

int

downloads

)

Sets the number of downloads.

Definition at line 278 of file entry.cpp.

setLicence()

void Entry::setLicence

(

const TQString &

license

)

Sets the license (abbreviation) applicable to the object.

Definition at line 155 of file entry.cpp.

setName() [1/2]

void Entry::setName

(

const TQString &

name

)

Sets the (unique) name for this data object.

Definition at line 122 of file entry.cpp.

setName() [2/2]

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

Sets the (internationalised) name for this data object.

Definition at line 84 of file entry.cpp.

setPayload()

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

Sets the object's file.

Definition at line 221 of file entry.cpp.

setPreview()

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

Sets the object's preview file, if available.

This should be a picture file.

Definition at line 244 of file entry.cpp.

setRating()

void Entry::setRating

(

int

rating

)

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

Definition at line 267 of file entry.cpp.

setRelease()

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 199 of file entry.cpp.

setReleaseDate()

void Entry::setReleaseDate

(

const TQDate &

d

)

Sets the release date.

Definition at line 210 of file entry.cpp.

setSummary()

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

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

Definition at line 166 of file entry.cpp.

setType()

void Entry::setType

(

const TQString &

type

)

Sets the application type, e.g.

'kdesktop/wallpaper'.

Definition at line 133 of file entry.cpp.

setVersion()

void Entry::setVersion

(

const TQString &

version

)

Sets the version number.

Definition at line 188 of file entry.cpp.

summary()

TQString Entry::summary

(

const TQString &

lang = TQString::null

)

const

Retrieve a short description about the object.

Parameters

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

Returns

object description

Definition at line 173 of file entry.cpp.

type()

TQString Entry::type

(

)

const

Retrieve the type of the data object.

Returns

object type

Definition at line 138 of file entry.cpp.

version()

TQString Entry::version

(

)

const

Retrieve the version string of the object.

Returns

object version

Definition at line 193 of file entry.cpp.

---

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

• entry.h
• entry.cpp