TotemPlugin

typedef struct _TotemPlugin TotemPlugin;

All the fields in the TotemPlugin structure are private and should never be accessed directly.

TotemPluginClass

typedef struct {
	GObjectClass parent_class;

	/* Virtual public methods */

	TotemPluginActivationFunc	activate;
	TotemPluginDeactivationFunc	deactivate;
	TotemPluginWidgetFunc		create_configure_dialog;
} TotemPluginClass;

The class structure for the TotemPlParser type.

enum TotemPluginError

typedef enum {
	TOTEM_PLUGIN_ERROR_ACTIVATION
} TotemPluginError;

Error codes returned by TotemPlugin operations.

TotemPluginActivationFunc ()

gboolean            (*TotemPluginActivationFunc)        (TotemPlugin *plugin,
                                                         TotemObject *totem,
                                                         GError **error);

Called when the user has requested plugin be activated, this function should be used to initialise any resources the plugin needs, and attach itself to the Totem UI.

If an error is encountered while setting up the plugin, error should be set, and the function should return FALSE. Totem will then not mark the plugin as activated, and will ensure it's not loaded again unless explicitly asked for by the user.

TotemPluginDeactivationFunc ()

void                (*TotemPluginDeactivationFunc)      (TotemPlugin *plugin,
                                                         TotemObject *totem);

Called when the user has requested plugin be deactivated, this function should destroy all resources created during the plugin's lifetime, especially those created in the activation function.

It should be possible to activate and deactivate the plugin multiple times sequentially in a single Totem session without memory or resource leaks, or errors.

TotemPluginWidgetFunc ()

GtkWidget *         (*TotemPluginWidgetFunc)            (TotemPlugin *plugin);

Called when the configuration dialogue for the plugin needs to be built, this function should return a complete window which will be shown by the Totem code. The widget needs to be capable of hiding itself when configuration is complete.

If your plugin is not configurable, do not define this function.

TOTEM_PLUGIN_DEFINE_TYPE()

#define             TOTEM_PLUGIN_DEFINE_TYPE(TypeName, type_name, TYPE_PARENT)

Registers a type to be used inside a Totem plugin, but not the plugin's itself; use TOTEM_PLUGIN_REGISTER() for that.

TOTEM_PLUGIN_REGISTER()

#define             TOTEM_PLUGIN_REGISTER(PluginName, plugin_name)

Registers a new Totem plugin type. A plugin is, at its core, just a class which is instantiated and activated on the user's request. This macro registers that class.

TOTEM_PLUGIN_REGISTER_EXTENDED()

#define             TOTEM_PLUGIN_REGISTER_EXTENDED(PluginName, plugin_name, _C_)

Registers a new Totem plugin type with custom code in the module type registration function. See TOTEM_PLUGIN_REGISTER() for more information about the registration process.

A variable named our_info is available with the module's GTypeInfo information. plugin_module_type is the plugin's GTypeModule. @plugin_name_type is the plugin's newly-registered GType (where plugin_name is the plugin name passed to the TOTEM_PLUGIN_REGISTER_EXTENDED() macro).

TOTEM_PLUGIN_REGISTER_TYPE()

#define             TOTEM_PLUGIN_REGISTER_TYPE(type_name)

Calls the type registration function for a type inside a plugin module previously defined with TOTEM_PLUGIN_DEFINE_TYPE().

totem_plugin_activate ()

gboolean            totem_plugin_activate               (TotemPlugin *plugin,
                                                         TotemObject *totem,
                                                         GError **error);

Activates the passed plugin by calling its activate method.

totem_plugin_deactivate ()

void                totem_plugin_deactivate             (TotemPlugin *plugin,
                                                         TotemObject *totem);

Deactivates plugin by calling its deactivate method.

totem_plugin_create_configure_dialog ()

GtkWidget *         totem_plugin_create_configure_dialog
                                                        (TotemPlugin *plugin);

Returns the plugin's configuration dialog, as created by the plugin's create_configure_dialog method.

totem_plugin_is_configurable ()

gboolean            totem_plugin_is_configurable        (TotemPlugin *plugin);

Returns TRUE if the plugin is configurable and has a configuration dialog. It calls the plugin's is_configurable method.

totem_plugin_load_interface ()

GtkBuilder *        totem_plugin_load_interface         (TotemPlugin *plugin,
                                                         const char *name,
                                                         gboolean fatal,
                                                         GtkWindow *parent,
                                                         gpointer user_data);

Loads an interface file (GtkBuilder UI file) for a plugin, given its filename and assuming it's installed in the plugin's data directory.

This should be used instead of attempting to load interfaces manually in plugins.

totem_plugin_find_file ()

char *              totem_plugin_find_file              (TotemPlugin *plugin,
                                                         const char *file);

Finds the specified file by looking in the plugin paths listed by totem_get_plugin_paths() and then in the system Totem data directory.

This should be used by plugins to find plugin-specific resource files.

The "name" property

  "name"                     gchar*                : Read / Write

The plugin's name. It should be a construction property, but due to the Python plugin hack, it can't be: do not change the name after construction. Should be the same as used for naming plugin- specific resources.

Default value: NULL