finch/gntplugin.h

/*
 * finch
 *
 * Finch 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#if !defined(FINCH_GLOBAL_HEADER_INSIDE) && !defined(FINCH_COMPILATION)
# error "only <finch.h> may be included directly"
#endif

#ifndef FINCH_PLUGIN_H
#define FINCH_PLUGIN_H

/**
 * SECTION:gntplugin
 * @section_id: finch-gntplugin
 * @short_description: <filename>gntplugin.h</filename>
 * @title: Plugin API
 */

#include <gnt.h>

#include <purple.h>

#include <string.h>

#include "finch.h"

#define FINCH_TYPE_PLUGIN_INFO             (finch_plugin_info_get_type())
#define FINCH_PLUGIN_INFO(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfo))
#define FINCH_PLUGIN_INFO_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))
#define FINCH_IS_PLUGIN_INFO(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), FINCH_TYPE_PLUGIN_INFO))
#define FINCH_IS_PLUGIN_INFO_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), FINCH_TYPE_PLUGIN_INFO))
#define FINCH_PLUGIN_INFO_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), FINCH_TYPE_PLUGIN_INFO, FinchPluginInfoClass))

typedef struct _FinchPluginInfo FinchPluginInfo;
typedef struct _FinchPluginInfoClass FinchPluginInfoClass;

typedef GntWidget* (*FinchPluginPrefFrameCb) (void);

/**
 * FinchPluginInfo:
 *
 * Extends #PurplePluginInfo to hold UI information for finch.
 */
struct _FinchPluginInfo {
	PurplePluginInfo parent;
};

/**
 * FinchPluginInfoClass:
 *
 * The base class for all #FinchPluginInfo's.
 */
struct _FinchPluginInfoClass {
	PurplePluginInfoClass parent_class;

	/*< private >*/
	void (*_gnt_reserved1)(void);
	void (*_gnt_reserved2)(void);
	void (*_gnt_reserved3)(void);
	void (*_gnt_reserved4)(void);
};

/**********************************************************************
 * Plugin Info API
 **********************************************************************/

/**
 * finch_plugin_info_get_type:
 *
 * Returns: The #GType for the #FinchPluginInfo object.
 */
GType finch_plugin_info_get_type(void);

/**
 * finch_plugin_info_new:
 * @first_property:  The first property name
 * @...:  The value of the first property, followed optionally by more
 *             name/value pairs, followed by %NULL
 *
 * Creates a new #FinchPluginInfo instance to be returned from
 * #plugin_query of a finch plugin, using the provided name/value
 * pairs.
 *
 * See purple_plugin_info_new() for a list of available property names.
 * Additionally, you can provide the property
 * <literal>"gnt-pref-frame-cb"</literal>, which should be a callback that
 * returns a #GntWidget for the plugin's preferences
 * (see #FinchPluginPrefFrameCb).
 *
 * See purple_plugin_info_new().
 *
 * Returns: A new #FinchPluginInfo instance.
 */
FinchPluginInfo *finch_plugin_info_new(const char *first_property, ...)
                 G_GNUC_NULL_TERMINATED;

/**********************************************************************
 * GNT Plugins API
 **********************************************************************/

/**
 * finch_plugins_show_all:
 *
 * Show a list of plugins.
 */
void finch_plugins_show_all(void);

/**
 * finch_plugins_save_loaded:
 *
 * Save the list of loaded plugins.
 */
void finch_plugins_save_loaded(void);

#endif /* FINCH_PLUGIN_H */