aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols/doc/src/qtquickcontrols-macos.qdoc
blob: c024b7fb82d425a824e5f4844c5a3b7c02ddebb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \page qtquickcontrols-macos.html
    \title macOS Style

    The macOS style is a style that looks native on macOS.
    \l {detailed-desc-macOS}{More...}

    \styleimport {QtQuick.Controls.macOS} {Qt 6.0}

    \target detailed-desc-macOS

    The macOS style is a style that looks native on macOS. The controls are drawn run-time using
    native frameworks, and is therefore only available for applications running on macOS.

    \note Be aware that the apperance of this style can change from one minor Qt version to the
    next, to better blend in with native applications on the platform.

    \include style-screenshots.qdocinc {file} {macOS} {macos}

    To run an application with the macOS style, see
    \l {Using Styles in Qt Quick Controls}.

    \section2 Current state

    The macOS style is under development, and some controls are not yet supported. Those
    controls are: \l BusyIndicator, \l DelayButton, \l PageIndicator, \l RangeSlider, \l Switch, \l TabBar and
    \l Tumbler. Those will fall back to use the \l {Fusion Style}.

    \section2 Customization

    The goal of the macOS style is to for the controls look and feel as similar as possible to the
    native controls in UIKit. The style will follow the theme and colors configured globally from
    System Preferences, and does not come with a separate customization API on top of that.

    \note The macOS style is not suitable for \l {Customizing Qt Quick Controls}{customizing}.
    The main reason is that it sometimes draw both the contents and the background
    onto a single background item, which will not look good together with a custom contentItem.
    It also tends to use padding and inset values that are different from the other styles.
    \include customizing-native-styles.qdocinc
*/