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_MANAGER_H
#define PURPLE_THEME_MANAGER_H
/**
* SECTION:theme-manager
* @section_id: libpurple-theme-manager
* @short_description: <filename>theme-manager.h</filename>
* @title: Theme Manager API
*
* The theme manager manages of all the available themes and allows you to load
* them.
*/
#include <glib-object.h>
#include <glib.h>
#include "theme.h"
#include "theme-loader.h"
typedef void (*PurpleThemeFunc) (PurpleTheme *theme);
/**
* PURPLE_TYPE_THEME_MANAGER:
*
* The standard _get_type macro for #PurpleThemeManager.
*/
#define PURPLE_TYPE_THEME_MANAGER purple_theme_manager_get_type()
/**************************************************************************/
/* Purple Theme Manager API */
/**************************************************************************/
G_BEGIN_DECLS
/**
* purple_theme_manager_get_type:
*
* The standard _get_type function for #GType's.
*
* Returns: The #GType for theme manager.
*/
G_DECLARE_FINAL_TYPE(PurpleThemeManager, purple_theme_manager, PURPLE,
THEME_MANAGER, GObject)
/**
* purple_theme_manager_init:
*
* Initializes the theme manager.
*/
void purple_theme_manager_init(void);
/**
* purple_theme_manager_uninit:
*
* Uninitializes the manager then frees all the themes and loaders it is
* responsible for.
*/
void purple_theme_manager_uninit(void);
/**
* purple_theme_manager_refresh:
*
* Rebuilds all the themes in the theme manager.
* (Removes all current themes but keeps the added loaders.)
*/
void purple_theme_manager_refresh(void);
/**
* purple_theme_manager_find_theme:
* @name: The name of the PurpleTheme.
* @type: The type of the PurpleTheme.
*
* Finds the PurpleTheme object stored by the theme manager.
*
* Returns: (transfer none): The PurpleTheme, or NULL if it wasn't found.
*/
PurpleTheme *purple_theme_manager_find_theme(const gchar *name, const gchar *type);
/**
* purple_theme_manager_add_theme:
* @theme: The PurpleTheme to add to the manager.
*
* Adds a PurpleTheme to the theme manager. If the theme already exists
* then this function does nothing.
*/
void purple_theme_manager_add_theme(PurpleTheme *theme);
/**
* purple_theme_manager_remove_theme:
* @theme: The PurpleTheme to remove from the manager.
*
* Removes a PurpleTheme from the theme manager and frees the theme.
*/
void purple_theme_manager_remove_theme(PurpleTheme *theme);
/**
* purple_theme_manager_register_type:
* @loader: The PurpleThemeLoader to add.
*
* Adds a loader to the theme manager so it knows how to build themes.
*/
void purple_theme_manager_register_type(PurpleThemeLoader *loader);
/**
* purple_theme_manager_unregister_type:
* @loader: The PurpleThemeLoader to be removed.
*
* Removes the loader and all themes of the same type from the loader.
*/
void purple_theme_manager_unregister_type(PurpleThemeLoader *loader);
/**
* purple_theme_manager_for_each_theme:
* @func: (scope call): The PurpleThemeFunc to be applied to each theme.
*
* Calls the given function on each purple theme.
*/
void purple_theme_manager_for_each_theme(PurpleThemeFunc func);
/**
* purple_theme_manager_load_theme:
* @theme_dir: the directory of the theme to load
* @type: the type of theme to load
*
* Loads a theme of the given type without adding it to the manager
*
* Returns: (transfer full): The newly loaded theme.
*/
PurpleTheme *purple_theme_manager_load_theme(const gchar *theme_dir, const gchar *type);
G_END_DECLS
#endif /* PURPLE_THEME_MANAGER_H */