pidgin/pidgin

Fix transparency plugin for display list/pref changes

13 months ago, Elliott Sales de Andrade
04c0398f1046
Parents fc241db9162d
Children 4784cd60a1f8
Fix transparency plugin for display list/pref changes

There is no longer a buddy list/conversation split, so remove the duplicate settings (half of which were not used any more), and rename them without the differentiating prefix. Also, now that there's only one thing, there's no need for a second "enabled" setting in the plugin that just duplicates the plugin's enabled setting itself, so I removed it.

Instead of adding and removing a slider when the setting changes, I instead opted to always add it, and bind its visibility to the setting instead.

We no longer need a `gtk-config-frame` now that Pidgin uses GPlugin's plugin settings, so remove that and correctly wire up the settings schema so that GPlugin automatically displays settings.

Finally, the scale UI and alpha setting had different ranges. If the setting was moved below the scale's minimum, it would clamp it but not resend that value back to the setting, so things would appear inconsistent. To rectify this, I changed the setting's range up to match the scale.

Testing Done:
* Enabled Transparency plugin, changed around the transparency level and confirmed the main window became transparent.
* Toggled the solid-on-focus setting and confirmed the window lost transparency when focused.
* Toggled the slider setting and confirmed it was added/removed from the window.
* When slider was enabled, changed the setting and confirmed the slider changed and vice versa.

