Skip to content
AtlasOSFramework API
Browse the docs

AtlasPreferencesPage

One page of an AtlasPreferencesDialog: a title and symbol for the sidebar, and Sections of form entries.

Since 1.5.0

An AtlasPreferencesPage is an AtlasForm that belongs to an AtlasPreferencesDialog. Put Sections of AtlasFormEntry rows inside, as in any form. Its entries, valid and validate() work for the page; the entries use the dialog's settings unless the page has its own.

Example

AtlasPreferencesPage {
    title: qsTr("General")
    symbol: Symbols.Settings
    Section {
        AtlasFormEntry {
            label: qsTr("Show hidden files")
            settingKey: "ShowHidden"
            AtlasSwitch { }
        }
    }
}

Properties

Name Type Default Description
title string "" The page's name in the dialog's sidebar and in the search results.
symbol int 0 A Symbols value shown beside the title in the sidebar.