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.

## QInstaller C++ Classes

QInstaller::AbstractFileTask | The base class of file related tasks
QInstaller::BinaryContent | Handles binary information embedded into executables
QInstaller::BinaryFormatEngine | The default file engine for accessing resource collections and resource files
QInstaller::BinaryFormatEngineHandler | Way to register resource collections and resource files
QInstaller::BinaryLayout | Describes the binary content appended to a file
QInstaller::Component | Represents the current component
QInstaller::Component::SortingPriorityGreaterThan | Sets a decreasing sorting priority for child components
QInstaller::Component::SortingPriorityLessThan | Sets an increasing sorting order for child components
QInstaller::ComponentModel | Holds a data model for visual representation of available components to install
QInstaller::ComponentSelectionPage | Changes the checked state of components
QInstaller::FileTaskItem | Represents an item in a file task object
QInstaller::FileTaskResult | Represents the results of a file task
QInstaller::FinishedPage | Completes the installation wizard
QInstaller::IntroductionPage | Displays information about the product to install
QInstaller::LicenseAgreementPage | Presents a license agreement to the end users for acceptance
QInstaller::MessageBoxHandler | Modal dialog for informing the user or asking the user a question and receiving an answer
QInstaller::OperationBlob | Textual representation of an operation that can be instantiated and executed by the Qt Installer Framework
QInstaller::PackageManagerCore | The core functionality of the Qt Installer Framework
QInstaller::PackageManagerGui | The core functionality for non-interactive installations
QInstaller::PackageManagerPage | Displays information about the product to install
QInstaller::PerformInstallationForm | Shows progress information about the installation state
QInstaller::PerformInstallationPage | Shows progress information about the installation state
QInstaller::ReadyForInstallationPage | Informs end users that the installation can begin
QInstaller::Resource | Interface for wrapping a file as read only device
QInstaller::ResourceCollection | Abstraction that groups together a number of resources
QInstaller::ResourceCollectionManager | Abstraction that groups together a number of resource collections
QInstaller::RestartPage | Enables restarting the installer
QInstaller::ScriptEngine | Used to prepare and run the component scripts
QInstaller::StartMenuDirectoryPage | Specifies the program group for the product in the Windows Start menu
QInstaller::SystemInfo | Provides information about the operating system
QInstaller::TargetDirectoryPage | Specifies the target directory for the installation

## KDUpdater C++ Classes

KDGenericFactory | Implements a template-based generic factory
KDUpdater::Application | Represents an application that can be updated
KDUpdater::ConfigurationInterface | Interface for configuring an application
KDUpdater::FileDownloader | The base class for file downloaders used in KDUpdater
KDUpdater::FileDownloaderFactory | Acts as a factory for KDUpdater::FileDownloader
KDUpdater::FileDownloaderProxyFactory | Fine-grained proxy selection
KDUpdater::HttpDownloader | Used to download files over FTP, HTTP, or HTTPS
KDUpdater::LocalFileDownloader | Used to copy files from the local file system
KDUpdater::PackageInfo | Describes a single installed package in the application
KDUpdater::PackagesInfo | Access to information about packages installed on the application side
KDUpdater::ResourceFileDownloader | Can be used to download resource files
KDUpdater::Task | The base class for all tasks in KDUpdater
KDUpdater::Update | Represents a single update
KDUpdater::UpdateFinder | UpdaterFinder class finds updates applicable for a KDUpdater::Application
KDUpdater::UpdateOperation | Abstract base class for update operations
KDUpdater::UpdateOperationFactory | Used to create update operations based on their name
KDUpdater::UpdateSourceInfo | Specifies a single update source
KDUpdater::UpdateSourcesInfo | Access to information about the update sources set for the application

Scripting API ◦ Known Issues