KNSCore::EngineBase Class

Member Function Documentation

EngineBase::EngineBase(QObject *parent = nullptr)

[since 5.51] void EngineBase::addDownloadTagFilter(const QString &filter)

Add a single filter entry to the download tag filter. The filter should be in the same form as the filter lines in the list used by setDownloadsTagFilter(QStringList)

filter The filter in the form of a string

This function was introduced in 5.51.

See also setTagFilter and setDownloadTagFilter.

[since 5.51] void EngineBase::addTagFilter(const QString &filter)

Adds a single filter entry to the entry tag filter. The filter should be in the same form as the filter lines in the list used by setTagFilter(QStringList)

filter The filter in the form of a string

This function was introduced in 5.51.

See also setTagFilter.

[since 5.92] QList<Attica::Provider *> EngineBase::atticaProviders() const

Returns the list of attica (OCS) providers this engine is connected to

This function was introduced in 5.92.

[static, since 5.83] QStringList EngineBase::availableConfigFiles()

List of all available config files. This list will contain no duplicated filenames. The returned file paths are absolute.

This function was introduced in 5.83.

void EngineBase::becomeFan(const KNSCore::Entry &entry)

This will mark the user who is currently authenticated as a fan of the entry passed to the function.

entry The entry the user wants to be a fan of

QStringList EngineBase::categories() const

The list of the server-side names of the categories handled by this engine instance. This corresponds directly to the list of categories in your knsrc file. This is not supposed to be used as user-facing strings - see categoriesMetadata() for that.

Returns The categories which this instance of Engine handles

QList<KNSCore::CategoryMetadata> EngineBase::categoriesMetadata2()

The list of metadata for the categories handled by this engine instance. If you wish to show the categories to the user, this is the data to use. The category name is the string used to set categories for the filter, and also what is returned by both categories() and categoriesFilter(). The human-readable name is displayName, and the only thing which should be shown to the user.

Returns The metadata for all categories handled by this engine

[since 6.1] KNSCore::EngineBase::ContentWarningType EngineBase::contentWarningType() const

The level of warning that should be presented to the user

This function was introduced in 6.1.

See also ContentWarningType.

[signal, since 6.1] void EngineBase::contentWarningTypeChanged()

Emitted after the initial config load

This function was introduced in 6.1.

[since 5.51] QStringList EngineBase::downloadTagFilter() const

Returns the current downloadlink tag filter list

This function was introduced in 5.51.

See also setDownloadTagFilter.

bool EngineBase::hasAdoptionCommand() const

Whether or not an adoption command exists for this engine

Returns True if an adoption command exists

[virtual] bool EngineBase::init(const QString &configfile)

Initializes the engine. This step is application-specific and relies on an external configuration file, which determines all the details about the initialization.

configfile KNewStuff2 configuration file (*.knsrc)

Returns true if any valid configuration was found, false otherwise

[signal] void EngineBase::loadingProvider()

[since 5.63] QString EngineBase::name() const

The name as defined by the knsrc file Returns The name associated with the engine's configuration file

This function was introduced in 5.63.

[signal] void EngineBase::providerAdded(KNSCore::ProviderCore *provider)

[since 5.85] QStringList EngineBase::providerIDs() const

The IDs of all providers known by this engine. Use this in combination with provider(const QString&) to iterate over all providers. Returns The string IDs of all known providers

This function was introduced in 5.85.

[since 6.9] QList<KNSCore::SearchPreset> EngineBase::searchPresets2()

This function was introduced in 6.9.

[since 5.51] void EngineBase::setDownloadTagFilter(const QStringList &filter)

Sets a filter to be applied to the downloads for an entry. The logic is the same as used in setTagFilter(QStringList), but vitally, only one downloadlink is required to match the filter for the list to be valid. If you do not wish to show the others in your client, you must hide them yourself.

For an entry to be accepted when a download tag filter is set, it must also be accepted by the entry filter (so, for example, while a list of downloads might be accepted, if the entry has ghns_excluded set, and the default entry filter is set, the entry will still be filtered out).

In your knsrc file, set DownloadTagFilter to the filter you wish to apply, using the same logic as described for the entry tagfilter.

filter The filter in the form of a list of strings

