QInstaller Namespace

Function Documentation

bool QInstaller::canCreateSymbolicLinks()

On Windows checks if the user account has the privilege required to create a symbolic links. Returns true if the privilege is held, false otherwise.

On Unix platforms always returns true.

QStringList QInstaller::checkMutualOptions(const CommandLineParser &parser, const QStringList &options)

Returns a list of mutually exclusive options passed to the parser, if there is at least one mutually exclusive pair of options set. Otherwise returns an empty QStringList. The options considered mutual are provided with options.

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)

Returns the given size in a measuring unit suffixed human readable format, with precision marking the number of shown decimals.

void QInstaller::init()

Initializes the 7z library and installer resources. Registers custom operations and installs a custom message handler.

QStringList QInstaller::loggingCategories()

Returns available logging categories.

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

Returns a hash of the repository.

hashValue QInstaller::qHash(const QInstaller::RepositoryCategory &repository)

Returns a hash of the repository category repository.

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

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

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

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

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.

void QInstaller::removeSystemGeneratedFiles(const QString &path)

Removes system generated files from path on Windows and macOS. Does nothing on Linux.

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.

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.

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

Write a packet containing command and data to device.

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

Sets permissions of file or directory specified by file to 644 or 755 based by the value of permissions. This is effective only on Unix platforms as setPermissions() does not manipulate ACLs. On Windows NTFS volumes this only unsets the legacy read-only flag regardless of the value of permissions.

Returns true on success, false otherwise.

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

Sets permissions of file or directory specified by fileName to 644 or 755 based by the value of permissions.

Returns true on success, false otherwise.

bool QInstaller::startDetached(const QString &program, const QStringList &arguments, const QString &workingDirectory, qint64 *pid = 0)

Starts the program program with the arguments arguments in a new process, and detaches from it. Returns true on success; otherwise returns false. If the calling process exits, the detached process will continue to live.

Note that arguments that contain spaces are not passed to the process as separate arguments.

Unix: The started process will run in its own session and act like a daemon. Windows: Arguments that contain spaces are wrapped in quotes. The started process will run as a regular standalone process.

The process will be started in the directory workingDirectory.

If the function is successful then pid is set to the process identifier of the started process.

Additional note: The difference in using this function over its equivalent from QProcess appears on Windows. While this function will truly detach and not show a GUI window for the started process, the QProcess version will.

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

Copies an internal configuration file from source to target. The XML elements, and their children, specified by elementsToRemoveTags will be removed from the target file. All relative filenames referenced in the source configuration file will be also copied to the location of the target file.

Throws QInstaller::Error in case of failure.

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

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

QDebug QInstaller::operator<<(QDebug dbg, QInstaller::Component *component)

Returns the debugging output stream, dbg, for the component component.

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

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

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.

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

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