KNS3::EntryInternal Class Reference

#include <entryinternal.h>

Classes
struct	DownloadLinkInformation

Public Types
typedef QList< EntryInternal >	List
enum	PreviewType {   PreviewSmall1, PreviewSmall2, PreviewSmall3, PreviewBig1,   PreviewBig2, PreviewBig3 }
enum	Source { Cache, Online, Registry }

Public Member Functions
	EntryInternal ()
	EntryInternal (const EntryInternal &other)
	~EntryInternal ()
void	appendDownloadLinkInformation (const DownloadLinkInformation &info)
Author	author () const
QString	category () const
QString	changelog () const
void	clearDownloadLinkInformation ()
QString	donationLink () const
int	downloadCount () const
int	downloadLinkCount () const
QList< DownloadLinkInformation >	downloadLinkInformationList () const
QDomElement	entryXML () const
KUrl	homepage () const
QStringList	installedFiles () const
bool	isValid () const
QString	knowledgebaseLink () const
QString	license () const
QString	name () const
int	numberFans () const
int	numberKnowledgebaseEntries () const
bool	operator< (const EntryInternal &other) const
EntryInternal &	operator= (const EntryInternal &other)
bool	operator== (const EntryInternal &other) const
QString	payload () const
QImage	previewImage (PreviewType type=PreviewSmall1) const
QString	previewUrl (PreviewType type=PreviewSmall1) const
QString	providerId () const
int	rating () const
QDate	releaseDate () const
void	setAuthor (const Author &author)
void	setCategory (const QString &category)
void	setChangelog (const QString &changelog)
void	setDonationLink (const QString &link)
void	setDownloadCount (int downloads)
bool	setEntryXML (const QDomElement &xmldata)
void	setHomepage (const KUrl &page)
void	setInstalledFiles (const QStringList &files)
void	setKnowledgebaseLink (const QString &link)
void	setLicense (const QString &license)
void	setName (const QString &name)
void	setNumberFans (int fans)
void	setNumberKnowledgebaseEntries (int num)
void	setPayload (const QString &url)
void	setPreviewImage (const QImage &image, PreviewType type=PreviewSmall1)
void	setPreviewUrl (const QString &url, PreviewType type=PreviewSmall1)
void	setProviderId (const QString &id)
void	setRating (int rating)
void	setReleaseDate (const QDate &releasedate)
void	setSource (Source source)
void	setStatus (Entry::Status status)
void	setSummary (const QString &summary)
void	setUnInstalledFiles (const QStringList &files)
void	setUniqueId (const QString &id)
void	setUpdateReleaseDate (const QDate &releasedate)
void	setUpdateVersion (const QString &version)
void	setVersion (const QString &version)
Source	source () const
Entry::Status	status () const
QString	summary () const
Entry	toEntry () const
QStringList	uninstalledFiles () const
QString	uniqueId () const
QDate	updateReleaseDate () const
QString	updateVersion () const
QString	version () const

Static Public Member Functions
static KNS3::EntryInternal	fromEntry (const KNS3::Entry &entry)

Detailed Description

KNewStuff data entry container.

This class provides accessor methods to the data objects as used by KNewStuff.

Author

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

Maintainer:

Jeremy Whiting (jpwhi.nosp@m.ting.nosp@m.@kde..nosp@m.org)

Definition at line 54 of file entryinternal.h.

Member Typedef Documentation

typedef QList<EntryInternal> KNS3::EntryInternal::List

Definition at line 57 of file entryinternal.h.

Member Enumeration Documentation

enum KNS3::EntryInternal::PreviewType

Enumerator
PreviewSmall1
PreviewSmall2
PreviewSmall3
PreviewBig1
PreviewBig2
PreviewBig3

Definition at line 70 of file entryinternal.h.

enum KNS3::EntryInternal::Source

Source of the entry, A entry's data is coming from either cache, or an online provider this helps the engine know which data to use when merging cached entries with online entry data.

Enumerator
Cache
Online
Registry

Definition at line 64 of file entryinternal.h.

Constructor & Destructor Documentation

EntryInternal::EntryInternal

(

)

Constructor.

Definition at line 89 of file entryinternal.cpp.

EntryInternal::EntryInternal

(

const EntryInternal &

other

)

Definition at line 94 of file entryinternal.cpp.

EntryInternal::~EntryInternal

(

)

Destructor.

Definition at line 115 of file entryinternal.cpp.

Member Function Documentation

void KNS3::EntryInternal::appendDownloadLinkInformation

(

const DownloadLinkInformation &

info

)

Definition at line 407 of file entryinternal.cpp.

Author EntryInternal::author

(

)

const

Retrieve the author of the object.

Returns

object author

Definition at line 174 of file entryinternal.cpp.

QString EntryInternal::category

(

)

const

Retrieve the category of the data object.

Returns

object category

Definition at line 154 of file entryinternal.cpp.

QString EntryInternal::changelog

(

)

const

Definition at line 209 of file entryinternal.cpp.

void EntryInternal::clearDownloadLinkInformation

(

)

Definition at line 412 of file entryinternal.cpp.

QString EntryInternal::donationLink

(

)

const

Definition at line 314 of file entryinternal.cpp.

int EntryInternal::downloadCount

(

)

const

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 294 of file entryinternal.cpp.

int KNS3::EntryInternal::downloadLinkCount

(

)

const

Definition at line 397 of file entryinternal.cpp.

QList< KNS3::EntryInternal::DownloadLinkInformation > KNS3::EntryInternal::downloadLinkInformationList

(

)

const

Definition at line 402 of file entryinternal.cpp.

QDomElement KNS3::EntryInternal::entryXML

(

)

const

get the xml string for the entry

Definition at line 510 of file entryinternal.cpp.

KNS3::EntryInternal EntryInternal::fromEntry ( const KNS3::Entry &  entry )

static

Definition at line 581 of file entryinternal.cpp.

KUrl EntryInternal::homepage

(

)

const

Definition at line 164 of file entryinternal.cpp.

QStringList KNS3::EntryInternal::installedFiles

(

)

const

Retrieve the locally installed files.

Returns

file names

Definition at line 382 of file entryinternal.cpp.

bool EntryInternal::isValid

(

)

const

Definition at line 119 of file entryinternal.cpp.

QString EntryInternal::knowledgebaseLink

(

)

const

Definition at line 333 of file entryinternal.cpp.

QString EntryInternal::license

(

)

const

Retrieve the license name of the object.

Returns

object license

Definition at line 184 of file entryinternal.cpp.

QString EntryInternal::name

(

)

const

Retrieve the name of the data object.

Returns

object name (potentially translated)

Definition at line 124 of file entryinternal.cpp.

int EntryInternal::numberFans

(

)

const

Definition at line 304 of file entryinternal.cpp.

int EntryInternal::numberKnowledgebaseEntries

(

)

const

Definition at line 324 of file entryinternal.cpp.

bool EntryInternal::operator<

(

const EntryInternal &

other

)

const

Definition at line 105 of file entryinternal.cpp.

EntryInternal & EntryInternal::operator=

(

const EntryInternal &

other

)

Definition at line 99 of file entryinternal.cpp.

bool EntryInternal::operator==

(

const EntryInternal &

other

)

const

Definition at line 110 of file entryinternal.cpp.

QString EntryInternal::payload

(

)

const

Retrieve the file name of the object.

Returns

object filename

Definition at line 234 of file entryinternal.cpp.

QImage EntryInternal::previewImage

(

PreviewType

type = PreviewSmall1

)

const

This will not be loaded automatically, instead use Engine to load the actual images.

Definition at line 274 of file entryinternal.cpp.

QString EntryInternal::previewUrl

(

PreviewType

type = PreviewSmall1

)

const

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

Returns

object preview filename

Definition at line 264 of file entryinternal.cpp.

QString EntryInternal::providerId

(

)

const

The id of the provider this entry belongs to.

Definition at line 144 of file entryinternal.cpp.

int EntryInternal::rating

(

)

const

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 284 of file entryinternal.cpp.

QDate EntryInternal::releaseDate

(

)

const

Retrieve the date of the object's publication.

Returns

object release date

Definition at line 224 of file entryinternal.cpp.

void EntryInternal::setAuthor

(

const Author &

author

)

Sets the author of the object.

Definition at line 179 of file entryinternal.cpp.

void EntryInternal::setCategory

(

const QString &

category

)

Sets the data category, e.g.

'kdesktop/wallpaper'.

Definition at line 159 of file entryinternal.cpp.

void EntryInternal::setChangelog

(

const QString &

changelog

)

The user written changelog.

Definition at line 204 of file entryinternal.cpp.

void EntryInternal::setDonationLink

(

const QString &

link

)

Definition at line 319 of file entryinternal.cpp.

void EntryInternal::setDownloadCount

(

int

downloads

)

Sets the number of downloads.

Definition at line 299 of file entryinternal.cpp.

bool KNS3::EntryInternal::setEntryXML

(

const QDomElement &

xmldata

)

set the xml for the entry parses the xml and sets the private members accordingly used to deserialize data loaded from provider

Parameters

xmldata

string to load xml data from

Returns

whether or not setting the values was successful

Definition at line 417 of file entryinternal.cpp.

void EntryInternal::setHomepage

(

const KUrl &

page

)

Definition at line 169 of file entryinternal.cpp.

void KNS3::EntryInternal::setInstalledFiles

(

const QStringList &

files

)

Set the files that have been installed by the install command.

Parameters

files

local file names

