biipadmin/Burn-My-Windows
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

🔧 Make effect classes static

Browse Source
This commit is contained in:
Simon Schneegans
2022-01-09 13:49:03 +01:00
parent f8b17eadea
commit b726064e65
7 changed files with 160 additions and 230 deletions
Download Patch File Download Diff File Expand all files Collapse all files
prefs.js
+100 -11
View File
@@ -23,7 +23,6 @@ const FirePage = Me.imports.src.prefs.FirePage.FirePage;
const MatrixPage = Me.imports.src.prefs.MatrixPage.MatrixPage; const MatrixPage = Me.imports.src.prefs.MatrixPage.MatrixPage;
const TVEffectPage = Me.imports.src.prefs.TVEffectPage.TVEffectPage; const TVEffectPage = Me.imports.src.prefs.TVEffectPage.TVEffectPage;
const TRexPage = Me.imports.src.prefs.TRexPage.TRexPage; const TRexPage = Me.imports.src.prefs.TRexPage.TRexPage;
const GeneralPage = Me.imports.src.prefs.GeneralPage.GeneralPage;
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
// For now, the preferences dialog of this extension is very simple. In the future, if // // For now, the preferences dialog of this extension is very simple. In the future, if //
@@ -48,14 +47,20 @@ var PreferencesDialog = class PreferencesDialog {
this._builder = new Gtk.Builder(); this._builder = new Gtk.Builder();
this._builder.add_from_resource(`/ui/common/main-menu.ui`); this._builder.add_from_resource(`/ui/common/main-menu.ui`);
this._builder.add_from_resource(`/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/prefs.ui`); this._builder.add_from_resource(`/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/prefs.ui`);
this._builder.add_from_resource(
`/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/generalPage.ui`);
this._generalPAge = new GeneralPage(this._settings, this._builder); // Bind general options properties.
this.bindSwitch('destroy-dialogs');
const stack = this._builder.get_object('main-stack');
stack.add_titled(
this._builder.get_object('general-prefs'), 'general', 'General Options');
this._effects = [];
EFFECT_TYPES.forEach(Type => { EFFECT_TYPES.forEach(Type => {
const [minMajor, minMinor] = Type.getMinShellVersion(); const [minMajor, minMinor] = Type.getMinShellVersion();
if (utils.shellVersionIsAtLeast(minMajor, minMinor)) { if (utils.shellVersionIsAtLeast(minMajor, minMinor)) {
this._effects.push(new Type(this._settings, this._builder)); Type.initPreferences(this);
} }
}); });
@@ -102,15 +107,18 @@ var PreferencesDialog = class PreferencesDialog {
const menu = this._builder.get_object('close-effect-menu'); const menu = this._builder.get_object('close-effect-menu');
this._effects.forEach(effect => { EFFECT_TYPES.forEach(Type => {
const prefix = effect.constructor.getSettingsPrefix(); const [minMajor, minMinor] = Type.getMinShellVersion();
const label = effect.constructor.getLabel(); if (utils.shellVersionIsAtLeast(minMajor, minMinor)) {
const prefix = Type.getSettingsPrefix();
const label = Type.getLabel();
const action = this._settings.create_action(`${prefix}-close-effect`); const action = this._settings.create_action(`${prefix}-close-effect`);
group.add_action(action); group.add_action(action);
menu.append_item( menu.append_item(
Gio.MenuItem.new(label, `close-effects.${prefix}-close-effect`)); Gio.MenuItem.new(label, `close-effects.${prefix}-close-effect`));
}
}); });
} }
}); });
@@ -130,10 +138,91 @@ var PreferencesDialog = class PreferencesDialog {
// -------------------------------------------------------------------- public interface // -------------------------------------------------------------------- public interface
getBuilder() {
return this._builder;
}
getSettings() {
return this._settings;
}
// Returns the widget used for the settings of this extension. // Returns the widget used for the settings of this extension.
getWidget() { getWidget() {
return this._widget; return this._widget;
} }
// Connects a Gtk.ComboBox (or anything else which has an 'active-id' property) to a
// settings key. It also binds the corresponding reset button.
bindCombobox(settingsKey) {
this._bind(settingsKey, 'active-id');
}
// Connects a Gtk.Adjustment (or anything else which has a 'value' property) to a
// settings key. It also binds the corresponding reset button.
bindAdjustment(settingsKey) {
this._bind(settingsKey, 'value');
}
// Connects a Gtk.Switch (or anything else which has an 'active' property) to a settings
// key. It also binds the corresponding reset button.
bindSwitch(settingsKey) {
this._bind(settingsKey, 'active');
}
// Colors are stored as strings like 'rgb(1, 0.5, 0)'. As Gio.Settings.bind_with_mapping
// is not available yet, we need to do the color conversion manually. It also binds the
// corresponding reset button.
bindColorButton(settingsKey) {
const button = this._builder.get_object(settingsKey);
if (button) {
// Update the settings when the color is modified.
button.connect('color-set', () => {
this._settings.set_string(settingsKey, button.get_rgba().to_string());
});
// Update the button state when the settings change.
const settingSignalHandler = () => {
const rgba = new Gdk.RGBA();
rgba.parse(this._settings.get_string(settingsKey));
button.rgba = rgba;
};
this._settings.connect('changed::' + settingsKey, settingSignalHandler);
// Initialize the button with the state in the settings.
settingSignalHandler();
}
this._bindResetButton(settingsKey);
}
// ----------------------------------------------------------------------- private stuff
// Searches for a reset button for the given settings key and make it reset the settings
// key when clicked.
_bindResetButton(settingsKey) {
const resetButton = this._builder.get_object('reset-' + settingsKey);
if (resetButton) {
resetButton.connect('clicked', () => {
this._settings.reset(settingsKey);
});
}
}
// Connects any widget's property to a settings key. The widget must have the same ID as
// the settings key. It also binds the corresponding reset button.
_bind(settingsKey, property) {
const object = this._builder.get_object(settingsKey);
if (object) {
this._settings.bind(settingsKey, object, property, Gio.SettingsBindFlags.DEFAULT);
}
this._bindResetButton(settingsKey);
}
} }
// Nothing to do for now... // Nothing to do for now...
src/prefs/FirePage.js
+31 -35
View File
@@ -18,12 +18,11 @@ const {Gio} = imports.gi;
const ExtensionUtils = imports.misc.extensionUtils; const ExtensionUtils = imports.misc.extensionUtils;
const Me = imports.misc.extensionUtils.getCurrentExtension(); const Me = imports.misc.extensionUtils.getCurrentExtension();
const utils = Me.imports.src.common.utils; const utils = Me.imports.src.common.utils;
const PrefsPage = Me.imports.src.prefs.PrefsPage.PrefsPage;
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
var FirePage = class FirePage extends PrefsPage { var FirePage = class FirePage {
// ---------------------------------------------------------------------- static methods // ---------------------------------------------------------------------- static methods
@@ -39,46 +38,43 @@ var FirePage = class FirePage extends PrefsPage {
return 'Fire'; return 'Fire';
} }
// ------------------------------------------------------------ constructor / destructor static initPreferences(dialog) {
constructor(settings, builder) { dialog.getBuilder().add_from_resource(
super(settings, builder);
this._builder.add_from_resource(
`/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/firePage.ui`); `/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/firePage.ui`);
// Bind all properties. // Bind all properties.
this._bindAdjustment('fire-animation-time'); dialog.bindAdjustment('fire-animation-time');
this._bindAdjustment('flame-movement-speed'); dialog.bindAdjustment('flame-movement-speed');
this._bindAdjustment('flame-scale'); dialog.bindAdjustment('flame-scale');
this._bindSwitch('flame-3d-noise'); dialog.bindSwitch('flame-3d-noise');
this._bindColorButton('fire-color-1'); dialog.bindColorButton('fire-color-1');
this._bindColorButton('fire-color-2'); dialog.bindColorButton('fire-color-2');
this._bindColorButton('fire-color-3'); dialog.bindColorButton('fire-color-3');
this._bindColorButton('fire-color-4'); dialog.bindColorButton('fire-color-4');
this._bindColorButton('fire-color-5'); dialog.bindColorButton('fire-color-5');
// The fire-gradient-reset button needs to be bound explicitly. // The fire-gradient-reset button needs to be bound explicitly.
this._builder.get_object('reset-fire-colors').connect('clicked', () => { dialog.getBuilder().get_object('reset-fire-colors').connect('clicked', () => {
this._settings.reset('fire-color-1'); dialog.getSettings().reset('fire-color-1');
this._settings.reset('fire-color-2'); dialog.getSettings().reset('fire-color-2');
this._settings.reset('fire-color-3'); dialog.getSettings().reset('fire-color-3');
this._settings.reset('fire-color-4'); dialog.getSettings().reset('fire-color-4');
this._settings.reset('fire-color-5'); dialog.getSettings().reset('fire-color-5');
}); });
// Initialize the fire-preset dropdown. // Initialize the fire-preset dropdown.
this._createFirePresets(); FirePage._createFirePresets(dialog);
const stack = this._builder.get_object('main-stack'); const stack = dialog.getBuilder().get_object('main-stack');
stack.add_titled(this._builder.get_object('fire-prefs'), 'fire', 'Fire'); stack.add_titled(dialog.getBuilder().get_object('fire-prefs'), 'fire', 'Fire');
} }
// ----------------------------------------------------------------------- private stuff // ----------------------------------------------------------------------- private stuff
// This populates the preset dropdown menu for the fire options. // This populates the preset dropdown menu for the fire options.
_createFirePresets() { static _createFirePresets(dialog) {
this._builder.get_object('settings-widget').connect('realize', (widget) => { dialog.getBuilder().get_object('settings-widget').connect('realize', (widget) => {
const presets = [ const presets = [
{ {
name: 'Default Fire', name: 'Default Fire',
@@ -144,19 +140,19 @@ var FirePage = class FirePage extends PrefsPage {
// Load the preset on activation. // Load the preset on activation.
action.connect('activate', () => { action.connect('activate', () => {
this._settings.set_double('flame-movement-speed', preset.speed); dialog.getSettings().set_double('flame-movement-speed', preset.speed);
this._settings.set_double('flame-scale', preset.scale); dialog.getSettings().set_double('flame-scale', preset.scale);
this._settings.set_string('fire-color-1', preset.color1); dialog.getSettings().set_string('fire-color-1', preset.color1);
this._settings.set_string('fire-color-2', preset.color2); dialog.getSettings().set_string('fire-color-2', preset.color2);
this._settings.set_string('fire-color-3', preset.color3); dialog.getSettings().set_string('fire-color-3', preset.color3);
this._settings.set_string('fire-color-4', preset.color4); dialog.getSettings().set_string('fire-color-4', preset.color4);
this._settings.set_string('fire-color-5', preset.color5); dialog.getSettings().set_string('fire-color-5', preset.color5);
}); });
group.add_action(action); group.add_action(action);
}); });
this._builder.get_object('fire-preset-button').set_menu_model(menu); dialog.getBuilder().get_object('fire-preset-button').set_menu_model(menu);
const root = utils.isGTK4() ? widget.get_root() : widget.get_toplevel(); const root = utils.isGTK4() ? widget.get_root() : widget.get_toplevel();
root.insert_action_group(groupName, group); root.insert_action_group(groupName, group);
src/prefs/GeneralPage.js
-43
View File
@@ -1,43 +0,0 @@
//////////////////////////////////////////////////////////////////////////////////////////
// ) ( //
// ( /( ( ( ) ( ( ( ( )\ ) ( ( //
// )\()) ))\ )( ( ( )\ ) )\))( )\ ( (()/( ( )\))( ( //
// ((_)\ /((_|()\ )\ ) )\ '(()/( ((_)()((_) )\ ) ((_)))\((_)()\ )\ //
// | |(_|_))( ((_)_(_/( _((_)) )(_)) _(()((_|_)_(_/( _| |((_)(()((_|(_) //
// | '_ \ || | '_| ' \)) | ' \()| || | \ V V / | ' \)) _` / _ \ V V (_-< //
// |_.__/\_,_|_| |_||_| |_|_|_| \_, | \_/\_/|_|_||_|\__,_\___/\_/\_//__/ //
// |__/ //
// Copyright (c) 2021 Simon Schneegans //
// Released under the GPLv3 or later. See LICENSE file for details. //
//////////////////////////////////////////////////////////////////////////////////////////
'use strict';
const ExtensionUtils = imports.misc.extensionUtils;
const Me = imports.misc.extensionUtils.getCurrentExtension();
const utils = Me.imports.src.common.utils;
const PrefsPage = Me.imports.src.prefs.PrefsPage.PrefsPage;
//////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////
var GeneralPage = class GeneralPage extends PrefsPage {
// ------------------------------------------------------------ constructor / destructor
constructor(settings, builder) {
super(settings, builder);
this._builder.add_from_resource(
`/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/generalPage.ui`);
// Bind all properties.
this._bindSwitch('destroy-dialogs');
const stack = this._builder.get_object('main-stack');
stack.add_titled(
this._builder.get_object('general-prefs'), 'general', 'General Options');
}
// ---------------------------------------------------------------------- public methods
}
src/prefs/MatrixPage.js
+10 -14
View File
@@ -16,12 +16,11 @@
const ExtensionUtils = imports.misc.extensionUtils; const ExtensionUtils = imports.misc.extensionUtils;
const Me = imports.misc.extensionUtils.getCurrentExtension(); const Me = imports.misc.extensionUtils.getCurrentExtension();
const utils = Me.imports.src.common.utils; const utils = Me.imports.src.common.utils;
const PrefsPage = Me.imports.src.prefs.PrefsPage.PrefsPage;
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
var MatrixPage = class MatrixPage extends PrefsPage { var MatrixPage = class MatrixPage {
// ---------------------------------------------------------------------- static methods // ---------------------------------------------------------------------- static methods
@@ -37,21 +36,18 @@ var MatrixPage = class MatrixPage extends PrefsPage {
return 'Matrix'; return 'Matrix';
} }
// ------------------------------------------------------------ constructor / destructor static initPreferences(dialog) {
constructor(settings, builder) { dialog.getBuilder().add_from_resource('/ui/gtk4/matrixPage.ui');
super(settings, builder);
this._builder.add_from_resource('/ui/gtk4/matrixPage.ui');
// Bind all properties. // Bind all properties.
this._bindAdjustment('matrix-animation-time'); dialog.bindAdjustment('matrix-animation-time');
this._bindAdjustment('matrix-scale'); dialog.bindAdjustment('matrix-scale');
this._bindAdjustment('matrix-randomness'); dialog.bindAdjustment('matrix-randomness');
this._bindColorButton('matrix-trail-color'); dialog.bindColorButton('matrix-trail-color');
this._bindColorButton('matrix-tip-color'); dialog.bindColorButton('matrix-tip-color');
const stack = this._builder.get_object('main-stack'); const stack = dialog.getBuilder().get_object('main-stack');
stack.add_titled(this._builder.get_object('matrix-prefs'), 'matrix', 'Matrix'); stack.add_titled(dialog.getBuilder().get_object('matrix-prefs'), 'matrix', 'Matrix');
} }
} }
src/prefs/PrefsPage.js
-102
View File
@@ -1,102 +0,0 @@
//////////////////////////////////////////////////////////////////////////////////////////
// ) ( //
// ( /( ( ( ) ( ( ( ( )\ ) ( ( //
// )\()) ))\ )( ( ( )\ ) )\))( )\ ( (()/( ( )\))( ( //
// ((_)\ /((_|()\ )\ ) )\ '(()/( ((_)()((_) )\ ) ((_)))\((_)()\ )\ //
// | |(_|_))( ((_)_(_/( _((_)) )(_)) _(()((_|_)_(_/( _| |((_)(()((_|(_) //
// | '_ \ || | '_| ' \)) | ' \()| || | \ V V / | ' \)) _` / _ \ V V (_-< //
// |_.__/\_,_|_| |_||_| |_|_|_| \_, | \_/\_/|_|_||_|\__,_\___/\_/\_//__/ //
// |__/ //
// Copyright (c) 2021 Simon Schneegans //
// Released under the GPLv3 or later. See LICENSE file for details. //
//////////////////////////////////////////////////////////////////////////////////////////
'use strict';
const {Gdk, Gio} = imports.gi;
//////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////
var PrefsPage = class PrefsPage {
// ------------------------------------------------------------ constructor / destructor
constructor(settings, builder) {
this._settings = settings;
this._builder = builder;
}
// ---------------------------------------------------------------------- public methods
// Connects a Gtk.ComboBox (or anything else which has an 'active-id' property) to a
// settings key. It also binds the corresponding reset button.
_bindCombobox(settingsKey) {
this._bind(settingsKey, 'active-id');
}
// Connects a Gtk.Adjustment (or anything else which has a 'value' property) to a
// settings key. It also binds the corresponding reset button.
_bindAdjustment(settingsKey) {
this._bind(settingsKey, 'value');
}
// Connects a Gtk.Switch (or anything else which has an 'active' property) to a settings
// key. It also binds the corresponding reset button.
_bindSwitch(settingsKey) {
this._bind(settingsKey, 'active');
}
// Colors are stored as strings like 'rgb(1, 0.5, 0)'. As Gio.Settings.bind_with_mapping
// is not available yet, we need to do the color conversion manually. It also binds the
// corresponding reset button.
_bindColorButton(settingsKey) {
const button = this._builder.get_object(settingsKey);
if (button) {
// Update the settings when the color is modified.
button.connect('color-set', () => {
this._settings.set_string(settingsKey, button.get_rgba().to_string());
});
// Update the button state when the settings change.
const settingSignalHandler = () => {
const rgba = new Gdk.RGBA();
rgba.parse(this._settings.get_string(settingsKey));
button.rgba = rgba;
};
this._settings.connect('changed::' + settingsKey, settingSignalHandler);
// Initialize the button with the state in the settings.
settingSignalHandler();
}
this._bindResetButton(settingsKey);
}
// Connects any widget's property to a settings key. The widget must have the same ID as
// the settings key. It also binds the corresponding reset button.
_bind(settingsKey, property) {
const object = this._builder.get_object(settingsKey);
if (object) {
this._settings.bind(settingsKey, object, property, Gio.SettingsBindFlags.DEFAULT);
}
this._bindResetButton(settingsKey);
}
// Searches for a reset button for the given settings key and make it reset the settings
// key when clicked.
_bindResetButton(settingsKey) {
const resetButton = this._builder.get_object('reset-' + settingsKey);
if (resetButton) {
resetButton.connect('clicked', () => {
this._settings.reset(settingsKey);
});
}
}
}
src/prefs/TRexPage.js
+11 -14
View File
@@ -16,12 +16,11 @@
const ExtensionUtils = imports.misc.extensionUtils; const ExtensionUtils = imports.misc.extensionUtils;
const Me = imports.misc.extensionUtils.getCurrentExtension(); const Me = imports.misc.extensionUtils.getCurrentExtension();
const utils = Me.imports.src.common.utils; const utils = Me.imports.src.common.utils;
const PrefsPage = Me.imports.src.prefs.PrefsPage.PrefsPage;
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
var TRexPage = class TRexPage extends PrefsPage { var TRexPage = class TRexPage {
// ---------------------------------------------------------------------- static methods // ---------------------------------------------------------------------- static methods
@@ -37,21 +36,19 @@ var TRexPage = class TRexPage extends PrefsPage {
return 'T-Rex Attack'; return 'T-Rex Attack';
} }
// ------------------------------------------------------------ constructor / destructor static initPreferences(dialog) {
constructor(settings, builder) { dialog.getBuilder().add_from_resource('/ui/gtk4/trexPage.ui');
super(settings, builder);
this._builder.add_from_resource('/ui/gtk4/trexPage.ui');
// Bind all properties. // Bind all properties.
this._bindAdjustment('trex-animation-time'); dialog.bindAdjustment('trex-animation-time');
this._bindColorButton('claw-scratch-color'); dialog.bindColorButton('claw-scratch-color');
this._bindAdjustment('claw-scratch-scale'); dialog.bindAdjustment('claw-scratch-scale');
this._bindAdjustment('claw-scratch-count'); dialog.bindAdjustment('claw-scratch-count');
this._bindAdjustment('claw-scratch-warp'); dialog.bindAdjustment('claw-scratch-warp');
const stack = this._builder.get_object('main-stack'); const stack = dialog.getBuilder().get_object('main-stack');
stack.add_titled(this._builder.get_object('trex-prefs'), 'trex', 'T-Rex Attack'); stack.add_titled(
dialog.getBuilder().get_object('trex-prefs'), 'trex', 'T-Rex Attack');
} }
} }
src/prefs/TVEffectPage.js
+8 -11
View File
@@ -16,12 +16,11 @@
const ExtensionUtils = imports.misc.extensionUtils; const ExtensionUtils = imports.misc.extensionUtils;
const Me = imports.misc.extensionUtils.getCurrentExtension(); const Me = imports.misc.extensionUtils.getCurrentExtension();
const utils = Me.imports.src.common.utils; const utils = Me.imports.src.common.utils;
const PrefsPage = Me.imports.src.prefs.PrefsPage.PrefsPage;
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////////////
var TVEffectPage = class TVEffectPage extends PrefsPage { var TVEffectPage = class TVEffectPage {
// ---------------------------------------------------------------------- static methods // ---------------------------------------------------------------------- static methods
@@ -37,18 +36,16 @@ var TVEffectPage = class TVEffectPage extends PrefsPage {
return 'TV Effect'; return 'TV Effect';
} }
// ------------------------------------------------------------ constructor / destructor static initPreferences(dialog) {
constructor(settings, builder) { dialog.getBuilder().add_from_resource(
super(settings, builder); `/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/tvPage.ui`);
this._builder.add_from_resource(`/ui/${utils.isGTK4() ? 'gtk4' : 'gtk3'}/tvPage.ui`);
// Bind all properties. // Bind all properties.
this._bindAdjustment('tv-animation-time'); dialog.bindAdjustment('tv-animation-time');
this._bindColorButton('tv-effect-color'); dialog.bindColorButton('tv-effect-color');
const stack = this._builder.get_object('main-stack'); const stack = dialog.getBuilder().get_object('main-stack');
stack.add_titled(this._builder.get_object('tv-prefs'), 'tv', 'TV Effect'); stack.add_titled(dialog.getBuilder().get_object('tv-prefs'), 'tv', 'TV Effect');
} }
} }