Qt 5.11 | Qt Quick Controls 2 | C++ Classes | QQuickStyle

Qt 5.11.3 Reference Documentation

# QQuickStyle Class

The QQuickStyle class allows configuring the application style. More...

Header: | #include <QQuickStyle>
Since: | Qt 5.7

- List of all members, including inherited members

## Static Public Members

QStringList | availableStyles()
QString | name()
QString | path()
void | setFallbackStyle(const QString &style)
void | setStyle(const QString &style)

## Detailed Description

The QQuickStyle class allows configuring the application style.

QQuickStyle provides API for querying and configuring the application styles of Qt Quick Controls 2.

      #include <QGuiApplication>
      #include <QQmlApplicationEngine>
      #include <QQuickStyle>

      int main(int argc, char *argv[])
      {
          QGuiApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
          QGuiApplication app(argc, argv);

          QQuickStyle::setStyle("Material");

          QQmlApplicationEngine engine;
          engine.load(QUrl("qrc:/main.qml"));

          return app.exec();
      }

Note: The style must be configured before loading QML that imports Qt Quick Controls 2. It is not possible to change the style after the QML types have been registered.

The style can also be specified as a path to a custom style, such as `":/mystyle"`. See Creating a Custom Style for more details about building custom styles. Custom styles do not need to implement all controls. By default, the styling system uses the Default style as a fallback for controls that a custom style does not provide. It is possible to specify a different fallback style to customize or extend one of the built-in styles.

      QQuickStyle::setStyle(":/mystyle");
      QQuickStyle::setFallbackStyle("Material");

See also Styling Qt Quick Controls 2.

## Member Function Documentation

### `[static]` QStringList QQuickStyle::availableStyles()

Returns the names of the available built-in styles.

Note: The method must be called after creating an instance of QGuiApplication.

This function was introduced in Qt 5.9.

### `[static]` QString QQuickStyle::name()

Returns the name of the application style.

Note: The application style can be specified by passing a `-style` command line argument. Therefore `name()` may not return a fully resolved value if called before constructing a QGuiApplication.

### `[static]` QString QQuickStyle::path()

Returns the path of an overridden application style, or an empty string if the style is one of the built-in Qt Quick Controls 2 styles.

Note: The application style can be specified by passing a `-style` command line argument. Therefore `path()` may not return a fully resolved value if called before constructing a QGuiApplication.

### `[static]` void QQuickStyle::setFallbackStyle(const QString &style)

Sets the application fallback style to style.

Note: The fallback style must be the name of one of the built-in Qt Quick Controls 2 styles, e.g. "Material".

Note: The style must be configured before loading QML that imports Qt Quick Controls 2. It is not possible to change the style after the QML types have been registered.

The fallback style can be also specified by setting the `QT_QUICK_CONTROLS_FALLBACK_STYLE` environment variable.

This function was introduced in Qt 5.8.

See also setStyle() and Using Styles in Qt Quick Controls 2.

### `[static]` void QQuickStyle::setStyle(const QString &style)

Sets the application style to style.

Note: The style must be configured before loading QML that imports Qt Quick Controls 2. It is not possible to change the style after the QML types have been registered.

See also setFallbackStyle() and Using Styles in Qt Quick Controls 2.