.TH "KNS::Entry" kde3 "11 Jun 2005" "Version Version 3.4.1" "knewstuff Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNS::Entry \- \fBKNewStuff\fP data entry container.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <entry.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBEntry\fP (const \fBQDomElement\fP &)"
.br
.ti -1c
.RI "\fB~Entry\fP ()"
.br
.ti -1c
.RI "void \fBsetName\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "void \fBsetType\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBtype\fP () const "
.br
.ti -1c
.RI "void \fBsetAuthor\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBauthor\fP () const "
.br
.ti -1c
.RI "void \fBsetLicence\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBlicense\fP () const "
.br
.ti -1c
.RI "void \fBsetSummary\fP (const \fBQString\fP &, const \fBQString\fP &lang=QString::null)"
.br
.ti -1c
.RI "\fBQString\fP \fBsummary\fP (const \fBQString\fP &lang=QString::null) const "
.br
.ti -1c
.RI "void \fBsetVersion\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBversion\fP () const "
.br
.ti -1c
.RI "void \fBsetRelease\fP (int)"
.br
.ti -1c
.RI "int \fBrelease\fP () const "
.br
.ti -1c
.RI "void \fBsetReleaseDate\fP (const \fBQDate\fP &)"
.br
.ti -1c
.RI "\fBQDate\fP \fBreleaseDate\fP () const "
.br
.ti -1c
.RI "void \fBsetPayload\fP (const KURL &, const \fBQString\fP &lang=QString::null)"
.br
.ti -1c
.RI "KURL \fBpayload\fP (const \fBQString\fP &lang=QString::null) const "
.br
.ti -1c
.RI "void \fBsetPreview\fP (const KURL &, const \fBQString\fP &lang=QString::null)"
.br
.ti -1c
.RI "KURL \fBpreview\fP (const \fBQString\fP &lang=QString::null) const "
.br
.ti -1c
.RI "void \fBsetRating\fP (int)"
.br
.ti -1c
.RI "int \fBrating\fP ()"
.br
.ti -1c
.RI "void \fBsetDownloads\fP (int)"
.br
.ti -1c
.RI "int \fBdownloads\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBfullName\fP ()"
.br
.ti -1c
.RI "\fBQStringList\fP \fBlangs\fP ()"
.br
.ti -1c
.RI "void \fBparseDomElement\fP (const \fBQDomElement\fP &)"
.br
.ti -1c
.RI "\fBQDomElement\fP \fBcreateDomElement\fP (\fBQDomDocument\fP &, \fBQDomElement\fP &parent)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBQDomElement\fP \fBaddElement\fP (\fBQDomDocument\fP &doc, \fBQDomElement\fP &parent, const \fBQString\fP &tag, const \fBQString\fP &value)"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBKNewStuff\fP data entry container. 

This class provides accessor methods to the data objects as used by \fBKNewStuff\fP. It should probably not be used directly by the application.
.PP
\fBAuthor:\fP
.RS 4
Cornelius Schumacher (schumacher@kde.org) 
.RE
.PP
\fBMaintainer:\fP.RS 4
Josef Spillner (spillner@kde.org) 
.RE
.PP

.PP
Definition at line 44 of file entry.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Entry::Entry (const \fBQDomElement\fP &)"
.PP
Constructor. 
.PP
Definition at line 34 of file entry.cpp.
.SS "Entry::~\fBEntry\fP ()"
.PP
Destructor. 
.PP
Definition at line 40 of file entry.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void Entry::setName (const \fBQString\fP &)"
.PP
Sets the (unique) name for this data object. 
.PP
Definition at line 45 of file entry.cpp.
.PP
References name().
.SS "\fBQString\fP Entry::name () const"
.PP
Retrieve the name of the data object. 
.PP
\fBReturns:\fP
.RS 4
object name 
.RE
.PP

.PP
Definition at line 50 of file entry.cpp.
.PP
Referenced by fullName(), and setName().
.SS "void Entry::setType (const \fBQString\fP &)"
.PP
Sets the application type, e.g. 
.PP
'kdesktop/wallpaper'. 
.PP
Definition at line 56 of file entry.cpp.
.PP
References type().
.SS "\fBQString\fP Entry::type () const"
.PP
Retrieve the type of the data object. 
.PP
\fBReturns:\fP
.RS 4
object type 
.RE
.PP

.PP
Definition at line 61 of file entry.cpp.
.PP
Referenced by setType().
.SS "void Entry::setAuthor (const \fBQString\fP &)"
.PP
Sets the full name of the object's author. 
.PP
Definition at line 67 of file entry.cpp.
.PP
References author().
.SS "\fBQString\fP Entry::author () const"
.PP
Retrieve the author's name of the object. 
.PP
\fBReturns:\fP
.RS 4
object author 
.RE
.PP

.PP
Definition at line 72 of file entry.cpp.
.PP
Referenced by setAuthor().
.SS "void Entry::setLicence (const \fBQString\fP &)"
.PP
Sets the license (abbreviation) applicable to the object. 
.PP
Definition at line 78 of file entry.cpp.
.PP
References license().
.SS "\fBQString\fP Entry::license () const"
.PP
Retrieve the license name of the object. 
.PP
\fBReturns:\fP
.RS 4
object license 
.RE
.PP

