KNS3::DownloadWidget Class Reference

KNewStuff download widget. More...

#include <downloadwidget.h>

Inheritance diagram for KNS3::DownloadWidget:

List of all members.

Public Member Functions
	DownloadWidget (QWidget *parent=0)
	DownloadWidget (const QString &configFile, QWidget *parent=0)
	~DownloadWidget ()
KNS3::Entry::List	changedEntries ()
KNS3::Entry::List	installedEntries ()

---

Detailed Description

KNewStuff download widget.

The download widget will present items to the user for installation, updates and removal. Preview images as well as other meta information can be seen.

knsrc Files

The Dialog is configured by a .knsrc file containing the KHotNewStuff configuration. Your application should install a file called: $KDEDIR/share/config/appname.knsrc

The file could look like this for wallpapers:

   [KNewStuff3]
   ProvidersUrl=http://download.kde.org/ocs/providers.xml
   Categories=KDE Wallpaper 1920x1200,KDE Wallpaper 1600x1200
   StandardResource=wallpaper
   Uncompress=archive
 

Uncompress can be one of: always, never or archive:

1. always: assume all downloaded files are archives and need to be extracted
2. never: never try to extract the file
3. archive: if the file is an archive, uncompress it, otherwise just pass it on

You have different options to set the target install directory:

1. StandardResource: standard ressouce dir, such as .kde/share/wallpapers. This is what KStandardDirs::locateLocal(name) will return.
2. TargetDir: a directory in the share/apps section, such as .kde/share/apps/wallpapers. This is what KStandardDirs::locateLocal("data", name) will return.
3. XdgTargetDir: a directory in the $XDG_DATA_HOME directory such as .local/share/wallpapers.

Since:

4.5

Definition at line 72 of file downloadwidget.h.

---

Constructor & Destructor Documentation

DownloadWidget::DownloadWidget

(

QWidget *

parent = 0

)

[explicit]

Create a download widget that lets the user install, update and uninstall contents.

It will try to find a appname.knsrc file with the configuration. Appname is the name of your application as provided in the about data->

Parameters:

parent

the parent of the dialog

Definition at line 42 of file downloadwidget.cpp.

DownloadWidget::DownloadWidget	(	const QString &	configFile,
		QWidget *	parent = 0
	)		[explicit]

Create a download widget that lets the user install, update and uninstall contents.

Manually specify the name of a .knsrc file where the KHotNewStuff configuration can be found.

Parameters:

configFile	the name of the configuration file
parent	the parent of the dialog

Definition at line 51 of file downloadwidget.cpp.

DownloadWidget::~DownloadWidget

(

)

destructor

Definition at line 63 of file downloadwidget.cpp.

---

Member Function Documentation

Entry::List DownloadWidget::changedEntries

(

)

The list of entries with changed status (installed/uninstalled)

Returns:

the list of entries

Definition at line 68 of file downloadwidget.cpp.

Entry::List DownloadWidget::installedEntries

(

)

The list of entries that have been newly installed.

Returns:

the list of entries

Definition at line 77 of file downloadwidget.cpp.

---

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

• downloadwidget.h
• downloadwidget.cpp