KNS3::Entry

KNS3::Entry Class Reference

#include <entry.h>

Public Types

typedef QList< EntryList
 
enum  Status {
  Invalid, Downloadable, Installed, Updateable,
  Deleted, Installing, Updating
}
 

Public Member Functions

 Entry (const Entry &other)
 
QString category () const
 
QString changelog () const
 
QString id () const
 
QStringList installedFiles () const
 
QString license () const
 
QString name () const
 
uint numberOfComments () const
 
Entryoperator= (const Entry &other)
 
QList< QUrlpreviewImages () const
 
QList< QUrlpreviewThumbnails () const
 
QString providerId () const
 
uint rating () const
 
QString shortSummary () const
 
quint64 size () const
 
Status status () const
 
QString summary () const
 
QStringList uninstalledFiles () const
 
QString updateVersion () const
 
QUrl url () const
 
QString version () const
 

Detailed Description

KNewStuff information about changed entries.

This class provides information about the entries that have been installed while the new stuff dialog was shown. It is a minimal version that only gives applications what they need to know.

Since
4.4

Definition at line 32 of file entry.h.

Member Enumeration Documentation

Status of the entry.

An entry will be downloadable from the provider's site prior to the download. Once downloaded and installed, it will be either installed or updateable, implying an out-of-date installation. Finally, the entry can be deleted and hence show up as downloadable again. Entries not taking part in this cycle, for example those in upload, have an invalid status.

Definition at line 46 of file entry.h.

Member Function Documentation

QString Entry::category ( ) const

Retrieve the category of the data object.

Returns
object category

Definition at line 50 of file entry.cpp.

QString KNS3::Entry::changelog ( ) const
Returns
the asset's change log
Since
5.23

Definition at line 135 of file entry.cpp.

QString Entry::id ( ) const

Id of this Entry.

It is guaranteed to be unique for one provider. Id and ProviderId together identify this entry.

Returns
the id
Since
4.5

Definition at line 35 of file entry.cpp.

QStringList KNS3::Entry::installedFiles ( ) const

Retrieve the locally installed files.

Returns
file names

Definition at line 75 of file entry.cpp.

QString Entry::license ( ) const

Retrieve the license name of the object.

Returns
object license

Definition at line 55 of file entry.cpp.

QString Entry::name ( ) const

Retrieve the name of the data object.

Returns
object name

Definition at line 45 of file entry.cpp.

uint KNS3::Entry::numberOfComments ( ) const
Returns
the number of comments in the asset
Since
5.23

Definition at line 120 of file entry.cpp.

QList< QUrl > KNS3::Entry::previewImages ( ) const
Returns
a list of full previews of the asset
Since
5.23

Definition at line 96 of file entry.cpp.

QList< QUrl > KNS3::Entry::previewThumbnails ( ) const
Returns
a list of urls to small previews to be displayed as thumbnails
Since
5.23

Definition at line 105 of file entry.cpp.

QString Entry::providerId ( ) const

The Provider which is the source of the Entry.

Returns
the Id of the Provider
Since
4.5

Definition at line 40 of file entry.cpp.

uint KNS3::Entry::rating ( ) const
Returns
the rating of the asset, between 0 and 100
Since
5.23

Definition at line 125 of file entry.cpp.

QString KNS3::Entry::shortSummary ( ) const
Returns
a short one-line summary of the asset
Since
5.23

Definition at line 140 of file entry.cpp.

quint64 KNS3::Entry::size ( ) const
Returns
the advertised disk size of the asset
Since
5.23

Definition at line 114 of file entry.cpp.

Entry::Status Entry::status ( ) const

Retrieves the entry's status.

Returns
Current status of the entry

Definition at line 70 of file entry.cpp.

QString Entry::summary ( ) const

Retrieve a short description about the object.

Returns
object description

Definition at line 60 of file entry.cpp.

QStringList KNS3::Entry::uninstalledFiles ( ) const

Retrieve the locally uninstalled files.

Returns
file names

Definition at line 80 of file entry.cpp.

QString KNS3::Entry::updateVersion ( ) const
Returns
the available version

If the entry is not updateable, it will be the same as version.

See also
version()
Since
5.23

Definition at line 130 of file entry.cpp.

QUrl KNS3::Entry::url ( ) const
Returns
if available an url identifying the asset
Since
5.23

Definition at line 85 of file entry.cpp.

QString Entry::version ( ) const

Retrieve the version string of the object.

Returns
object version
See also
installedVersion()

Definition at line 65 of file entry.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 12 2020 22:42:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.