Engine

Search for usage in LXR

#include <quickengine.h>

Inheritance diagram for Engine:

Public Types

enum  EntryEvent { UnknownEvent = KNSCore::EntryInternal::UnknownEvent, StatusChangedEvent = KNSCore::EntryInternal::StatusChangedEvent, AdoptedEvent = KNSCore::EntryInternal::AdoptedEvent, DetailsLoadedEvent = KNSCore::EntryInternal::DetailsLoadedEvent }
 
enum  ErrorCode {
  UnknownError = KNSCore::ErrorCode::UnknownError, NetworkError = KNSCore::ErrorCode::NetworkError, OcsError = KNSCore::ErrorCode::OcsError, ConfigFileError = KNSCore::ErrorCode::ConfigFileError,
  ProviderError = KNSCore::ErrorCode::ProviderError, InstallationError = KNSCore::ErrorCode::InstallationError, ImageError = KNSCore::ErrorCode::ImageError, AdoptionError = KNSCore::ErrorCode::AdoptionError,
  TryAgainLaterError = KNSCore::ErrorCode::TryAgainLaterError
}
 

Properties

QObject categories
 
QStringList categoriesFilter
 
QQmlListProperty< KNSCore::EntryWrapperchangedEntries
 
int changedEntriesCount
 
QString configFile
 
QObject engine
 
int filter
 
bool hasAdoptionCommand
 
bool isLoading
 
bool isValid
 
QString name
 
QObject searchPresetModel
 
QString searchTerm
 
int sortOrder
 
- Properties inherited from QObject
 objectName
 

Signals

void busyMessage (const QString &message)
 
void entryEvent (KNSCore::EntryWrapper *entry, EntryEvent event)
 
void errorCode (const Engine::ErrorCode &errorCode, const QString &message, const QVariant &metadata)
 
void errorMessage (const QString &message)
 
void idleMessage (const QString &message)
 
void message (const QString &message)
 

Public Member Functions

 Engine (QObject *parent=nullptr)
 
QObjectcategories () const
 
Q_SIGNAL void categoriesChanged ()
 
QStringList categoriesFilter () const
 
Q_SIGNAL void categoriesFilterChanged ()
 
QQmlListProperty< KNSCore::EntryWrapperchangedEntries ()
 
Q_SIGNAL void changedEntriesChanged ()
 
int changedEntriesCount () const
 
QString configFile () const
 
Q_SIGNAL void configFileChanged ()
 
QObjectengine () const
 
Q_SIGNAL void engineChanged ()
 
Q_SIGNAL void engineInitialized ()
 
int filter () const
 
Q_SIGNAL void filterChanged ()
 
bool hasAdoptionCommand () const
 
bool isLoading () const
 
Q_SIGNAL void isLoadingChanged ()
 
bool isValid ()
 
QString name () const
 
 Q_ENUM (EntryEvent)
 
Q_INVOKABLE void resetCategoriesFilter ()
 
Q_INVOKABLE void resetChangedEntries ()
 
Q_INVOKABLE void resetSearchTerm ()
 
QObjectsearchPresetModel () const
 
Q_SIGNAL void searchPresetModelChanged ()
 
QString searchTerm () const
 
Q_SIGNAL void searchTermChanged ()
 
void setCategoriesFilter (const QStringList &newCategoriesFilter)
 
void setConfigFile (const QString &newFile)
 
void setFilter (int newFilter)
 
void setSearchTerm (const QString &newSearchTerm)
 
void setSortOrder (int newSortOrder)
 
int sortOrder () const
 
Q_SIGNAL void sortOrderChanged ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
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)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () const const
 

Additional Inherited Members

- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Encapsulates a KNSCore::Engine for use in Qt Quick.

This class takes care of initialisation of a KNSCore::Engine when assigned a config file. The actual KNSCore:Engine can be read through the Engine::engine property.

See also
ItemsModel

Definition at line 25 of file quickengine.h.

Member Enumeration Documentation

Registering the error codes from KNSCore to allow them to be used easily in QtQuick.

See also
KNSCore::ErrorCode
Since
5.84

Definition at line 74 of file quickengine.h.

Property Documentation

bool Engine::isLoading
read

Whether or not the engine is performing its initial loading operations.

Since
5.65

Definition at line 38 of file quickengine.h.

Member Function Documentation

void Engine::entryEvent ( KNSCore::EntryWrapper entry,
EntryEvent  event 
)
signal

This is fired for events related directly to a single EntryInternal instance The intermediate states Updating and Installing are not forwarded.

In case you need those you have to listen to the signals of the KNSCore::Engine instance of the engine property.

As an example, if you need to know when the status of an entry changes, you might write:

function onEntryEvent(entry, event) {
if (event == NewStuff.Engine.StatusChangedEvent) {
myModel.ghnsEntryChanged(entry);
}
}

nb: The above example is also how one would port a handler for the old changedEntries signal

See also
EntryInternal::EntryEvent for details on which specific event is being notified
Since
5.81
void Engine::errorCode ( const Engine::ErrorCode errorCode,
const QString message,
const QVariant metadata 
)
signal

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

This forwards the signal from KNSCore::Engine::signalErrorCode, but with QML friendly enumerations.

Parameters
errorCodeRepresents the specific type of error which has occurred
messageA human-readable message which can be shown to the end user
metadataAny additional data which might be hepful to further work out the details of the error (see KNSCore::EntryInternal::ErrorCode for the metadata details)
See also
KNSCore::Engine::signalErrorCode
Since
5.84
bool Engine::isLoading ( ) const

Whether or not the engine is performing its initial loading operations.

Since
5.65
Q_SIGNAL void Engine::isLoadingChanged ( )

Fired when the isLoading value changes.

Since
5.65

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Oct 22 2021 22:43:11 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.