KDE 4.6 API Reference KNewStuff
KNS3::Engine Class Reference
KNewStuff engine. More...
#include <engine.h>
Detailed Description
KNewStuff engine.
An engine keeps track of data which is available locally and remote and offers high-level synchronization calls as well as upload and download primitives using an underlying GHNS protocol.
Definition at line 52 of file knewstuff3/core/engine.h.
Constructor & Destructor Documentation
| Engine::Engine | ( | QObject * | parent = 0 | ) |
Constructor.
Definition at line 65 of file knewstuff3/core/engine.cpp.
| Engine::~Engine | ( | ) |
Destructor.
Frees up all the memory again which might be taken by cached entries and providers.
Definition at line 85 of file knewstuff3/core/engine.cpp.
Member Function Documentation
| void Engine::becomeFan | ( | const EntryInternal & | entry | ) |
Definition at line 489 of file knewstuff3/core/engine.cpp.
| QStringList Engine::categories | ( | ) | const |
Definition at line 153 of file knewstuff3/core/engine.cpp.
| QStringList Engine::categoriesFilter | ( | ) | const |
Definition at line 158 of file knewstuff3/core/engine.cpp.
| void Engine::checkForUpdates | ( | ) |
Definition at line 508 of file knewstuff3/core/engine.cpp.
| void Engine::contactAuthor | ( | const EntryInternal & | entry | ) |
Try to contact the author of the entry by email or showing their homepage.
Definition at line 456 of file knewstuff3/core/engine.cpp.
Initializes the engine.
This step is application-specific and relies on an external configuration file, which determines all the details about the initialization.
- Parameters:
-
configfile KNewStuff2 configuration file (*.knsrc)
- Returns:
- true if any valid configuration was found, false otherwise
Definition at line 93 of file knewstuff3/core/engine.cpp.
| void Engine::install | ( | KNS3::EntryInternal | entry, |
| int | linkId = 1 |
||
| ) |
Installs an entry's payload file.
This includes verification, if necessary, as well as decompression and other steps according to the application's *.knsrc file.
- Parameters:
-
entry Entry to be installed
- Returns:
- Whether or not installation was started successfully
- See also:
- signalInstallationFinished
- signalInstallationFailed
Definition at line 382 of file knewstuff3/core/engine.cpp.
| void Engine::loadDetails | ( | const KNS3::EntryInternal & | entry | ) |
Definition at line 432 of file knewstuff3/core/engine.cpp.
| void Engine::loadPreview | ( | const KNS3::EntryInternal & | entry, |
| EntryInternal::PreviewType | type | ||
| ) |
Definition at line 438 of file knewstuff3/core/engine.cpp.
| void Engine::reloadEntries | ( | ) |
Definition at line 284 of file knewstuff3/core/engine.cpp.
| void Engine::requestData | ( | int | page, |
| int | pageSize | ||
| ) |
Definition at line 364 of file knewstuff3/core/engine.cpp.
| void Engine::requestMoreData | ( | ) |
Definition at line 352 of file knewstuff3/core/engine.cpp.
| void Engine::setCategoriesFilter | ( | const QStringList & | categories | ) |
Set the categories that will be included in searches.
Definition at line 320 of file knewstuff3/core/engine.cpp.
| void Engine::setSearchTerm | ( | const QString & | searchString | ) |
Definition at line 335 of file knewstuff3/core/engine.cpp.
| void Engine::setSortMode | ( | Provider::SortMode | mode | ) |
Definition at line 326 of file knewstuff3/core/engine.cpp.
| void KNS3::Engine::signalBusy | ( | const QString & | ) | [signal] |
| void KNS3::Engine::signalDownloadDialogDone | ( | KNS3::EntryInternal::List | ) | [signal] |
| void KNS3::Engine::signalEntriesLoaded | ( | const KNS3::EntryInternal::List & | entries | ) | [signal] |
| void KNS3::Engine::signalEntryChanged | ( | const KNS3::EntryInternal & | entry | ) | [signal] |
| void KNS3::Engine::signalEntryDetailsLoaded | ( | const KNS3::EntryInternal & | entry | ) | [signal] |
| void KNS3::Engine::signalEntryPreviewLoaded | ( | const KNS3::EntryInternal & | , |
| KNS3::EntryInternal::PreviewType | |||
| ) | [signal] |
| void KNS3::Engine::signalEntryUploadFailed | ( | ) | [signal] |
| void KNS3::Engine::signalEntryUploadFinished | ( | ) | [signal] |
| void KNS3::Engine::signalError | ( | const QString & | ) | [signal] |
| void KNS3::Engine::signalIdle | ( | const QString & | ) | [signal] |
| void KNS3::Engine::signalMessage | ( | const QString & | message | ) | [signal] |
Indicates a message to be added to the ui's log, or sent to a messagebox.
| void KNS3::Engine::signalPreviewFailed | ( | ) | [signal] |
| void KNS3::Engine::signalProvidersLoaded | ( | ) | [signal] |
| void KNS3::Engine::signalResetView | ( | ) | [signal] |
| void KNS3::Engine::signalUpdateableEntriesLoaded | ( | const KNS3::EntryInternal::List & | entries | ) | [signal] |
| void Engine::uninstall | ( | KNS3::EntryInternal | entry | ) |
Uninstalls an entry.
It reverses the steps which were performed during the installation.
- Parameters:
-
entry The entry to deinstall
Definition at line 424 of file knewstuff3/core/engine.cpp.
| bool Engine::userCanBecomeFan | ( | const EntryInternal & | entry | ) |
Definition at line 483 of file knewstuff3/core/engine.cpp.
| bool Engine::userCanVote | ( | const EntryInternal & | entry | ) |
Definition at line 471 of file knewstuff3/core/engine.cpp.
| void Engine::vote | ( | const EntryInternal & | entry, |
| uint | rating | ||
| ) |
Definition at line 477 of file knewstuff3/core/engine.cpp.
The documentation for this class was generated from the following files:
