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 | Protocol
namespace | TaskRole
namespace | Ui

## Classes

class | AbstractArchive
class | AbstractFileTask
class | AliasFinder
class | AliasSource
class | ArchiveEntry
class | ArchiveFactory
class | AspectRatioLabel
class | CacheableItem
class | CalculatorBase
class | ComponentAlias
class | ComponentSortFilterProxyModel
class | CustomComboBox
class | DirectoryGuard
class | FileTaskItem
class | FileTaskResult
class | GenericDataCache
class | GuiProxy
class | Lib7zArchive
class | LibArchiveArchive
class | LibArchiveWrapper
class | MessageBoxHandler
class | Metadata
class | MetadataCache
class | PackageSource
class | PerformInstallationForm
class | ProgressCoordinator
class | RemoteServer
class | Repository
class | ScriptEngine
class | SystemInfo

## Types

enum | DefaultFilePermissions { NonExecutable, Executable }

## Functions

void | appendByteArray(QFileDevice *out, const QByteArray &ba)
void | appendData(QFileDevice *out, QFileDevice *in, qint64 size)
void | appendInt64(QFileDevice *out, qint64 n)
void | appendInt64Range(QFileDevice *out, const Range<qint64> &r)
void | appendString(QFileDevice *out, const QString &str)
void | assertObjectType(QObjectPrivate *d)
qint64 | blockingCopy(QFileDevice *in, QFileDevice *out, qint64 size)
qint64 | blockingRead(QFileDevice *in, char *buffer, qint64 size)
qint64 | blockingWrite(QFileDevice *out, const QByteArray &data)
qint64 | blockingWrite(QFileDevice *out, const char *data, qint64 size)
void | copyConfigChildElements(QDomDocument &dom, const QDomNodeList &objects, const QString &sourceDir, const QString &targetDir)
void | copyDirectoryContents(const QString &sourceDir, const QString &targetDir)
bool | createDirectoryWithParents(const QString &path)
quint64 | fileSize(const QFileInfo &info)
QString | generateTemporaryFileName(const QString &templ = QString())
QString | getLongPathName(const QString &name)
const QObject * | getQObject(const QObjectPrivate *d)
QString | getShortPathName(const QString &name)
QString | htmlToString(const QString &html)
QString | humanReadableSize(const qint64 &size, int precision = 2)
void | init()
bool | isInBundle(const QString &path, QString *bundlePath = 0)
bool | isLocalUrl(const QUrl &url)
const QLoggingCategory & | lcDeveloperBuild()
const QLoggingCategory & | lcInstallerInstallLog()
const QLoggingCategory & | lcProgressIndicator()
const QLoggingCategory & | lcServer()
QStringList | loggingCategories()
void | mkdir(const QString &path)
void | mkpath(const QString &path)
void | moveDirectoryContents(const QString &sourceDir, const QString &targetDir)
QString | normalizePathName(const QString &name)
void | openForAppend(QFileDevice *dev)
void | openForRead(QFileDevice *dev)
void | openForWrite(QFileDevice *dev)
QString | pathFromUrl(const QUrl &url)
hashValue | qHash(const QInstaller::PackageSource &key, hashValue seed)
hashValue | qHash(const QInstaller::AliasSource &key, hashValue seed)
hashValue | qHash(const QInstaller::Repository &repository)
const QMetaObject * | qt_getEnumMetaObject(QInstaller::AbstractArchive::CompressionLevel)
const QMetaObject * | qt_getEnumMetaObject(QInstaller::ComponentAlias::UnstableError)
const char * | qt_getEnumName(QInstaller::AbstractArchive::CompressionLevel)
const char * | qt_getEnumName(QInstaller::ComponentAlias::UnstableError)
bool | receivePacket(QIODevice *device, QByteArray *command, QByteArray *data)
void | removeDirectory(const QString &path, bool ignoreErrors = false)
void | removeDirectoryThreaded(const QString &path, bool ignoreErrors = false)
void | removeFiles(const QString &path, bool ignoreErrors = false)
void | removeSystemGeneratedFiles(const QString &path)
void | replaceHighDpiImage(QString &imagePath)
QString | replacePath(const QString &path, const QString &pathBefore, const QString &pathAfter, bool cleanPath = true)
QByteArray | retrieveByteArray(QFileDevice *in)
QByteArray | retrieveData(QFileDevice *in, qint64 size)
qint64 | retrieveInt64(QFileDevice *in)
Range<qint64> | retrieveInt64Range(QFileDevice *in)
QString | retrieveString(QFileDevice *in)
void | sendPacket(QIODevice *device, const QByteArray &command, const QByteArray &data)
void | setApplicationIcon(const QString &application, const QString &icon)
bool | setDefaultFilePermissions(const QString &fileName, QInstaller::DefaultFilePermissions permissions)
bool | setDefaultFilePermissions(QFile *file, QInstaller::DefaultFilePermissions permissions)
QStringList | splitStringWithComma(const QString &value)
QSet<T> | toQSet(const C<T> &container)
void | trimmedCopyConfigData(const QString &source, const QString &target, const QStringList &elementsToRemoveTags)
QDataStream & | operator<<(QDataStream &ostream, const QInstaller::ArchiveEntry &entry)
bool | operator==(const QInstaller::ArchiveEntry &lhs, const QInstaller::ArchiveEntry &rhs)
bool | operator==(const QInstaller::PackageSource &lhs, const QInstaller::PackageSource &rhs)
bool | operator==(const QInstaller::AliasSource &lhs, const QInstaller::AliasSource &rhs)
QDataStream & | operator>>(QDataStream &istream, QInstaller::ArchiveEntry &entry)

## Detailed Description

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

## Namespaces

### namespace QInstaller::Protocol

Contains values related to the internal client-server connection protocol.

### namespace QInstaller::TaskRole

Contains identifiers for tasks.

### namespace QInstaller::Ui

Groups user interface forms generated with Qt Designer.

## Classes

### class AbstractArchive

The AbstractArchive class is 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. More...

### class AbstractFileTask

The AbstractFileTask class is the base class of file related tasks. More...

### class AliasFinder

Creates component alias objects from parsed alias source files, based on version and source priorities. More...

### class AliasSource

Describes a source for alias declarations. More...

### class ArchiveEntry

The ArchiveEntry struct represents an entry in an archive file, which can be for example a file or a directory. More...

### class ArchiveFactory

The ArchiveFactory class is used to create archive objects based on the suffix of a given filename. More...

### class AspectRatioLabel

The AspectRatioLabel class provides a label for displaying a pixmap that maintains its original aspect ratio when resized. More...

### class CacheableItem

The CacheableItem is a pure virtual class that defines an interface for a type suited for storage with the GenericDataCache class. More...

### class CalculatorBase

### class ComponentAlias

The ComponentAlias class represents an alias for single or multiple components. More...

### class ComponentSortFilterProxyModel

The ComponentSortFilterProxyModel provides support for sorting and filtering data passed between another model and a view. More...

### class CustomComboBox

### class DirectoryGuard

RAII class to create a directory and delete it on destruction unless released. More...

### 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 GenericDataCache

The GenericDataCache is a template class for a checksum based storage of items on disk. More...

### class GuiProxy

### class Lib7zArchive

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

### class LibArchiveArchive

The LibArchiveArchive class represents an archive file handled with libarchive archive and compression library. More...

### class LibArchiveWrapper

The LibArchiveWrapper class provides an interface for interacting with archives handled using the libarchive archive and compression library. More...

### class MessageBoxHandler

The MessageBoxHandler class provides a modal dialog for informing the user or asking the user a question and receiving an answer. More...

### class Metadata

The Metadata class represents fetched metadata from a repository. More...

### class MetadataCache

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

### class PackageSource

The PackageSource class specifies a single package source. More...

### class PerformInstallationForm

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

### class ProgressCoordinator

### class RemoteServer

### class Repository

### class ScriptEngine

The ScriptEngine class is used to prepare and run the component scripts. More...

### class SystemInfo

Provides information about the operating system. More...

## 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.

## Function Documentation

### void QInstaller::appendByteArray(QFileDevice *out, const QByteArray &ba)

### void QInstaller::appendData(QFileDevice *out, QFileDevice *in, qint64 size)

### void QInstaller::appendInt64(QFileDevice *out, qint64 n)

### void QInstaller::appendInt64Range(QFileDevice *out, const Range<qint64> &r)

### void QInstaller::appendString(QFileDevice *out, const QString &str)

### void QInstaller::assertObjectType(QObjectPrivate *d)

### qint64 QInstaller::blockingCopy(QFileDevice *in, QFileDevice *out, qint64 size)

### qint64 QInstaller::blockingRead(QFileDevice *in, char *buffer, qint64 size)

### qint64 QInstaller::blockingWrite(QFileDevice *out, const QByteArray &data)

### qint64 QInstaller::blockingWrite(QFileDevice *out, const char *data, qint64 size)

### void QInstaller::copyConfigChildElements(QDomDocument &dom, const QDomNodeList &objects, const QString &sourceDir, const QString &targetDir)

### void QInstaller::copyDirectoryContents(const QString &sourceDir, const QString &targetDir)

### bool QInstaller::createDirectoryWithParents(const QString &path)

### quint64 QInstaller::fileSize(const QFileInfo &info)

### QString QInstaller::generateTemporaryFileName(const QString &templ = QString())

### QString QInstaller::getLongPathName(const QString &name)

### const QObject *QInstaller::getQObject(const QObjectPrivate *d)

### QString QInstaller::getShortPathName(const QString &name)

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

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

### QString QInstaller::humanReadableSize(const qint64 &size, int precision = 2)

### void QInstaller::init()

### bool QInstaller::isInBundle(const QString &path, QString *bundlePath = 0)

### bool QInstaller::isLocalUrl(const QUrl &url)

### const QLoggingCategory &QInstaller::lcDeveloperBuild()

### const QLoggingCategory &QInstaller::lcInstallerInstallLog()

### const QLoggingCategory &QInstaller::lcProgressIndicator()

### const QLoggingCategory &QInstaller::lcServer()

### QStringList QInstaller::loggingCategories()

Returns available logging categories.

### void QInstaller::mkdir(const QString &path)

### void QInstaller::mkpath(const QString &path)

### void QInstaller::moveDirectoryContents(const QString &sourceDir, const QString &targetDir)

### QString QInstaller::normalizePathName(const QString &name)

### void QInstaller::openForAppend(QFileDevice *dev)

### void QInstaller::openForRead(QFileDevice *dev)

### void QInstaller::openForWrite(QFileDevice *dev)

### QString QInstaller::pathFromUrl(const QUrl &url)

### hashValue QInstaller::qHash(const QInstaller::PackageSource &key, hashValue seed)

Returns the hash value for the key, using seed to seed the calculation.

### hashValue QInstaller::qHash(const QInstaller::AliasSource &key, hashValue seed)

### hashValue QInstaller::qHash(const QInstaller::Repository &repository)

### const QMetaObject *QInstaller::qt_getEnumMetaObject(QInstaller::AbstractArchive::CompressionLevel)

### const QMetaObject *QInstaller::qt_getEnumMetaObject(QInstaller::ComponentAlias::UnstableError)

### const char *QInstaller::qt_getEnumName(QInstaller::AbstractArchive::CompressionLevel)

### const char *QInstaller::qt_getEnumName(QInstaller::ComponentAlias::UnstableError)

### bool QInstaller::receivePacket(QIODevice *device, QByteArray *command, QByteArray *data)

Reads a packet from device, and stores its content into command and data.

Returns `false` if the packet in the device buffer is yet incomplete, `true` otherwise.

Note: Both client and server need to have the same endianness.

### void QInstaller::removeDirectory(const QString &path, bool ignoreErrors = false)

### void QInstaller::removeDirectoryThreaded(const QString &path, bool ignoreErrors = false)

### void QInstaller::removeFiles(const QString &path, bool ignoreErrors = false)

### void QInstaller::removeSystemGeneratedFiles(const QString &path)

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

### QString QInstaller::replacePath(const QString &path, const QString &pathBefore, const QString &pathAfter, bool cleanPath = true)

### QByteArray QInstaller::retrieveByteArray(QFileDevice *in)

### QByteArray QInstaller::retrieveData(QFileDevice *in, qint64 size)

### qint64 QInstaller::retrieveInt64(QFileDevice *in)

### Range<qint64> QInstaller::retrieveInt64Range(QFileDevice *in)

### QString QInstaller::retrieveString(QFileDevice *in)

### void QInstaller::sendPacket(QIODevice *device, const QByteArray &command, const QByteArray &data)

Write a packet containing command and data to device.

Note: Both client and server need to have the same endianness.

### void QInstaller::setApplicationIcon(const QString &application, const QString &icon)

### bool QInstaller::setDefaultFilePermissions(const QString &fileName, QInstaller::DefaultFilePermissions permissions)

### bool QInstaller::setDefaultFilePermissions(QFile *file, QInstaller::DefaultFilePermissions permissions)

### QStringList QInstaller::splitStringWithComma(const QString &value)

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

### void QInstaller::trimmedCopyConfigData(const QString &source, const QString &target, const QStringList &elementsToRemoveTags)

### QDataStream &QInstaller::operator<<(QDataStream &ostream, const QInstaller::ArchiveEntry &entry)

Writes an entry to the specified ostream. Returns a reference to ostream.

### bool QInstaller::operator==(const QInstaller::ArchiveEntry &lhs, const QInstaller::ArchiveEntry &rhs)

Returns `true` if left-hand-side entry lhs is equal to right-hand-size entry rhs.

### bool QInstaller::operator==(const QInstaller::PackageSource &lhs, const QInstaller::PackageSource &rhs)

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

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

### QDataStream &QInstaller::operator>>(QDataStream &istream, QInstaller::ArchiveEntry &entry)

Reads an entry from the specified istream. Returns a reference to istream.