Core::IOptionsPage Class | Extending Qt Creator Manual
Description: The IOptionsPage class is an interface for providing pages for the Options dialog (called Preferences on macOS).

- Extending Qt Creator Manual
- QtCreator
- IOptionsPage
- Extending Qt Creator Manual 19.0.0

# Core::IOptionsPage Class

class Core::IOptionsPage

The IOptionsPage class is an interface for providing pages for the Options dialog (called Preferences on macOS). More...

Header: | `#include <coreplugin/dialogs/ioptionspage.h>`

- List of all members, including inherited members

## Public Functions

| IOptionsPage(bool registerGlobally = true)
Utils::Id | category() const
Utils::FilePath | categoryIconPath() const
QString | displayCategory() const
QString | displayName() const
Utils::Id | id() const

## Static Public Members

const QList<Core::IOptionsPage *> | allOptionsPages()
void | registerCategory(Utils::Id id, const QString &displayName, const Utils::FilePath &iconPath)

## Protected Functions

void | setDisplayName(const QString &displayName)
void | setId(Utils::Id id)

## Detailed Description

## Member Function Documentation

### `[explicit]` IOptionsPage::IOptionsPage(bool registerGlobally = true)

Constructs an options page and registers it at the global options page pool if registerGlobally is `true`.

### `[static]` const QList<Core::IOptionsPage *> IOptionsPage::allOptionsPages()

Returns a list of all options pages.

### Utils::Id IOptionsPage::category() const

Returns the unique id for the category that the options page should be displayed in. This id is used for sorting the list on the left side of the Options dialog.

### Utils::FilePath IOptionsPage::categoryIconPath() const

Returns the path to the category icon of the options page. This icon will be read from this path and displayed in the list on the left side of the Options dialog.

### QString IOptionsPage::displayCategory() const

Returns the translated category name of the options page. This name is displayed in the list on the left side of the Options dialog.

### QString IOptionsPage::displayName() const

Returns the translated display name of the options page.

See also setDisplayName().

### Utils::Id IOptionsPage::id() const

Returns a unique identifier for referencing the options page.

See also setId().

### `[static]` void IOptionsPage::registerCategory(Utils::Id id, const QString &displayName, const Utils::FilePath &iconPath)

Registers a category with the ID id, user-visible name displayName, and icon specified by iconPath.

### `[protected]` void IOptionsPage::setDisplayName(const QString &displayName)

Sets displayName as the display name of the options page.

See also displayName().

### `[protected]` void IOptionsPage::setId(Utils::Id id)

Sets the id of the options page.

See also id().