PackageManagerPage Class | Qt Installer Framework Manual

Qt Installer Framework Manual | PackageManagerPage

# PackageManagerPage Class

(QInstaller::PackageManagerPage)

The PackageManagerPage class displays information about the product to install. More...

Header: | #include <PackageManagerPage>
Inherited By: | QInstaller::ComponentSelectionPage, QInstaller::FinishedPage, QInstaller::IntroductionPage, QInstaller::LicenseAgreementPage, QInstaller::PerformInstallationPage, QInstaller::ReadyForInstallationPage, QInstaller::RestartPage, QInstaller::StartMenuDirectoryPage, and QInstaller::TargetDirectoryPage

- List of all members, including inherited members

## Public Functions

| PackageManagerPage(PackageManagerCore *core)
virtual | ~PackageManagerPage()
virtual QPixmap | bannerPixmap() const
PackageManagerGui * | gui() const
virtual bool | isComplete() const
virtual bool | isInterruptible() const
virtual QPixmap | logoPixmap() const
virtual QString | productName() const
void | setColoredSubTitle(const QString &subTitle)
void | setColoredTitle(const QString &title)
void | setComplete(bool complete)
void | setSettingsButtonRequested(bool request)
void | setValidatePageComponent(QInstaller::Component *component)
bool | settingsButtonRequested() const
bool | validatePage()
virtual QPixmap | watermarkPixmap() const

## Signals

void | entered()
void | left()

## Protected Functions

virtual void | entering()
virtual QWidget * | findWidget(const QString &objectName) const
virtual void | insertWidget(QWidget *widget, const QString &siblingName, int offset = 1)
virtual void | leaving()
virtual int | nextId() const
PackageManagerCore * | packageManagerCore() const

## Detailed Description

The PackageManagerPage class displays information about the product to install.

## Member Function Documentation

### PackageManagerPage::PackageManagerPage(PackageManagerCore *core)

Constructs a package manager page with core as parent.

### `[virtual]` PackageManagerPage::~PackageManagerPage()

Destructs a package manager page.

### `[virtual]` QPixmap PackageManagerPage::bannerPixmap() const

Returns the banner pixmap specified in the `<Banner>` element of the package information file. Only used by the modern UI style.

### `[signal]` void PackageManagerPage::entered()

This signal is called when a page is entered.

### `[virtual protected]` void PackageManagerPage::entering()

Called when end users enter the page and the PackageManagerGui:currentPageChanged() signal is triggered. Supports the QWizardPage::​initializePage() function to ensure that the page's fields are properly initialized based on fields from previous pages. Otherwise, `initializePage()` would only be called once if the installer has been set to QWizard::IndependentPages.

### `[virtual protected]` QWidget *PackageManagerPage::findWidget(const QString &objectName) const

Returns the widget specified by objectName.

### PackageManagerGui *PackageManagerPage::gui() const

Returns the wizard this page belongs to.

### `[virtual protected]` void PackageManagerPage::insertWidget(QWidget *widget, const QString &siblingName, int offset = 1)

Inserts widget at the position specified by offset in relation to another widget specified by siblingName. The default position is directly behind the sibling.

### `[virtual]` bool PackageManagerPage::isComplete() const

Returns `true` if the page is complete; otherwise, returns `false`.

### `[virtual]` bool PackageManagerPage::isInterruptible() const

Returns `true` if the installation can be interrupted.

### `[virtual protected]` void PackageManagerPage::leaving()

Called when end users leave the page and the PackageManagerGui:currentPageChanged() signal is triggered.

### `[signal]` void PackageManagerPage::left()

This signal is called when a page is left.

### `[virtual]` QPixmap PackageManagerPage::logoPixmap() const

Returns the logo pixmap specified in the `<Logo>` element of the package information file.

### `[virtual protected]` int PackageManagerPage::nextId() const

Determines which page should be shown next depending on whether the application is being installed, updated, or uninstalled.

The license check page is shown only if a component that provides a license is selected for installation. It is hidden during uninstallation and update.

### `[protected]` PackageManagerCore *PackageManagerPage::packageManagerCore() const

Returns the package manager core.

### `[virtual]` QString PackageManagerPage::productName() const

Returns the product name of the application being installed.

### void PackageManagerPage::setColoredSubTitle(const QString &subTitle)

Sets the font color of subTitle.

### void PackageManagerPage::setColoredTitle(const QString &title)

Sets the font color of title. The title is specified in the `<Title>` element of the package information file. It is the name of the installer as displayed on the title bar.

### void PackageManagerPage::setComplete(bool complete)

Sets the package manager page to complete if complete is `true`. Emits the completeChanged() signal.

See also isComplete().

### void PackageManagerPage::setSettingsButtonRequested(bool request)

Determines that the page should request the Settings button if request is `true`.

See also settingsButtonRequested().

### void PackageManagerPage::setValidatePageComponent(QInstaller::Component *component)

Sets component as the component that validates the page.

### bool PackageManagerPage::settingsButtonRequested() const

Returns `true` if the page requests the wizard to show the Settings button.

### bool PackageManagerPage::validatePage()

Returns `true` if the end user has entered complete and valid information.

### `[virtual]` QPixmap PackageManagerPage::watermarkPixmap() const

Returns the watermark pixmap specified in the `<Watermark>` element of the package information file.