pidgin/pidgin

Fix transparency plugin for display list/pref changes

14 months ago, Elliott Sales de Andrade
04c0398f1046
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/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* 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 <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_PROTOCOL_CHAT_H
#define PURPLE_PROTOCOL_CHAT_H
#include <glib.h>
#include <glib-object.h>
#include <libpurple/connection.h>
#include <libpurple/purplemessage.h>
#include <libpurple/purpleprotocol.h>
#define PURPLE_TYPE_PROTOCOL_CHAT (purple_protocol_chat_get_type())
/**
* PurpleProtocolChat:
*
* #PurpleProtocolChat describes the API that protocols need to implement for
* handling multiple user conversations.
*
* Since: 3.0.0
*/
G_DECLARE_INTERFACE(PurpleProtocolChat, purple_protocol_chat, PURPLE,
PROTOCOL_CHAT, PurpleProtocol)
typedef struct _PurpleProtocolChatEntry PurpleProtocolChatEntry;
/**
* PurpleProtocolChatEntry:
* @label: User-friendly name of the entry
* @identifier: Used by the protocol to identify the option
* @required: True if it's required
* @is_int: True if the entry expects an integer
* @min: Minimum value in case of integer
* @max: Maximum value in case of integer
* @secret: True if the entry is secret (password)
*
* Represents an entry containing information that must be supplied by the
* user when joining a chat.
*/
struct _PurpleProtocolChatEntry {
const char *label;
const char *identifier;
gboolean required;
gboolean is_int;
int min;
int max;
gboolean secret;
};
G_BEGIN_DECLS
/**
* PurpleProtocolChatInterface:
* @info: Returns a list of #PurpleProtocolChatEntry structs, which represent
* information required by the protocol to join a chat. libpurple will
* call join_chat along with the information filled by the user.
* @info_defaults: Returns a hashtable which maps #PurpleProtocolChatEntry
* struct identifiers to default options as strings based on
* @chat_name. The resulting hashtable should be created with
* #g_hash_table_new_full(#g_str_hash, #g_str_equal, %NULL,
* #g_free). Use @get_name if you instead need to extract a chat
* name from a hashtable.
* @join: Called when the user requests joining a chat. Should arrange for
* purple_serv_got_joined_chat() to be called.
* @reject: Called when the user refuses a chat invitation.
* @get_name: Returns a chat name based on the information in components. Use
* @info_defaults if you instead need to generate a hashtable from a
* chat name.
* @invite: Invite a user to join a chat.
* @leave: Called when the user requests leaving a chat.
* @send: Send a message to a chat.
* @get_user_real_name: Gets the real name of a participant in a chat. For
* example, on XMPP this turns a chat room nick
* <literal>foo</literal> into
* <literal>room\@server/foo</literal>.
* @set_topic: Called to set the topic for the given chat.
*
* The protocol chat interface.
*
* This interface provides callbacks needed by protocols that implement chats.
*/
struct _PurpleProtocolChatInterface {
/*< private >*/
GTypeInterface parent;
/*< public >*/
GList *(*info)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection);
GHashTable *(*info_defaults)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, const gchar *chat_name);
void (*join)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, GHashTable *components);
void (*reject)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, GHashTable *components);
gchar *(*get_name)(PurpleProtocolChat *protocol_chat, GHashTable *components);
void (*invite)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, const gchar *message, const gchar *who);
void (*leave)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id);
gint (*send)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, PurpleMessage *message);
gchar *(*get_user_real_name)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, const gchar *who);
void (*set_topic)(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, const gchar *topic);
/*< private >*/
gpointer reserved[8];
};
/**
* purple_protocol_chat_info:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
*
* Gets the list of #PurpleProtocolChatEntry's that are required to join a
* multi user chat.
*
* Returns: (transfer full) (element-type PurpleProtocolChatEntry): The list
* of #PurpleProtocolChatEntry's that are used to join a chat.
*
* Since: 3.0.0
*/
GList *purple_protocol_chat_info(PurpleProtocolChat *protocol_chat, PurpleConnection *connection);
/**
* purple_protocol_chat_info_defaults:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @chat_name: The name of the chat.
*
* Returns a #GHashTable of the default protocol dependent components that will
* be passed to purple_protocol_chat_join().
*
* Returns: (transfer full) (element-type utf8 utf8): The values that will be
* used to join the chat.
*
* Since: 3.0.0
*/
GHashTable *purple_protocol_chat_info_defaults(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, const gchar *chat_name);
/**
* purple_protocol_chat_join:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @components: (element-type utf8 utf8) (transfer none): The protocol
* dependent join components.
*
* Joins the chat described in @components.
*
* Since: 3.0.0
*/
void purple_protocol_chat_join(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, GHashTable *components);
/**
* purple_protocol_chat_reject:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @components: (element-type utf8 utf8) (transfer none): The protocol
* dependent join components.
*
* Used to reject a chat invite.
*
* Since: 3.0.0
*/
void purple_protocol_chat_reject(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, GHashTable *components);
/**
* purple_protocol_chat_get_name:
* @protocol_chat: The #PurpleProtocolChat instance.
* @components: (element-type utf8 utf8) (transfer none): The protocol
* dependent join components.
*
* Gets the name from @components.
*
* Returns: (transfer full): The chat name from @components.
*
* Since: 3.0.0
*/
gchar *purple_protocol_chat_get_name(PurpleProtocolChat *protocol_chat, GHashTable *components);
/**
* purple_protocol_chat_invite:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @id: The id of the chat.
* @message: The invite message.
* @who: The target of the invite.
*
* Sends an invite to @who with @message.
*
* Since: 3.0.0
*/
void purple_protocol_chat_invite(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, const gchar *message, const gchar *who);
/**
* purple_protocol_chat_leave:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @id: The id of the chat.
*
* Leaves the chat identified by @id.
*
* Since: 3.0.0
*/
void purple_protocol_chat_leave(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id);
/**
* purple_protocol_chat_send:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @id: The id of the chat.
* @message: The message to send.
*
* Sends @message to the chat identified by @id.
*
* Returns: 0 on success, non-zero on failure.
*
* Since: 3.0.0
*/
gint purple_protocol_chat_send(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, PurpleMessage *message);
/**
* purple_protocol_chat_get_user_real_name:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @id: The id of the chat.
* @who: The username.
*
* Gets the real name of @who.
*
* Returns: (transfer full): The realname of @who.
*
* Since: 3.0.0
*/
gchar *purple_protocol_chat_get_user_real_name(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, const gchar *who);
/**
* purple_protocol_chat_set_topic:
* @protocol_chat: The #PurpleProtocolChat instance.
* @connection: The #PurpleConnection instance.
* @id: The id of the chat.
* @topic: The new topic.
*
* Sets the topic for the chat with id @id to @topic.
*
* Since: 3.0.0
*/
void purple_protocol_chat_set_topic(PurpleProtocolChat *protocol_chat, PurpleConnection *connection, gint id, const gchar *topic);
G_END_DECLS
#endif /* PURPLE_PROTOCOL_CHAT_H */