KNSCore::DownloadManager Class Reference

#include <downloadmanager.h>

Inheritance diagram for KNSCore::DownloadManager:

Public Types
enum	SortOrder { Newest, Alphabetical, Rating, Downloads }

Signals
void	entryStatusChanged (const EntryInternal &entry)
void	errorFound (const QString &errorMessage)
void	searchResult (const EntryInternal::List &entries)

Public Slots
void	slotProvidersLoaded ()

Public Member Functions
	DownloadManager (const QString &configFile, QObject *parent=nullptr)
	DownloadManager (QObject *parent=nullptr)
	~DownloadManager () override
void	checkForInstalled ()
void	checkForUpdates ()
void	fetchEntryById (const QString &id)
void	installEntry (const EntryInternal &entry)
void	search (int page=0, int pageSize=100)
void	setSearchOrder (SortOrder order)
void	setSearchTerm (const QString &searchTerm)
void	uninstallEntry (const EntryInternal &entry)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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.

Definition at line 24 of file core/downloadmanager.h.

Constructor & Destructor Documentation

DownloadManager() [1/2]

DownloadManager::DownloadManager ( QObject *  parent = nullptr )

explicit

Create a DownloadManager It will try to find a appname.knsrc file.

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

Parameters

parent

the parent of the dialog

Definition at line 50 of file core/downloadmanager.cpp.

DownloadManager() [2/2]

DownloadManager::DownloadManager ( const QString &  configFile, QObject *  parent = nullptr  )

explicit

Create a DownloadManager.

Manually specifying the name of the .knsrc file.

Parameters

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

Definition at line 58 of file core/downloadmanager.cpp.

~DownloadManager()

DownloadManager::~DownloadManager ( )

override

destructor

Definition at line 81 of file core/downloadmanager.cpp.

Member Function Documentation

checkForInstalled()

void DownloadManager::checkForInstalled

(

)

Check for installed resources Use searchResult to get notified about installed entries.

Since

5.28

Definition at line 108 of file core/downloadmanager.cpp.

checkForUpdates()

void DownloadManager::checkForUpdates

(

)

Check for available updates.

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

Definition at line 99 of file core/downloadmanager.cpp.

entryStatusChanged

void KNSCore::DownloadManager::entryStatusChanged ( const EntryInternal &  entry )

signal

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

Use EntryInternal::status() to check the current status.

Parameters

entry

the item that has been updated.

errorFound

void KNSCore::DownloadManager::errorFound ( const QString &  errorMessage )

signal

Notifies that the engine couldn't be loaded properly and won't be suitable.

fetchEntryById()

void DownloadManager::fetchEntryById

(

const QString &

id

)

Triggers a search for an entry with id as its unique id.

See also

searchResult

Since

5.28

Definition at line 166 of file core/downloadmanager.cpp.

installEntry()

void DownloadManager::installEntry

(

const EntryInternal &

entry

)

Installs or updates an entry.

Parameters

entry

The entry you wish to install or update

Definition at line 117 of file core/downloadmanager.cpp.

search()

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 131 of file core/downloadmanager.cpp.

searchResult

void KNSCore::DownloadManager::searchResult ( const EntryInternal::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.

setSearchOrder()

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

The way you want the results to be sorted

Definition at line 143 of file core/downloadmanager.cpp.

setSearchTerm()

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

The term you wish to search for

Definition at line 161 of file core/downloadmanager.cpp.

uninstallEntry()

void DownloadManager::uninstallEntry

(

const EntryInternal &

entry

)

Uninstalls the given entry.

Parameters

entry

The entry which will be uninstalled.

Definition at line 124 of file core/downloadmanager.cpp.

---

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

• core/downloadmanager.h
• core/downloadmanager.cpp