This function was introduced in 5.51.

See also downloadTagFilter() and setTagFilter.

[since 5.51] void EngineBase::setTagFilter(const QStringList &filter)

Set a filter for results, which filters out all entries which do not match the filter, as applied to the tags for the entry. This filters only on the tags specified for the entry itself. To filter the downloadlinks, use setDownloadTagFilter(QStringList).

== Examples of use == Value for tag "tagname" must be exactly "tagdata": tagname==tagdata

Value for tag "tagname" must be different from "tagdata": tagname!=tagdata

== KNSRC entry == A tag filter line in a .knsrc file, which is a comma separated list of tag/value pairs, might look like:

TagFilter=ghns_excluded!=1,data##mimetype==application/cbr+zip,data##mimetype==application/cbr+rar which would honour the exclusion and filter out anything that does not include a comic book archive in either zip or rar format in one or more of the download items. Notice in particular that there are two data##mimetype entries. Use this for when a tag may have multiple values.

TagFilter=application##architecture==x86_64 which would not honour the exclusion, and would filter out all entries which do not mark themselves as having a 64bit application binary in at least one download item.

The value does not current support wildcards. The list should be considered a binary AND operation (that is, all filter entries must match for the data entry to be included in the return data)

filter The filter in the form of a list of strings

This function was introduced in 5.51.

See also tagFilter() and setDownloadTagFilter.

[signal] void EngineBase::signalCategoriesMetadataLoaded(const QList<KNSCore::CategoryMetadata> &categories)

[signal, since 5.53] void EngineBase::signalErrorCode(KNSCore::ErrorCode::ErrorCode errorCode, const QString &message, const QVariant &metadata)

Fires in the case of any critical or serious errors, such as network or API problems.

errorCode Represents the specific type of error which has occurred

message A human-readable message which can be shown to the end user

metadata Any additional data which might be helpful to further work out the details of the error (see KNSCore::Entry::ErrorCode for the metadata details)

This function was introduced in 5.53.

See also KNSCore::ErrorCode.

[signal] void EngineBase::signalMessage(const QString &message)

Indicates a message to be added to the ui's log, or sent to a messagebox

[signal, since 6.9] void EngineBase::signalSearchPresetsLoaded(const QList<KNSCore::SearchPreset> &presets)

Fires when the engine has loaded search presets. These represent interesting searches for the user, such as recommendations.

Note: Signal signalSearchPresetsLoaded is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

connect(engineBase, QOverload<const QList<KNSCore::SearchPreset> &>::of(&EngineBase::signalSearchPresetsLoaded),
    [=](const QList<KNSCore::SearchPreset> &presets){ /* ... */ });

This function was introduced in 6.9.

[since 5.51] QStringList EngineBase::tagFilter() const

Returns the current tag filter list

This function was introduced in 5.51.

See also setTagFilter.

[since 5.85] bool EngineBase::uploadEnabled() const

Whether or not the configuration says that the providers are expected to support uploading. Returns True if the providers are expected to support uploading

This function was introduced in 5.85.

[signal, since 5.85] void EngineBase::uploadEnabledChanged()

Fired when the uploadEnabled property changes

This function was introduced in 5.85.

[since 5.77] QString EngineBase::useLabel() const

Text that should be displayed for the adoption button, this defaults to i18n("Use")

This function was introduced in 5.77.

[signal, since 5.77] void EngineBase::useLabelChanged()

Signal gets emitted when the useLabel property changes

This function was introduced in 5.77.

bool EngineBase::userCanBecomeFan(const KNSCore::Entry &entry)

Whether or not the user is allowed to become a fan of a particular entry. Not all providers (and consequently entries) support the fan functionality and you can use this function to determine this ability.

entry The entry the user might wish to be a fan of

Returns Whether or not it is possible for the user to become a fan of that entry

bool EngineBase::userCanVote(const KNSCore::Entry &entry)

Whether or not a user is able to vote on the passed entry.

entry The entry to check votability on

Returns True if the user is able to vote on the entry

void EngineBase::vote(const KNSCore::Entry &entry, uint rating)

Cast a vote on the passed entry.

entry The entry to vote on

rating A number from 0 to 100, 50 being neutral, 0 being most negative and 100 being most positive.