pidgin/gtkplugin.h

/**
 * @file gtkplugin.h GTK+ Plugin API
 * @ingroup pidgin
 */

/* pidgin
 *
 * Pidgin 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
 */
#ifndef _PIDGINPLUGIN_H_
#define _PIDGINPLUGIN_H_

#include "pidgin.h"
#include "plugins.h"

#define PIDGIN_TYPE_PLUGIN_INFO             (pidgin_plugin_info_get_type())
#define PIDGIN_PLUGIN_INFO(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), PIDGIN_TYPE_PLUGIN_INFO, PidginPluginInfo))
#define PIDGIN_PLUGIN_INFO_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), PIDGIN_TYPE_PLUGIN_INFO, PidginPluginInfoClass))
#define PIDGIN_IS_PLUGIN_INFO(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), PIDGIN_TYPE_PLUGIN_INFO))
#define PIDGIN_IS_PLUGIN_INFO_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), PIDGIN_TYPE_PLUGIN_INFO))
#define PIDGIN_PLUGIN_INFO_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), PIDGIN_TYPE_PLUGIN_INFO, PidginPluginInfoClass))

/** @copydoc _PidginPluginInfo */
typedef struct _PidginPluginInfo PidginPluginInfo;
/** @copydoc _PidginPluginInfoClass */
typedef struct _PidginPluginInfoClass PidginPluginInfoClass;

typedef GtkWidget *(*PidginPluginConfigFrame)(PurplePlugin *);

/**
 * Extends #PurplePluginInfo to hold UI information for pidgin.
 */
struct _PidginPluginInfo {
	/*< private >*/
	PurplePluginInfo parent;
};

/**
 * PidginPluginInfoClass:
 *
 * The base class for all #PidginPluginInfo's.
 */
struct _PidginPluginInfoClass {
	/*< private >*/
	PurplePluginInfoClass parent_class;

	void (*_pidgin_reserved1)(void);
	void (*_pidgin_reserved2)(void);
	void (*_pidgin_reserved3)(void);
	void (*_pidgin_reserved4)(void);
};

G_BEGIN_DECLS

/**
 * Returns the GType for the PidginPluginInfo object.
 */
GType pidgin_plugin_info_get_type(void);

/**
 * Creates a new #PidginPluginInfo instance to be returned from
 * gplugin_plugin_query() of a pidgin 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 "pidgin-config-frame",
 * which should be a callback that returns a GtkWidget for the plugin's
 * configuration (see PidginPluginConfigFrame).
 *
 * @param first_property  The first property name
 * @param ...  The value of the first property, followed optionally by more
 *             name/value pairs, followed by @c NULL
 *
 * @return A new #PidginPluginInfo instance.
 *
 * @see purple_plugin_info_new()
 */
PidginPluginInfo *pidgin_plugin_info_new(const char *first_property, ...)
                  G_GNUC_NULL_TERMINATED;

/**
 * Returns the configuration frame widget for a GTK+ plugin, if one
 * exists.
 *
 * @param plugin The plugin.
 *
 * @return The frame, if the plugin is a GTK+ plugin and provides a
 *         configuration frame.
 */
GtkWidget *pidgin_plugin_get_config_frame(PurplePlugin *plugin);

/**
 * Saves all loaded plugins.
 */
void pidgin_plugins_save(void);

/**
 * Shows the Plugins dialog
 */
void pidgin_plugin_dialog_show(void);

G_END_DECLS

#endif /* _PIDGINPLUGIN_H_ */