KSyntaxHighlighting::DefinitionDownloader Class Reference

#include <definitiondownloader.h>

Inheritance diagram for KSyntaxHighlighting::DefinitionDownloader:

Signals
void	done ()
void	informationMessage (const QString &msg)

Public Member Functions
	DefinitionDownloader (Repository *repo, QObject *parent=nullptr)
	~DefinitionDownloader () override
void	start ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
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 () const const
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 QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
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_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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	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	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
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)
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

Helper class to download definition file updates.

With the DefinitionDownloader you can download new and update existing syntax highlighting definition files (xml files).

An example that updates the highlighting Definitions and prints the current update progress to the console may look as follows:

auto downloader = new DefinitionDownloader(repo); // repo is a pointer to a Repository
 
// print update progress to console
QObject::connect(downloader, &DefinitionDownloader::informationMessage, [](const QString &msg) {
    std::cout << qPrintable(msg) << std::endl;
});
 
// connect to signal done to delete the downloader later
QObject::connect(downloader, &DefinitionDownloader::done,
                 downloader, &DefinitionDownloader::deleteLater);
downloader->start();

See also

Repository, Definition

Since

5.28

Definition at line 46 of file definitiondownloader.h.

Constructor & Destructor Documentation

DefinitionDownloader()

DefinitionDownloader::DefinitionDownloader ( Repository * repo, QObject * parent = nullptr )

explicit

Constructor.

The Repository repo is used as reference to compare the versions of the existing Definitions with the ones that are available online.

Optionally, parent is a pointer to the owner of this instance.

Definition at line 149 of file definitiondownloader.cpp.

~DefinitionDownloader()

DefinitionDownloader::~DefinitionDownloader ( )

override

Destructor.

Definition at line 166 of file definitiondownloader.cpp.

Member Function Documentation

done

void KSyntaxHighlighting::DefinitionDownloader::done ( )

signal

This signal is emitted when there are no pending downloads anymore.

informationMessage

void KSyntaxHighlighting::DefinitionDownloader::informationMessage ( const QString & msg )

signal

Prints the information about the current state of the definition files.

If all files are up-to-date, this signal is emitted informing you that all highlighting files are up-to-date. If there are updates, this signal is emitted for each update being downloaded.

start()

void DefinitionDownloader::start

(

)

Starts the update procedure.

Once no more updates are available (i.e. either the local definition files are up-to-date, or all updates have been downloaded), the signal done() is emitted.

During the update process, the signal informationMessage() can be used to display the current update progress to the user.

See also

done(), informationMessage()

Definition at line 170 of file definitiondownloader.cpp.

---

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

• definitiondownloader.h
• definitiondownloader.cpp