QInstaller Namespace | Qt Installer Framework Manual

- Qt Installer Framework Manual
- QInstaller Namespace

# QInstaller Namespace

Contains classes to implement the core functionality of the Qt Installer Framework and the installer UI. More...

Header: | #include <QInstaller>

## Namespaces

namespace | TaskRole
namespace | Ui

## Classes

class | BinaryFormatEngine
class | BinaryLayout
class | CacheTaskException
class | ComponentPrivate
class | CustomComboBox
class | DownloadArchivesJob
class | FileTaskItem
class | FileTaskResult
class | GuiProxy
class | Lib7zArchive
class | MetadataCache
class | OperationBlob
class | PerformInstallationForm
class | SystemInfo
class | UpdateCacheTask

## Types

enum | DefaultFilePermissions { NonExecutable, Executable }
enum | DownloadType { All, CompressedPackage }

## Functions

QInstaller::Q_DECL_IMPORT | Q_DECLARE_LOGGING_CATEGORY(int)
void | askForCredentials(int *username, int *password, const int &usernameTitle, const int &passwordTitle)
void | askForCredentials(QString *username, QString *password, const QString &usernameTitle, const QString &passwordTitle)
void | copyConfigChildElements(int &dom, const int &objects, const int &sourceDir, const int &targetDir)
int | htmlToString(const int &)
QString | htmlToString(const QString &html)
int | qHash(const int &)
void | replaceHighDpiImage(QString &imagePath)
void | replaceHighDpiImage(int &imagePath)
QString | replacePath(const QString &path, const QString &before, const QString &after, bool cleanPath = true)
int | replacePath(const int &, const int &, const int &, bool)
int | splitStringWithComma(const int &)
int | splitStringWithComma(const QString &)
int | toQSet(const C<T> &)
int & | operator++(int &, int)
int & | operator--(int &, int)
int | operator<<(int, QInstaller::Component *)
QInstaller::Q_DECL_IMPORT | operator==(const int &lhs, const int &rhs)
class Q_DECL_IMPORT | operator==(const QInstaller::AliasSource &lhs, const QInstaller::AliasSource &rhs)

## Detailed Description

Contains classes to implement the core functionality of the Qt Installer Framework and the installer UI.

## Namespaces

### namespace QInstaller::TaskRole

### namespace QInstaller::Ui

## Classes

### class BinaryFormatEngine

The BinaryFormatEngine class is the default file engine for accessing resource collections and resource files. More...

### class BinaryLayout

The BinaryLayout class describes the binary content appended to a file. More...

### class CacheTaskException

### class ComponentPrivate

### class CustomComboBox

### class DownloadArchivesJob

### class FileTaskItem

The FileTaskItem class represents an item in a file task object. More...

### class FileTaskResult

The FileTaskResult class represents the results of a file task. More...

### class GuiProxy

### class Lib7zArchive

The Lib7zArchive class represents an archive file handled with the LZMA software development kit. More...

### class MetadataCache

The MetadataCache is a class for a checksum based storage of `Metadata` objects on disk. More...

### class OperationBlob

The OperationBlob class is a textual representation of an operation that can be instantiated and executed by the Qt Installer Framework. More...

### class PerformInstallationForm

The PerformInstallationForm class shows progress information about the installation state. More...

### class SystemInfo

Provides information about the operating system. More...

### class UpdateCacheTask

## Type Documentation

### enum QInstaller::DefaultFilePermissions

Constant | Value | Description
--- | --- | ---
`QInstaller::NonExecutable` | `0x6644` | Default permissions for a non-executable file.
`QInstaller::Executable` | `0x7755` | Default permissions for an executable file.

### enum QInstaller::DownloadType

Constant | Value
--- | ---
`QInstaller::All` | `0`
`QInstaller::CompressedPackage` | `1`

## Function Documentation

### QInstaller::Q_DECL_IMPORT QInstaller::Q_DECLARE_LOGGING_CATEGORY(int)

### void QInstaller::askForCredentials(int *username, int *password, const int &usernameTitle, const int &passwordTitle)

### void QInstaller::askForCredentials(QString *username, QString *password, const QString &usernameTitle, const QString &passwordTitle)

### void QInstaller::copyConfigChildElements(int &dom, const int &objects, const int &sourceDir, const int &targetDir)

### int QInstaller::htmlToString(const int &)

Converts and returns a string html containing an HTML document as a plain text.

### QString QInstaller::htmlToString(const QString &html)

### int QInstaller::qHash(const int &)

### void QInstaller::replaceHighDpiImage(QString &imagePath)

Replaces imagePath with high dpi image. If high dpi image is not provided or high dpi screen is not in use, the original value is returned.

### void QInstaller::replaceHighDpiImage(int &imagePath)

### QString QInstaller::replacePath(const QString &path, const QString &before, const QString &after, bool cleanPath = true)

Replaces the path before with the path after at the beginning of path and returns the replaced path. If before cannot be found in path, the original value is returned. If cleanPath is `true`, path is returned with directory separators normalized (that is, platform-native separators converted to "/") and redundant ones removed, and "."s and ".."s resolved (as far as possible). If cleanPath is `false`, path is returned as such. Default value is `true`.

### int QInstaller::replacePath(const int &, const int &, const int &, bool)

### int QInstaller::splitStringWithComma(const int &)

### int QInstaller::splitStringWithComma(const QString &)

### int QInstaller::toQSet(const C<T> &)

### int &QInstaller::operator++(int &, int)

### int &QInstaller::operator--(int &, int)

### int QInstaller::operator<<(int, QInstaller::Component *)

### QInstaller::Q_DECL_IMPORT QInstaller::operator==(const int &lhs, const int &rhs)

Returns `true` if lhs and rhs are equal; otherwise returns `false`.

### class Q_DECL_IMPORT QInstaller::operator==(const QInstaller::AliasSource &lhs, const QInstaller::AliasSource &rhs)