KNS3::DownloadManager Class Reference

KNewStuff update checker. More...

#include <downloadmanager.h>

Inheritance diagram for KNS3::DownloadManager:

List of all members.

Public Types
enum	SortOrder { Newest, Alphabetical, Rating, Downloads }
Signals
void	entryStatusChanged (const KNS3::Entry &entry)
void	searchResult (const KNS3::Entry::List &entries)
Public Member Functions
	DownloadManager (QObject *parent=0)
	DownloadManager (const QString &configFile, QObject *parent=0)
	~DownloadManager ()
void	checkForUpdates ()
void	installEntry (const KNS3::Entry &entry)
void	search (int page=0, int pageSize=100)
void	setSearchOrder (SortOrder order)
void	setSearchTerm (const QString &searchTerm)

---

Detailed Description

KNewStuff update checker.

This class can be used to search for KNewStuff items without using the widgets and to look for updates of already installed items without showing the dialog.

Since:

4.5

Definition at line 34 of file downloadmanager.h.

---

Member Enumeration Documentation

enum KNS3::DownloadManager::SortOrder

Enumerator:

Newest
Alphabetical
Rating
Downloads

Definition at line 39 of file downloadmanager.h.

---

Constructor & Destructor Documentation

DownloadManager::DownloadManager

(

QObject *

parent = 0

)

[explicit]

Create a DownloadManager It will try to find a appname.knsrc file (using KComponentData).

Appname is the name of your application as provided in the about data->

Parameters:

parent

the parent of the dialog

Definition at line 61 of file downloadmanager.cpp.

DownloadManager::DownloadManager	(	const QString &	configFile,
		QObject *	parent = 0
	)		[explicit]

Create a DownloadManager.

Manually specifying the name of the .knsrc file.

Parameters:

configFile	the name of the configuration file
parent

Definition at line 70 of file downloadmanager.cpp.

DownloadManager::~DownloadManager

(

)

destructor

Definition at line 86 of file downloadmanager.cpp.

---

Member Function Documentation

void DownloadManager::checkForUpdates

(

)

Check for available updates.

Use searchResult to get notified as soon as an update has been found.

Definition at line 102 of file downloadmanager.cpp.

void KNS3::DownloadManager::entryStatusChanged

(

const KNS3::Entry &

entry

)

[signal]

The entry status has changed: emitted when the entry has been installed, updated or removed.

Use KNS3::Entry::status() to check the current status.

Parameters:

entry

the item that has been updated.

void DownloadManager::installEntry

(

const KNS3::Entry &

entry

)

Installs or updates an entry.

Parameters:

entry

Definition at line 125 of file downloadmanager.cpp.

void DownloadManager::search	(	int	page = 0,
		int	pageSize = 100
	)

Search for a list of entries.

searchResult will be emitted with the requested list.

Definition at line 133 of file downloadmanager.cpp.

void KNS3::DownloadManager::searchResult

(

const KNS3::Entry::List &

entries

)

[signal]

Returns the search result.

This can be the list of updates after checkForUpdates or the result of a search.

Parameters:

entries

the list of results. entries is empty when nothing was found.

void DownloadManager::setSearchOrder

(

DownloadManager::SortOrder

order

)

Set the sort order of the results.

This depends on the server. Note that this function does not trigger a search. Use search after setting this.

See also:

SortOrder

Parameters:

order

Definition at line 145 of file downloadmanager.cpp.

void DownloadManager::setSearchTerm

(

const QString &

searchTerm

)

Sets the search term to filter the results on the server.

Note that this function does not trigger a search. Use search after setting this.

Parameters:

searchTerm

Definition at line 163 of file downloadmanager.cpp.

---

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

• downloadmanager.h
• downloadmanager.cpp