.PP
Definition at line 83 of file entry.cpp.
.PP
Referenced by setLicence().
.SS "void Entry::setSummary (const \fBQString\fP &, const \fBQString\fP & lang = \fCQString::null\fP)"
.PP
Sets a short description on what the object is all about. 
.PP
Definition at line 89 of file entry.cpp.
.PP
References QMap::insert().
.SS "\fBQString\fP Entry::summary (const \fBQString\fP & lang = \fCQString::null\fP) const"
.PP
Retrieve a short description about the object. 
.PP
\fBParameters:\fP
.RS 4
\fIlang\fP preferred language, or QString::null for KDE default 
.RE
.PP
\fBReturns:\fP
.RS 4
object description 
.RE
.PP

.PP
Definition at line 96 of file entry.cpp.
.PP
References QMap::begin(), QMap::isEmpty(), and langs().
.SS "void Entry::setVersion (const \fBQString\fP &)"
.PP
Sets the version number. 
.PP
Definition at line 111 of file entry.cpp.
.PP
References version().
.SS "\fBQString\fP Entry::version () const"
.PP
Retrieve the version string of the object. 
.PP
\fBReturns:\fP
.RS 4
object version 
.RE
.PP

.PP
Definition at line 116 of file entry.cpp.
.PP
Referenced by fullName(), and setVersion().
.SS "void Entry::setRelease (int)"
.PP
Sets the release number, which is increased for feature-equal objects with the same version number, but slightly updated contents. 
.PP
Definition at line 122 of file entry.cpp.
.SS "int Entry::release () const"
.PP
Retrieve the release number of the object. 
.PP
\fBReturns:\fP
.RS 4
object release 
.RE
.PP

.PP
Definition at line 127 of file entry.cpp.
.PP
Referenced by fullName().
.SS "void Entry::setReleaseDate (const \fBQDate\fP &)"
.PP
Sets the release date. 
.PP
Definition at line 133 of file entry.cpp.
.SS "\fBQDate\fP Entry::releaseDate () const"
.PP
Retrieve the date of the object's publication. 
.PP
\fBReturns:\fP
.RS 4
object release date 
.RE
.PP

.PP
Definition at line 138 of file entry.cpp.
.SS "void Entry::setPayload (const KURL &, const \fBQString\fP & lang = \fCQString::null\fP)"
.PP
Sets the object's file. 
.PP
Definition at line 144 of file entry.cpp.
.PP
References QMap::insert().
.SS "KURL Entry::payload (const \fBQString\fP & lang = \fCQString::null\fP) const"
.PP
Retrieve the file name of the object. 
.PP
\fBParameters:\fP
.RS 4
\fIlang\fP preferred language, or QString::null for KDE default 
.RE
.PP
\fBReturns:\fP
.RS 4
object filename 
.RE
.PP

.PP
Definition at line 151 of file entry.cpp.
.PP
References QMap::begin(), QMap::isEmpty(), langs(), and payload().
.PP
Referenced by payload().
.SS "void Entry::setPreview (const KURL &, const \fBQString\fP & lang = \fCQString::null\fP)"
.PP
Sets the object's preview file, if available. 
.PP
This should be a picture file. 
.PP
Definition at line 167 of file entry.cpp.
.PP
References QMap::insert().
.SS "KURL Entry::preview (const \fBQString\fP & lang = \fCQString::null\fP) const"
.PP
Retrieve the file name of an image containing a preview of the object. 
.PP
\fBParameters:\fP
.RS 4
\fIlang\fP preferred language, or QString::null for KDE default 
.RE
.PP
\fBReturns:\fP
.RS 4
object preview filename 
.RE
.PP

.PP
Definition at line 174 of file entry.cpp.
.PP
References QMap::begin(), QMap::isEmpty(), langs(), and preview().
.PP
Referenced by preview().
.SS "void Entry::setRating (int)"
.PP
Sets the rating between 0 (worst) and 10 (best). 
.PP
Definition at line 190 of file entry.cpp.
.SS "int Entry::rating ()"
.PP
Retrieve the rating for the object, which has been determined by its users and thus might change over time. 
.PP
\fBReturns:\fP
.RS 4
object rating 
.RE
.PP

.PP
Definition at line 195 of file entry.cpp.
.SS "void Entry::setDownloads (int)"
.PP
Sets the number of downloads. 
.PP
Definition at line 201 of file entry.cpp.
.SS "int Entry::downloads ()"
.PP
Retrieve the download count for the object, which has been determined by its hosting sites and thus might change over time. 
.PP
\fBReturns:\fP
.RS 4
object download count 
.RE
.PP

.PP
Definition at line 206 of file entry.cpp.
.SS "\fBQString\fP Entry::fullName ()"
.PP
Return the full name for the meta information. 
.PP
It is constructed as name-version-release. 
.PP
Definition at line 211 of file entry.cpp.
.PP
References name(), QString::number(), release(), and version().
.SS "\fBQStringList\fP Entry::langs ()"
.PP
Return the list of languages this object supports. 
.PP
Definition at line 216 of file entry.cpp.
.PP
Referenced by payload(), preview(), and summary().

.SH "Author"
.PP 
Generated automatically by Doxygen for knewstuff Library from the source code.
