prefs.js

/* prefs.js
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

/* exported init, fillPreferencesWindow */

'use strict';

import Adw from 'gi://Adw';
import Gio from 'gi://Gio';

import {ExtensionPreferences, gettext as _} from 'resource:///org/gnome/Shell/Extensions/js/extensions/prefs.js';

export default class KMonadTogglePreferences extends ExtensionPreferences {
    fillPreferencesWindow(window) {
        window._settings = this.getSettings();

        const page = new Adw.PreferencesPage();
        window.add(page);

        const group = new Adw.PreferencesGroup({
            description: _(
                'This extension does not manage the KMonad installation.' +
                ' See the <a href="https://github.com/kmonad/kmonad/blob/master/doc/installation.md">Installation guide</a>' +
                ' and <a href="https://github.com/kmonad/kmonad/blob/master/doc/faq.md">FAQ</a>' +
                ' for instructions on how to set it up.'
            ),
        });
        page.add(group);

        group.add(createSettingsToggle(window._settings, 'kmonad-running', 'Start KMonad now'));
        group.add(createSettingsToggle(window._settings, 'autostart-kmonad', 'Autostart KMonad'));

        const kmonadGroup = new Adw.PreferencesGroup({
            title: _('KMonad configuration'),
            description: _(
                'Shell expansion is not supported, so please use absolute paths.'
            ),
        });
        page.add(kmonadGroup);

        kmonadGroup.add(createSettingsEntry(window._settings, 'kmonad-command', 'Custom command'));
    }
}

/**
 * Creates an Adw.ActionRow with a Gtk.Switch and binds it to a boolean key in
 * the settings object.
 *
 * @param {Gio.Settings} settings - The settings object
 * @param {string} key - The key to bind to
 * @param {string} title - The title of the row
 * @returns {Adw.ActionRow} The row
 */
function createSettingsToggle(settings, key, title) {
    const row = new Adw.SwitchRow({
        title,
    });

    settings.bind(key, row, 'active',
        Gio.SettingsBindFlags.DEFAULT);

    return row;
}

/**
 * Creates an Adw.EntryRow and binds it to a string key in the settings object.
 *
 * @param {Gio.Settings} settings - The settings object
 * @param {string} key - The key to bind to
 * @param {string} title - The title of the row
 * @returns {Adw.EntryRow} The row
 */
function createSettingsEntry(settings, key, title) {
    const row = new Adw.EntryRow({
        title: _(title),
        text: settings.get_string(key),
    });
    settings.bind(key, row, 'text', Gio.SettingsBindFlags.DEFAULT);

    return row;
}