Logo Search packages:      
Sourcecode: eog version File versions  Download package

eog-plugin.h

/* Eye Of Gnome - EOG Plugin 
 *
 * Copyright (C) 2007 The Free Software Foundation
 *
 * Author: Lucas Rocha <lucasr@gnome.org>
 *
 * Based on gedit code (gedit/gedit-module.c) by: 
 *    - Paolo Maggi <paolo@gnome.org>
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __EOG_PLUGIN_H__
#define __EOG_PLUGIN_H__

#include "eog-window.h"
#include "eog-debug.h"

#include <glib-object.h>

G_BEGIN_DECLS

typedef struct _EogPlugin EogPlugin;
typedef struct _EogPluginClass EogPluginClass;
typedef struct _EogPluginPrivate EogPluginPrivate;

#define EOG_TYPE_PLUGIN            (eog_plugin_get_type())
#define EOG_PLUGIN(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), EOG_TYPE_PLUGIN, EogPlugin))
#define EOG_PLUGIN_CONST(obj)      (G_TYPE_CHECK_INSTANCE_CAST((obj), EOG_TYPE_PLUGIN, EogPlugin const))
#define EOG_PLUGIN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),  EOG_TYPE_PLUGIN, EogPluginClass))
#define EOG_IS_PLUGIN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), EOG_TYPE_PLUGIN))
#define EOG_IS_PLUGIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EOG_TYPE_PLUGIN))
#define EOG_PLUGIN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),  EOG_TYPE_PLUGIN, EogPluginClass))

struct _EogPlugin {
      GObject parent;
};

struct _EogPluginClass  {
      GObjectClass parent_class;

      void        (*activate)       (EogPlugin *plugin,
                                     EogWindow *window);

      void        (*deactivate)           (EogPlugin *plugin,
                                     EogWindow *window);

      void        (*update_ui)            (EogPlugin *plugin,
                                     EogWindow *window);

      GtkWidget   *(*create_configure_dialog)
                                    (EogPlugin *plugin);

      /* Plugins should not override this, it's handled automatically 
       * by the EogPluginClass */
      gboolean    (*is_configurable)
                                    (EogPlugin *plugin);

      /* Padding for future expansion */
      void        (*_eog_reserved1) (void);
      void        (*_eog_reserved2) (void);
      void        (*_eog_reserved3) (void);
      void        (*_eog_reserved4) (void);
};

GType              eog_plugin_get_type          (void) G_GNUC_CONST;

void         eog_plugin_activate          (EogPlugin *plugin,
                                     EogWindow *window);

void         eog_plugin_deactivate          (EogPlugin *plugin,
                                     EogWindow *window);

void         eog_plugin_update_ui         (EogPlugin *plugin,
                                     EogWindow *window);

gboolean     eog_plugin_is_configurable   (EogPlugin *plugin);

GtkWidget   *eog_plugin_create_configure_dialog
                                    (EogPlugin *plugin);

/*
 * Utility macro used to register plugins
 *
 * use: EOG_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE)
 */
#define EOG_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, CODE)     \
                                                            \
static GType plugin_name##_type = 0;                                    \
                                                            \
GType                                                       \
plugin_name##_get_type (void)                                     \
{                                                           \
      return plugin_name##_type;                                  \
}                                                           \
                                                            \
static void     plugin_name##_init              (PluginName        *self);    \
static void     plugin_name##_class_init        (PluginName##Class *klass);   \
static gpointer plugin_name##_parent_class = NULL;                      \
static void     plugin_name##_class_intern_init (gpointer klass)        \
{                                                           \
      plugin_name##_parent_class = g_type_class_peek_parent (klass);          \
      plugin_name##_class_init ((PluginName##Class *) klass);                 \
}                                                           \
                                                            \
G_MODULE_EXPORT GType                                             \
register_eog_plugin (GTypeModule *module)                         \
{                                                           \
      static const GTypeInfo our_info =                           \
      {                                                     \
            sizeof (PluginName##Class),                           \
            NULL, /* base_init */                                 \
            NULL, /* base_finalize */                             \
            (GClassInitFunc) plugin_name##_class_intern_init,           \
            NULL,                                           \
            NULL, /* class_data */                                \
            sizeof (PluginName),                                  \
            0, /* n_preallocs */                                  \
            (GInstanceInitFunc) plugin_name##_init                      \
      };                                                    \
                                                            \
      eog_debug_message (DEBUG_PLUGINS, "Registering " #PluginName);    \
                                                            \
      /* Initialise the i18n stuff */                                   \
      bindtextdomain (GETTEXT_PACKAGE, EOG_LOCALEDIR);                  \
      bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");               \
                                                            \
      plugin_name##_type = g_type_module_register_type (module,         \
                                  EOG_TYPE_PLUGIN,                \
                                  #PluginName,              \
                                  &our_info,                      \
                                  0);                             \
                                                            \
      CODE                                                  \
                                                            \
      return plugin_name##_type;                                  \
}

/*
 * Utility macro used to register plugins
 *
 * use: EOG_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)
 */
#define EOG_PLUGIN_REGISTER_TYPE(PluginName, plugin_name)               \
      EOG_PLUGIN_REGISTER_TYPE_WITH_CODE(PluginName, plugin_name, ;)

/*
 * Utility macro used to register gobject types in plugins with additional code
 *
 * use: EOG_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)
 */
#define EOG_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)      \
                                                            \
static GType g_define_type_id = 0;                                \
                                                            \
GType                                                       \
object_name##_get_type (void)                                     \
{                                                           \
      return g_define_type_id;                                    \
}                                                           \
                                                            \
static void     object_name##_init              (ObjectName        *self);    \
static void     object_name##_class_init        (ObjectName##Class *klass);   \
static gpointer object_name##_parent_class = NULL;                      \
static void     object_name##_class_intern_init (gpointer klass)        \
{                                                           \
      object_name##_parent_class = g_type_class_peek_parent (klass);          \
      object_name##_class_init ((ObjectName##Class *) klass);                 \
}                                                           \
                                                            \
GType                                                       \
object_name##_register_type (GTypeModule *module)                       \
{                                                           \
      static const GTypeInfo our_info =                           \
      {                                                     \
            sizeof (ObjectName##Class),                           \
            NULL, /* base_init */                                 \
            NULL, /* base_finalize */                             \
            (GClassInitFunc) object_name##_class_intern_init,           \
            NULL,                                           \
            NULL, /* class_data */                                \
            sizeof (ObjectName),                                  \
            0, /* n_preallocs */                                  \
            (GInstanceInitFunc) object_name##_init                      \
      };                                                    \
                                                            \
      eog_debug_message (DEBUG_PLUGINS, "Registering " #ObjectName);    \
                                                            \
      g_define_type_id = g_type_module_register_type (module,                 \
                                            PARENT_TYPE,          \
                                              #ObjectName,        \
                                              &our_info,          \
                                              0);                 \
                                                            \
      CODE                                                  \
                                                            \
      return g_define_type_id;                                    \
}

/*
 * Utility macro used to register gobject types in plugins
 *
 * use: EOG_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)
 */
#define EOG_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)          \
      EOG_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, ;)

G_END_DECLS

#endif  /* __EOG_PLUGIN_H__ */

Generated by  Doxygen 1.6.0   Back to index