pidgin/pidgin

Replace PurpleIdleUiOps with the PurpleIdleUi Interface

2021-10-22, Gary Kramlich
5397330041d6
Replace PurpleIdleUiOps with the PurpleIdleUi Interface

This continues our path down replacing the UiOps with Interfaces so that
developers can write user interfaces in other languages using gobject
introspection.

Testing Done:
Ran pidgin3 and set it to auto idle after 1 minute of system idle time. This attempted to query xscreen saver, but something didn't work there, but that's been happening before this change. Not sure if it's my system or the code just needs fixing.

Ran finch3 set idle time to 1 minute and verified that it set me to away after that minute.

I also used the libpurple idle time for both pidgin3 and finch3 and verified they continued to work as well.

Reviewed at https://reviews.imfreedom.org/r/1091/
/*
* 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_UI_INFO_H
#define PURPLE_UI_INFO_H
/**
* SECTION:purpleuiinfo
* @section_id: libpurple-ui-info
* @short_description: User Interface Information
* @title: A simple class that contains information about a user interface.
*
* #PurpleUiInfo keeps track of basic information about the user interface.
*/
#include <glib.h>
#include <glib-object.h>
G_BEGIN_DECLS
/**
* PURPLE_TYPE_UI_INFO:
*
* The standard _get_type macro for #PurpleUiInfo.
*/
#define PURPLE_TYPE_UI_INFO (purple_ui_info_get_type())
G_DECLARE_FINAL_TYPE(PurpleUiInfo, purple_ui_info, PURPLE, UI_INFO, GObject)
/**
* purple_ui_info_new:
* @name: The name.
* @version: The version.
* @website: The website.
* @support_website: The support website.
* @client_type: The client type.
*
* Creates a new #PurpleUiInfo with the given values. If you only want to set
* a few of these, you should use g_object_new() directly.
*
* Returns: (transfer full): The newly created #PurpleUiInfo instance.
*
* Since: 3.0.0
*/
PurpleUiInfo *purple_ui_info_new(const gchar *name,
const gchar *version,
const gchar *website,
const gchar *support_website,
const gchar *client_type);
/**
* purple_ui_info_get_name:
* @info: The #PurpleUiInfo instance.
*
* Gets the name from @info.
*
* Returns: The name from @info.
*
* Since: 3.0.0
*/
const gchar *purple_ui_info_get_name(PurpleUiInfo *info);
/**
* purple_ui_info_get_version:
* @info: The #PurpleUiInfo instance.
*
* Gets the version from @info.
*
* Returns: The version from @info.
*
* Since: 3.0.0
*/
const gchar *purple_ui_info_get_version(PurpleUiInfo *info);
/**
* purple_ui_info_get_website:
* @info: The #PurpleUiInfo instance.
*
* Gets the website from @info.
*
* Returns: The website for @info.
*
* Since: 3.0.0
*/
const gchar *purple_ui_info_get_website(PurpleUiInfo *info);
/**
* purple_ui_info_get_support_website:
* @info: The #PurpleUiInfo instance.
*
* Gets the support website from @info.
*
* Returns: The support website from @info.
*
* Since: 3.0.0
*/
const gchar *purple_ui_info_get_support_website(PurpleUiInfo *info);
/**
* purple_ui_info_get_client_type:
* @info: The #PurpleUiInfo instance.
*
* Gets the client type from @info. For example: 'bot', 'console', 'mobile',
* 'pc', 'web', etc.
*
* Returns: The client type of @info.
*
* Since: 3.0.0
*/
const gchar *purple_ui_info_get_client_type(PurpleUiInfo *info);
G_END_DECLS
#endif /* PURPLE_UI_INFO_H */