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_THEME_H
#define PURPLE_THEME_H
/**
* SECTION:theme
* @section_id: libpurple-theme
* @short_description: <filename>theme.h</filename>
* @title: Theme Abstract Class
*
* The theme API represents the common abilities for all of our supported
* themes.
*/
#include <glib.h>
#include <glib-object.h>
/**
* PURPLE_TYPE_THEME:
*
* The standard _get_type macro for #PurpleTheme.
*/
#define PURPLE_TYPE_THEME purple_theme_get_type()
struct _PurpleThemeClass
{
GObjectClass parent_class;
/*< private >*/
void (*purple_reserved1)(void);
void (*purple_reserved2)(void);
void (*purple_reserved3)(void);
void (*purple_reserved4)(void);
};
/**************************************************************************/
/* Purple Theme API */
/**************************************************************************/
G_BEGIN_DECLS
/**
* purple_theme_get_type:
*
* The standard _get_type function for #GType's.
*
* Returns: The #GType for a theme.
*/
G_DECLARE_DERIVABLE_TYPE(PurpleTheme, purple_theme, PURPLE, THEME, GObject)
/**
* purple_theme_get_name:
* @theme: The purple theme.
*
* Returns the name of the PurpleTheme object.
*
* Returns: The string representing the name of the theme.
*/
const gchar *purple_theme_get_name(PurpleTheme *theme);
/**
* purple_theme_set_name:
* @theme: The purple theme.
* @name: The name of the PurpleTheme object.
*
* Sets the name of the PurpleTheme object.
*/
void purple_theme_set_name(PurpleTheme *theme, const gchar *name);
/**
* purple_theme_get_description:
* @theme: The purple theme.
*
* Returns the description of the PurpleTheme object.
*
* Returns: A short description of the theme.
*/
const gchar *purple_theme_get_description(PurpleTheme *theme);
/**
* purple_theme_set_description:
* @theme: The purple theme.
* @description: The description of the PurpleTheme object.
*
* Sets the description of the PurpleTheme object.
*/
void purple_theme_set_description(PurpleTheme *theme, const gchar *description);
/**
* purple_theme_get_author:
* @theme: The purple theme.
*
* Returns the author of the PurpleTheme object.
*
* Returns: The author of the theme.
*/
const gchar *purple_theme_get_author(PurpleTheme *theme);
/**
* purple_theme_set_author:
* @theme: The purple theme.
* @author: The author of the PurpleTheme object.
*
* Sets the author of the PurpleTheme object.
*/
void purple_theme_set_author(PurpleTheme *theme, const gchar *author);
/**
* purple_theme_get_type_string:
* @theme: The purple theme.
*
* Returns the type (string) of the PurpleTheme object.
*
* Returns: The string representing the type.
*/
const gchar *purple_theme_get_type_string(PurpleTheme *theme);
/**
* purple_theme_get_dir:
* @theme: The purple theme.
*
* Returns the directory of the PurpleTheme object.
*
* Returns: The string representing the theme directory.
*/
const gchar *purple_theme_get_dir(PurpleTheme *theme);
/**
* purple_theme_set_dir:
* @theme: The purple theme.
* @dir: The directory of the PurpleTheme object.
*
* Sets the directory of the PurpleTheme object.
*/
void purple_theme_set_dir(PurpleTheme *theme, const gchar *dir);
/**
* purple_theme_get_image:
* @theme: The purple theme.
*
* Returns the image preview of the PurpleTheme object.
*
* Returns: The image preview of the PurpleTheme object.
*/
const gchar *purple_theme_get_image(PurpleTheme *theme);
/**
* purple_theme_get_image_full:
* @theme: The purple theme.
*
* Returns the image preview and directory of the PurpleTheme object.
*
* Returns: The image preview of the PurpleTheme object.
*/
gchar *purple_theme_get_image_full(PurpleTheme *theme);
/**
* purple_theme_set_image:
* @theme: The purple theme.
* @img: The image preview of the PurpleTheme object.
*
* Sets the directory of the PurpleTheme object.
*/
void purple_theme_set_image(PurpleTheme *theme, const gchar *img);
G_END_DECLS
#endif /* PURPLE_THEME_H */