Reviewed at https://reviews.imfreedom.org/r/2394/
2 files changed, 30 insertions(+), 221 deletions(-)
  • +12 -45
    pidgin/plugins/transparency/im.pidgin.Pidgin.plugin.Transparency.gschema.xml
  • +18 -176
    pidgin/plugins/transparency/transparency.c
    • --- a/pidgin/plugins/transparency/im.pidgin.Pidgin.plugin.Transparency.gschema.xml Wed Mar 29 23:22:41 2023 -0500
    +++ b/pidgin/plugins/transparency/im.pidgin.Pidgin.plugin.Transparency.gschema.xml Wed Mar 29 23:32:07 2023 -0500
    @@ -1,62 +1,29 @@
    <?xml version="1.0" encoding="utf-8"?>
    <schemalist>
    <schema path="/pidgin/plugins/transparency/" id="im.pidgin.Pidgin.plugin.Transparency">
    - <key name="im-enabled" type="b">
    - <default>false</default>
    - <summary>IM window transparency</summary>
    + <key name="alpha" type="i">
    + <default>255</default>
    + <range min="50" max="255"/>
    + <summary>Transparency level</summary>
    <description>
    - Whether to enable transparency of IM windows.
    + The opacity applied to a window.
    </description>
    </key>
    - <key name="im-alpha" type="i">
    - <default>255</default>
    - <range min="0" max="255"/>
    - <summary>IM transparency level</summary>
    + <key name="slider" type="b">
    + <default>false</default>
    + <summary>Show slider bar in windows</summary>
    <description>
    - The opacity applied to an IM window.
    - </description>
    - </key>
    -
    - <key name="im-slider" type="b">
    - <default>false</default>
    - <summary>Show slider bar in IM windows</summary>
    - <description>
    - Shows a slider bar in IM windows with which the transparency level may
    + Shows a slider bar in windows with which the transparency level may
    be modified.
    </description>
    </key>
    - <key name="im-solid-onfocus" type="b">
    + <key name="solid-on-focus" type="b">
    <default>false</default>
    - <summary>Remove IM window transparency on focus</summary>
    - <description>
    - Whether to make an IM window opaque whenever it has focus.
    - </description>
    - </key>
    -
    - <key name="bl-enabled" type="b">
    - <default>false</default>
    - <summary>Buddy List window transparency</summary>
    + <summary>Remove window transparency on focus</summary>
    <description>
    - Whether to enable transparency of the Buddy List window.
    - </description>
    - </key>
    -
    - <key name="bl-alpha" type="i">
    - <default>255</default>
    - <range min="0" max="255"/>
    - <summary>Buddy List transparency level</summary>
    - <description>
    - The opacity applied to the Buddy List window.
    - </description>
    - </key>
    -
    - <key name="bl-solid-onfocus" type="b">
    - <default>false</default>
    - <summary>Remove Buddy List window transparency on focus</summary>
    - <description>
    - Whether to make the Buddy List window opaque whenever it has focus.
    + Whether to make a window opaque whenever it has focus.
    </description>
    </key>
    </schema>
    --- a/pidgin/plugins/transparency/transparency.c Wed Mar 29 23:22:41 2023 -0500
    +++ b/pidgin/plugins/transparency/transparency.c Wed Mar 29 23:32:07 2023 -0500
    @@ -49,13 +49,9 @@
    * LOCALS
    */
    #define OPT_SCHEMA "im.pidgin.Pidgin.plugin.Transparency"
    -#define OPT_WINTRANS_IM_ENABLED "im-enabled"
    -#define OPT_WINTRANS_IM_ALPHA "im-alpha"
    -#define OPT_WINTRANS_IM_SLIDER "im-slider"
    -#define OPT_WINTRANS_IM_ONFOCUS "im-solid-onfocus"
    -#define OPT_WINTRANS_BL_ENABLED "bl-enabled"
    -#define OPT_WINTRANS_BL_ALPHA "bl-alpha"
    -#define OPT_WINTRANS_BL_ONFOCUS "bl-solid-onfocus"
    +#define OPT_WINTRANS_ALPHA "alpha"
    +#define OPT_WINTRANS_SLIDER "slider"
    +#define OPT_WINTRANS_ONFOCUS "solid-on-focus"
    /*
    * CODE
    @@ -88,17 +84,13 @@
    settings = g_settings_new_with_backend(OPT_SCHEMA,
    purple_core_get_settings_backend());
    - if(!g_settings_get_boolean(settings, OPT_WINTRANS_IM_ENABLED)) {
    - g_object_unref(settings);
    - return;
    - }
    - if(!g_settings_get_boolean(settings, OPT_WINTRANS_IM_ONFOCUS)) {
    + if(!g_settings_get_boolean(settings, OPT_WINTRANS_ONFOCUS)) {
    g_object_unref(settings);
    return;
    }
    window = gtk_event_controller_get_widget(GTK_EVENT_CONTROLLER(self));
    - set_wintrans(window, g_settings_get_int(settings, OPT_WINTRANS_IM_ALPHA),
    + set_wintrans(window, g_settings_get_int(settings, OPT_WINTRANS_ALPHA),
    !enter);
    g_object_unref(settings);
    @@ -136,11 +128,11 @@
    settings = g_settings_new_with_backend(OPT_SCHEMA,
    purple_core_get_settings_backend());
    - g_settings_set_int(settings, OPT_WINTRANS_IM_ALPHA, alpha);
    + g_settings_set_int(settings, OPT_WINTRANS_ALPHA, alpha);
    /* If we're in no-transparency on focus mode,
    * don't take effect immediately */
    - if(!g_settings_get_boolean(settings, OPT_WINTRANS_IM_ONFOCUS)) {
    + if(!g_settings_get_boolean(settings, OPT_WINTRANS_ONFOCUS)) {
    set_wintrans(GTK_WIDGET(data), alpha, TRUE);
    }
    @@ -211,6 +203,9 @@
    gtk_widget_set_margin_end(slider_frame, 6);
    gtk_box_prepend(GTK_BOX(vbox), slider_frame);
    + g_settings_bind(settings, OPT_WINTRANS_SLIDER, slider_frame, "visible",
    + G_SETTINGS_BIND_DEFAULT);
    +
    hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 6);
    gtk_frame_set_child(GTK_FRAME(slider_frame), hbox);
    @@ -221,18 +216,18 @@
    gtk_widget_set_hexpand(slider, TRUE);
    gtk_box_append(GTK_BOX(hbox), slider);
    - imalpha = g_settings_get_int(settings, OPT_WINTRANS_IM_ALPHA);
    + imalpha = g_settings_get_int(settings, OPT_WINTRANS_ALPHA);
    gtk_range_set_value(GTK_RANGE(slider), imalpha);
    /* On slider val change, update window's transparency level */
    g_signal_connect(G_OBJECT(slider), "value-changed",
    G_CALLBACK(change_alpha), win);
    /* We cannot use g_settings_bind because GtkScale has no value property. */
    - g_signal_connect_object(settings, "changed::" OPT_WINTRANS_IM_ALPHA,
    + g_signal_connect_object(settings, "changed::" OPT_WINTRANS_ALPHA,
    G_CALLBACK(update_slider), slider, 0);
    /* Set the initial transparency level */
    - set_wintrans(win, g_settings_get_int(settings, OPT_WINTRANS_IM_ALPHA),
    + set_wintrans(win, g_settings_get_int(settings, OPT_WINTRANS_ALPHA),
    TRUE);
    /* Set window data, to track that it has a slider */
    @@ -246,17 +241,10 @@
    static void remove_convs_wintrans(gboolean remove_signal) {
    GApplication *application = NULL;
    GList *wins;
    - GSettings *settings = NULL;
    - gboolean im_enabled = FALSE;
    application = g_application_get_default();
    wins = gtk_application_get_windows(GTK_APPLICATION(application));
    - settings = g_settings_new_with_backend(OPT_SCHEMA,
    - purple_core_get_settings_backend());
    - im_enabled = g_settings_get_boolean(settings, OPT_WINTRANS_IM_ENABLED);
    - g_object_unref(settings);
    -
    for(; wins; wins = wins->next) {
    GtkWidget *window = wins->data;
    @@ -264,9 +252,7 @@
    continue;
    }
    - if (im_enabled) {
    - set_wintrans(window, 0, FALSE);
    - }
    + set_wintrans(window, 0, FALSE);
    /* Remove the focus cbs */
    if (remove_signal) {
    @@ -284,49 +270,14 @@
    settings = g_settings_new_with_backend(OPT_SCHEMA,
    purple_core_get_settings_backend());
    - /* check prefs to see if we want trans */
    - if (g_settings_get_boolean(settings, OPT_WINTRANS_IM_ENABLED)) {
    - set_wintrans(window,
    - g_settings_get_int(settings, OPT_WINTRANS_IM_ALPHA),
    - TRUE);
    + set_wintrans(window, g_settings_get_int(settings, OPT_WINTRANS_ALPHA),
    + TRUE);
    - if (g_settings_get_boolean(settings, OPT_WINTRANS_IM_SLIDER)) {
    - add_slider(window);
    - }
    - }
    + add_slider(window);
    g_object_unref(settings);
    }
    -static void update_convs_wintrans(GtkWidget *toggle_btn, const char *pref) {
    - purple_prefs_set_bool(pref, gtk_toggle_button_get_active(
    - GTK_TOGGLE_BUTTON(toggle_btn)));
    -
    - if (purple_prefs_get_bool(OPT_WINTRANS_IM_ENABLED)) {
    - GApplication *application = NULL;
    - GList *wins;
    -
    - application = g_application_get_default();
    - wins = gtk_application_get_windows(GTK_APPLICATION(application));
    -
    - for(; wins; wins = wins->next) {
    - GtkWidget *win = wins->data;
    -
    - if(!PIDGIN_IS_DISPLAY_WINDOW(win)) {
    - continue;
    - }
    -
    - set_conv_window_trans(win);
    -
    - if (!purple_prefs_get_bool(OPT_WINTRANS_IM_SLIDER)) {
    - g_object_set_data(G_OBJECT(win), WINTRANS_SLIDER_KEY, NULL);
    - }
    - }
    - } else {
    - remove_convs_wintrans(FALSE);
    - }
    -}
    -
    static void
    new_conversation_cb(G_GNUC_UNUSED GtkApplication *application,
    GtkWindow *window, G_GNUC_UNUSED gpointer data)
    @@ -339,37 +290,6 @@
    add_focus_controller_to_conv_win(GTK_WIDGET(window));
    }
    -static void alpha_change(GtkWidget *w, G_GNUC_UNUSED gpointer data) {
    - GApplication *application = NULL;
    - GList *wins;
    - int imalpha = gtk_range_get_value(GTK_RANGE(w));
    -
    - application = g_application_get_default();
    - wins = gtk_application_get_windows(GTK_APPLICATION(application));
    -
    - for(; wins; wins = wins->next) {
    - GtkWidget *window = wins->data;
    -
    - if(!PIDGIN_IS_DISPLAY_WINDOW(window)) {
    - continue;
    - }
    -
    - set_wintrans(window, imalpha, TRUE);
    - }
    -}
    -
    -static void
    -alpha_pref_set_int(GtkEventControllerFocus *self, gpointer data) {
    - const char *pref = data;
    - GtkWidget *slider = NULL;
    - int alpha = 255;
    -
    - slider = gtk_event_controller_get_widget(GTK_EVENT_CONTROLLER(self));
    - alpha = gtk_range_get_value(GTK_RANGE(slider));
    -
    - purple_prefs_set_int(pref, alpha);
    -}
    -
    static void
    update_existing_convs(void) {
    GApplication *application = NULL;
    @@ -391,84 +311,6 @@
    }
    }
    -static GtkWidget *
    -get_config_frame(G_GNUC_UNUSED PurplePlugin *plugin) {
    - GtkWidget *ret;
    - GtkWidget *imtransbox;
    - GtkWidget *hbox;
    - GtkWidget *label, *slider;
    - GtkWidget *button;
    - GtkWidget *trans_box;
    - GtkEventController *focus = NULL;
    -
    - ret = gtk_box_new(GTK_ORIENTATION_VERTICAL, 18);
    - gtk_widget_set_margin_start(ret, 12);
    - gtk_widget_set_margin_end(ret, 12);
    - gtk_widget_set_margin_top(ret, 12);
    - gtk_widget_set_margin_bottom(ret, 12);
    -
    - /* IM Convo trans options */
    - imtransbox = pidgin_make_frame(ret, _("IM Conversation Windows"));
    - button = pidgin_prefs_checkbox(_("_IM window transparency"),
    - OPT_WINTRANS_IM_ENABLED, imtransbox);
    - g_signal_connect(G_OBJECT(button), "clicked",
    - G_CALLBACK(update_convs_wintrans),
    - (gpointer) OPT_WINTRANS_IM_ENABLED);
    -
    - trans_box = gtk_box_new(GTK_ORIENTATION_VERTICAL, 18);
    - g_object_bind_property(button, "active", trans_box, "sensitive",
    - G_BINDING_SYNC_CREATE);
    -
    - button = pidgin_prefs_checkbox(_("_Show slider bar in IM window"),
    - OPT_WINTRANS_IM_SLIDER, trans_box);
    - g_signal_connect(G_OBJECT(button), "clicked",
    - G_CALLBACK(update_convs_wintrans),
    - (gpointer) OPT_WINTRANS_IM_SLIDER);
    -
    - button = pidgin_prefs_checkbox(
    - _("Remove IM window transparency on focus"),
    - OPT_WINTRANS_IM_ONFOCUS, trans_box);
    -
    - gtk_box_append(GTK_BOX(imtransbox), trans_box);
    -
    - /* IM transparency slider */
    - hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 5);
    -
    - label = gtk_label_new(_("Opacity:"));
    - gtk_box_append(GTK_BOX(hbox), label);
    -
    - slider = gtk_scale_new_with_range(GTK_ORIENTATION_HORIZONTAL, 50, 255, 1);
    - gtk_range_set_value(GTK_RANGE(slider),
    - purple_prefs_get_int(OPT_WINTRANS_IM_ALPHA));
    -
    - g_signal_connect(G_OBJECT(slider), "value-changed",
    - G_CALLBACK(alpha_change), NULL);
    - focus = gtk_event_controller_focus_new();
    - g_signal_connect(focus, "leave", G_CALLBACK(alpha_pref_set_int),
    - (gpointer)OPT_WINTRANS_IM_ALPHA);
    - gtk_widget_add_controller(slider, focus);
    -
    - gtk_box_append(GTK_BOX(hbox), slider);
    -
    - gtk_box_append(GTK_BOX(trans_box), hbox);
    -
    - /* IM transparency slider */
    - hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 5);
    -
    - label = gtk_label_new(_("Opacity:"));
    - gtk_box_append(GTK_BOX(hbox), label);
    -
    - slider = gtk_scale_new_with_range(GTK_ORIENTATION_HORIZONTAL, 50, 255, 1);
    - gtk_range_set_value(GTK_RANGE(slider),
    - purple_prefs_get_int(OPT_WINTRANS_BL_ALPHA));
    -
    - gtk_box_append(GTK_BOX(hbox), slider);
    -
    - gtk_box_append(GTK_BOX(trans_box), hbox);
    -
    - return ret;
    -}
    -
    static GPluginPluginInfo *
    transparency_query(G_GNUC_UNUSED GError **error) {
    const gchar * const authors[] = {
    @@ -486,7 +328,7 @@
    "authors", authors,
    "website", PURPLE_WEBSITE,
    "abi-version", PURPLE_ABI_VERSION,
    - "gtk-config-frame-cb", get_config_frame,
    + "settings-schema", OPT_SCHEMA,
    NULL
    );
    }