KSyntaxHighlighting::DefinitionDownloader Class

class KSyntaxHighlighting::DefinitionDownloader

Helper class to download definition file updates. More...

Header:	`#include <KSyntaxHighlighting/DefinitionDownloader>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS KSyntaxHighlighting)` `target_link_libraries(mytarget PRIVATE KF6::KSyntaxHighlighting)`
Since:	5.28
Inherits:	QObject

List of all members, including inherited members

Public Functions

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

Signals

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

Detailed Description

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

An example that updates the highlighting Definition%s 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 and Definition.

Member Function Documentation

`[explicit]` DefinitionDownloader::DefinitionDownloader(KSyntaxHighlighting::Repository **repo*, QObject **parent* = nullptr)

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

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

`[signal]` void DefinitionDownloader::done()

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

`[signal]` void DefinitionDownloader::informationMessage(const QString &msg)

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.

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() and informationMessage().

Contents