Qt 5.8 | Qt Quick Controls 2 | Qt Quick Controls 2 Configuration File

Qt 5.8.0 Reference Documentation

# Qt Quick Controls 2 Configuration File

Qt Quick Controls 2 support a special configuration file, `:/qtquickcontrols2.conf`, that is built into an application's resources.

The configuration file can specify the preferred style and certain style-specific attributes. The following example specifies that the preferred style is the Material style. Furthermore, when the application is run with the Material style, its theme is light and the accent and primary colors are teal and blue grey, respectively. However, if the application is run with the Universal style instead, the accent color is red and the appropriate theme is chosen based on the system theme colors.

      [Controls]
      Style=Material

      [Universal]
      Theme=System
      Accent=Red

      [Material]
      Theme=Light
      Accent=Teal
      Primary=BlueGrey

Material style specific values that can be specified in a `Material` section of the configuration file:

Variable | Description
--- | ---
`Theme` | Specifies the default Material theme. The value can be one of the available themes, for example `"Dark"`.
`Accent` | Specifies the default Material accent color. The value can be any color, but it is recommended to use one of the pre-defined Material colors, for example `"Teal"`.
`Primary` | Specifies the default Material primary color. The value can be any color, but it is recommended to use one of the pre-defined Material colors, for example `"BlueGrey"`.
`Foreground` | Specifies the default Material foreground color. The value can be any color, or one of the pre-defined Material colors, for example `"Brown"`.
`Background` | Specifies the default Material background color. The value can be any color, or one of the pre-defined Material colors, for example `"Grey"`.

Universal style specific values that can be specified in a `Universal` section of the configuration file:

Variable | Description
--- | ---
`Theme` | Specifies the default Universal theme. The value can be one of the available themes, for example `"Dark"`.
`Accent` | Specifies the default Universal accent color. The value can be any color, but it is recommended to use one of the pre-defined Universal colors, for example `"Violet"`.
`Foreground` | Specifies the default Universal foreground color. The value can be any color, or one of the pre-defined Universal colors, for example `"Brown"`.
`Background` | Specifies the default Universal background color. The value can be any color, or one of the pre-defined Universal colors, for example `"Steel"`.

In order to make it possible for Qt Quick Controls 2 to find the configuration file, it must be built into application's resources using the The Qt Resource System. Here's an example `.qrc` file:

      <!DOCTYPE RCC><RCC version="1.0">
      <qresource prefix="/">
          <file>qtquickcontrols2.conf</file>
      </qresource>
      </RCC>

Note: Qt Quick Controls 2 uses a file selector to load the configuration file. It is possible to provide a different configuration file for different platforms and locales. See QFileSelector documentation for more details.

Finally, the `.qrc` file must be listed in the application's `.pro` file so that the build system knows about it. For example:

      RESOURCES = application.qrc

## Related Information

- Styling Qt Quick Controls 2
- Supported Environment Variables in Qt Quick Controls 2