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
The base class for classes representing different archive files. It cannot be instantiated on its own but defines the API and provides common functionality when subclassed | |
The base class of file related tasks | |
Struct represents an entry in an archive file, which can be for example a file or a directory | |
Used to create archive objects based on the suffix of a given filename | |
Label for displaying a pixmap that maintains its original aspect ratio when resized | |
Handles binary information embedded into executables | |
The default file engine for accessing resource collections and resource files | |
Way to register resource collections and resource files | |
Describes the binary content appended to a file | |
Represents the current component | |
Sets a decreasing sorting priority for child components | |
Sets an increasing sorting order for child components | |
Holds a data model for visual representation of available components to install | |
Changes the checked state of components | |
RAII class to create a directory and delete it on destruction unless released | |
Represents an item in a file task object | |
Represents the results of a file task | |
Completes the installation wizard | |
Displays information about the product to install | |
Represents an archive file handled with the LZMA software development kit | |
Represents an archive file handled with libarchive archive and compression library | |
Bundles a file device and associated read buffer for access as client data in libarchive callbacks | |
Interface for interacting with archives handled using the libarchive archive and compression library | |
Presents a license agreement to the end users for acceptance | |
Methods for manipulating the application-wide verbosiveness and format of printed debug messages | |
Modal dialog for informing the user or asking the user a question and receiving an answer | |
Textual representation of an operation that can be instantiated and executed by the Qt Installer Framework | |
The core functionality of the Qt Installer Framework | |
The core functionality for non-interactive installations | |
Displays information about the product to install | |
Specifies a single package source | |
Shows progress information about the installation state | |
Shows progress information about the installation state | |
Informs end users that the installation can begin | |
Interface for wrapping a file as read only device | |
Abstraction that groups together a number of resources | |
Abstraction that groups together a number of resource collections | |
Enables restarting the installer | |
Used to prepare and run the component scripts | |
Specifies the program group for the product in the Windows Start menu | |
Provides information about the operating system | |
Specifies the target directory for the installation |
KDUpdater C++ Classes
Implements a template-based generic factory | |
The base class for file downloaders used in KDUpdater | |
Acts as a factory for KDUpdater::FileDownloader | |
Fine-grained proxy selection | |
Used to download files over FTP, HTTP, or HTTPS | |
Used to copy files from the local file system | |
Describes a single installed package in the application | |
Access to information about packages installed on the application side | |
Can be used to download resource files | |
The base class for all tasks in KDUpdater | |
Represents a single update | |
UpdaterFinder class finds updates applicable for installed packages | |
Abstract base class for update operations | |
Used to create update operations based on their name |
Lib7z C++ Classes
Provides a callback for archive extraction | |
Displays the archiving process | |
Class for lib7z exceptions |
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. The Qt Company, Qt and their respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.