C++ API | Qt Installer Framework Manual

- Qt Installer Framework Manual
- C++ API

Scripting API ◦ Known Issues

# C++ API

The C++ API documentation is written for developers who develop the Qt Installer Framework. It describes the internal API, so there is no compatibility promise. Further, the documentation is a work in progress and therefore parts of it are missing while other parts might be out of date.

To create customized installers, use the Scripting API, instead. For more information, see Customizing Installers.

## Namespaces

Namespace | Description
--- | ---
QInstaller | Contains classes to implement the core functionality of the Qt Installer Framework and the installer UI.
KDUpdater | Contains classes to automatically detect updates to applications, to retrieve them from external repositories, and to install them. KDUpdater classes are a fork of KDAB's general KDUpdater module.
Lib7z | Contains classes to create and extract archives.

## QInstaller C++ Classes

QInstaller::BinaryFormatEngine | The default file engine for accessing resource collections and resource files
QInstaller::BinaryLayout | Describes the binary content appended to a file
QInstaller::FileTaskItem | Represents an item in a file task object
QInstaller::FileTaskResult | Represents the results of a file task
QInstaller::Lib7zArchive | Represents an archive file handled with the LZMA software development kit
QInstaller::MetadataCache | Class for a checksum based storage of Metadata objects on disk
QInstaller::OperationBlob | Textual representation of an operation that can be instantiated and executed by the Qt Installer Framework
QInstaller::PerformInstallationForm | Shows progress information about the installation state
QInstaller::SystemInfo | Provides information about the operating system

## KDUpdater C++ Classes

GenericFactory | Implements a template-based generic factory
KDUpdater::HttpDownloader | Used to download files over FTP, HTTP, or HTTPS
KDUpdater::LocalFileDownloader | Used to copy files from the local file system
KDUpdater::ResourceFileDownloader | Can be used to download resource files

## Lib7z C++ Classes

Scripting API ◦ Known Issues