Definition at line 377 of file entryinternal.cpp.

void EntryInternal::setKnowledgebaseLink

(

const QString &

link

)

Definition at line 337 of file entryinternal.cpp.

void EntryInternal::setLicense

(

const QString &

license

)

Sets the license (abbreviation) applicable to the object.

Definition at line 189 of file entryinternal.cpp.

void EntryInternal::setName

(

const QString &

name

)

Sets the name for this data object.

Definition at line 129 of file entryinternal.cpp.

void EntryInternal::setNumberFans

(

int

fans

)

Definition at line 309 of file entryinternal.cpp.

void EntryInternal::setNumberKnowledgebaseEntries

(

int

num

)

Definition at line 328 of file entryinternal.cpp.

void EntryInternal::setPayload

(

const QString &

url

)

Sets the object's file.

Definition at line 239 of file entryinternal.cpp.

void EntryInternal::setPreviewImage	(	const QImage &	image,
		PreviewType	type = PreviewSmall1
	)

Definition at line 279 of file entryinternal.cpp.

void EntryInternal::setPreviewUrl	(	const QString &	url,
		PreviewType	type = PreviewSmall1
	)

Sets the object's preview file, if available.

This should be a picture file.

Definition at line 269 of file entryinternal.cpp.

void EntryInternal::setProviderId

(

const QString &

id

)

Definition at line 149 of file entryinternal.cpp.

void EntryInternal::setRating

(

int

rating

)

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

Definition at line 289 of file entryinternal.cpp.

void EntryInternal::setReleaseDate

(

const QDate &

releasedate

)

Sets the release date.

Definition at line 229 of file entryinternal.cpp.

void EntryInternal::setSource

(

Source

source

)

The source of this entry can be Cache, Registry or Online -.

See also

source

Definition at line 362 of file entryinternal.cpp.

void EntryInternal::setStatus

(

Entry::Status

status

)

Returns the checksum for the entry.

If an empty string is returned, no checksum was assigned.

Returns

Checksum of this entry Sets the checksum of the entry. This will be a string representation of an MD5 sum of the entry's selected payload file.

checksum Checksum for the entry Returns the signature for the entry.

If an empty string is returned, no signature was assigned.

Returns

Signature of this entry Sets the signature of the entry. This will be a digital signature in OpenPGP-compliant format.

signature Signature for the entry Sets the entry's status. If no status is set, the default will be Invalid.

Parameters

status

New status of the entry

Definition at line 372 of file entryinternal.cpp.

void EntryInternal::setSummary

(

const QString &

summary

)

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

Definition at line 199 of file entryinternal.cpp.

void KNS3::EntryInternal::setUnInstalledFiles

(

const QStringList &

files

)

Set the files that have been uninstalled by the uninstall command.

Parameters

files

local file names

Since

4.1

Definition at line 387 of file entryinternal.cpp.

void EntryInternal::setUniqueId

(

const QString &

id

)

Definition at line 139 of file entryinternal.cpp.

void EntryInternal::setUpdateReleaseDate

(

const QDate &

releasedate

)

Sets the release date that is available as update.

Definition at line 249 of file entryinternal.cpp.

void EntryInternal::setUpdateVersion

(

const QString &

version

)

Sets the version number that is available as update.

Definition at line 259 of file entryinternal.cpp.

void EntryInternal::setVersion

(

const QString &

version

)

Sets the version number.

Definition at line 219 of file entryinternal.cpp.

EntryInternal::Source EntryInternal::source

(

)

const

Definition at line 357 of file entryinternal.cpp.

Entry::Status EntryInternal::status

(

)

const

Retrieves the entry's status.

Returns

Current status of the entry

Definition at line 367 of file entryinternal.cpp.

QString EntryInternal::summary

(

)

const

Retrieve a short description about the object.

Returns

object description

Definition at line 194 of file entryinternal.cpp.

Entry EntryInternal::toEntry

(

)

const

Definition at line 574 of file entryinternal.cpp.

QStringList KNS3::EntryInternal::uninstalledFiles

(

)

const

Retrieve the locally uninstalled files.

Returns

file names

Since

4.1

Definition at line 392 of file entryinternal.cpp.

QString EntryInternal::uniqueId

(

)

const

Definition at line 134 of file entryinternal.cpp.

QDate EntryInternal::updateReleaseDate

(

)

const

Retrieve the date of the newer version that is available as update.

Returns

object release date

Definition at line 244 of file entryinternal.cpp.

QString EntryInternal::updateVersion

(

)

const

Retrieve the version string of the object that is available as update.

Returns

object version

Definition at line 254 of file entryinternal.cpp.

QString EntryInternal::version

(

)

const

Retrieve the version string of the object.

Returns

object version

Definition at line 214 of file entryinternal.cpp.

---

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

• entryinternal.h
• entryinternal.cpp