• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • knewstuff
 

knewstuff

  • KNS
  • Entry
Public Member Functions | Protected Member Functions | List of all members
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

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 (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 44 of file entry.h.

Constructor & Destructor Documentation

Entry::Entry ( const TQDomElement &  e)

Constructor.

Definition at line 98 of file entry.cpp.

Entry::~Entry ( )

Destructor.

Definition at line 104 of file entry.cpp.

Member Function Documentation

TQString Entry::author ( ) const

Retrieve the author's name of the object.

Returns
object author

Definition at line 148 of file entry.cpp.

TQString 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.

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.

TQString 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.

TQStringList Entry::langs ( )

Return the list of languages this object supports.

Definition at line 295 of file entry.cpp.

TQString Entry::license ( ) const

Retrieve the license name of the object.

Returns
object license

Definition at line 159 of file entry.cpp.

TQString Entry::name ( ) const

Retrieve the name of the data object.

Returns
object name

Definition at line 126 of file entry.cpp.

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

Retrieve the internationalised name of the data object.

Returns
object name (potentially translated)

Definition at line 69 of file entry.cpp.

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

Retrieve the file name of the object.

Parameters
langpreferred language, or TQString::null for KDE default
Returns
object filename

Definition at line 227 of file entry.cpp.

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

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

Parameters
langpreferred language, or TQString::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.

TQDate 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 TQString &  author)

Sets the full name of the object's author.

Definition at line 143 of file entry.cpp.

void Entry::setAuthorEmail ( const TQString &  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.

Definition at line 277 of file entry.cpp.

void Entry::setLicence ( const TQString &  license)

Sets the license (abbreviation) applicable to the object.

Definition at line 154 of file entry.cpp.

void Entry::setName ( const TQString &  name)

Sets the (unique) name for this data object.

Definition at line 121 of file entry.cpp.

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

Sets the (internationalised) name for this data object.

Definition at line 83 of file entry.cpp.

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

Sets the object's file.

Definition at line 220 of file entry.cpp.

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

void Entry::setRating ( int  rating)

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

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 TQDate &  d)

Sets the release date.

Definition at line 209 of file entry.cpp.

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

void Entry::setType ( const TQString &  type)

Sets the application type, e.g.

'kdesktop/wallpaper'.

Definition at line 132 of file entry.cpp.

void Entry::setVersion ( const TQString &  version)

Sets the version number.

Definition at line 187 of file entry.cpp.

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

Retrieve a short description about the object.

Parameters
langpreferred language, or TQString::null for KDE default
Returns
object description

Definition at line 172 of file entry.cpp.

TQString Entry::type ( ) const

Retrieve the type of the data object.

Returns
object type

Definition at line 137 of file entry.cpp.

TQString 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:
  • entry.h
  • entry.cpp

knewstuff

Skip menu "knewstuff"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

knewstuff

Skip menu "knewstuff"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for knewstuff by doxygen 1.8.11
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |