Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 2.71 KB

system-settings.md

File metadata and controls

70 lines (55 loc) · 2.71 KB
Raw
description
Deep linking to System Settings

System Settings

Some of the features of your application may depend on system level settings or services, such as Internet connectivity or app level access to the network. While your app cannot directly change those settings, it can prompt users to change them by linking to specific panes in the System Settings.

elementary OS implements a special settings:// URI scheme for linking to System Settings. The links lead to specific settings panes. You can find most commonly used ones in the Granite.SettingsUri namespace in the Granite library.

Opening a link

First, make sure you've included recent enough version of Granite and Gtk in the build dependencies declared in your meson.build file. You can get those dependencies by using the elementary Flatpak runtime version 7.2 or newer:

{% tabs %} {% tab title="meson.build" %}

executable(
    meson.project_name(),
    'src' / 'Application.vala',
    dependencies: [
        dependency('granite-7', version: '>= 7.3.0'),
        dependency('gtk4', version: '>= 4.10.0')
    ],
    install: true
)

{% endtab %} {% tab title="Flatpak manifest" %}

runtime: io.elementary.Platform
runtime-version: '7.2'
sdk: io.elementary.Sdk

{% endtab %} {% endtabs %}

Then you can open Network settings by launching Granite.SettingsUri.NETWORK:

var button = new Gtk.Button.with_label ("Change network settings");
button.clicked.connect (() => {
    var launcher = new Gtk.UriLauncher (Granite.SettingsUri.NETWORK);
    launcher.launch.begin(null, null, (obj, res) => {
        try {
            launcher.launch.end (res);
        } catch (Error e) {
            warning ("Failed to open network settings: %s", e.message);
        }
    });
});

You can find out more about the Gtk.UriLauncher in its documentation.

Use cases

There are roughly two categories of settings that you can prompt users to change: general purpose and app specific. General ones include:

  • Granite.SettingsUri.NETWORK, where connection to the Internet can be enabled
  • Granite.SettingsUri.ONLINE_ACCOUNTS, where users can add their CalDAV and IMAP accounts
  • Granite.SettingsUri.SOUND_INPUT, where microphone input can be enabled

while app specific ones are:

  • Granite.SettingsUri.PERMISSIONS, where Flatpak permissions are managed
  • Granite.SettingsUri.LOCATION, where access to location data can be granted
  • Granite.SettingsUri.NOTIFICATIONS, where presentation of app notifications can be customized
  • Granite.SettingsUri.SHORTCUTS, where global keyboard shortcuts can be added