Class: GOffice::Plugin

Inherits:

Object

• Object
• GOffice::Plugin

Defined in:

(unknown)

Class Method Summary

• .db_activate_plugin_list(plugins, ret_error) ⇒ nil

  Activates all plugins in the list.

• .db_deactivate_plugin_list(plugins, ret_error) ⇒ nil

  Deactivates all plugins in the list.

• .services_shutdown ⇒ nil

Instance Method Summary

• #activate(ret_error) ⇒ nil

  Activates plugin together with all its dependencies.

• #can_deactivate ⇒ Boolean

  Tells if the plugin can be deactivated using go_plugin_deactivate.

• #db_is_plugin_marked_for_deactivation ⇒ Boolean
• #db_mark_plugin_for_deactivation(mark) ⇒ nil
• #deactivate(ret_error) ⇒ nil

  Dectivates plugin.

• #dependencies_ids ⇒ GLib::SList<String>

  plugins that plugin depends on.

• #description ⇒ String

  Textual description of plugin or nil if description is not available.

• #dir_name ⇒ String

  The name of the directory in which plugin is located.

• #id ⇒ String

  The ID of plugin (unique string used for idenfification of plugin).

• #init(cc) ⇒ nil
• #is_active ⇒ Boolean

  TRUE if plugin is active and FALSE otherwise.

• #is_loaded ⇒ Boolean

  TRUE if plugin is loaded and FALSE otherwise.

• #load_service(service, ret_error) ⇒ nil

  Loads base part of the plugin if it is not loaded and then loads given plugin service (prepares necessary part of the plugin for direct use).

• #loader ⇒ GOffice::PluginLoader

  The loader.

• #name ⇒ String

  Textual name of plugin.

• #services ⇒ GLib::SList<GOffice::PluginService>

  The list must not be freed or changed.

• #shutdown(cc) ⇒ nil
• #textdomain ⇒ String

  Plugin's textdomain for use with textdomain(3) and d*gettext(3) functions.

• #type_module ⇒ GObject::TypeModule

  creating it if necessary.

• #unload_service(service, ret_error) ⇒ nil

  ...

• #use_ref ⇒ nil
• #use_unref ⇒ nil

Class Method Details

.db_activate_plugin_list(plugins, ret_error) ⇒ nil

Activates all plugins in the list. If some of the plugins cannot be activated, the function reports this via ret_error (errors don't affect plugins activated successfully).

Parameters:

• plugins (GLib::SList<GOffice::Plugin>) —

  The list of plugins

• ret_error (GOffice::ErrorInfo) —

  Pointer used to report errors

Returns:

• (nil)

.db_deactivate_plugin_list(plugins, ret_error) ⇒ nil

Deactivates all plugins in the list. If some of the plugins cannot be deactivated, the function reports this via ret_error (errors don't affect plugins deactivated successfully).

Parameters:

• plugins (GLib::SList<GOffice::Plugin>) —

  The list of plugins

• ret_error (GOffice::ErrorInfo) —

  Pointer used to report errors

Returns:

• (nil)

.services_shutdown ⇒ nil

Returns:

• (nil)

Instance Method Details

#activate(ret_error) ⇒ nil

Activates plugin together with all its dependencies. In case of error the plugin won't be activated and detailed error information will be returned using ret_error.

Parameters:

• ret_error (GOffice::ErrorInfo) —

  Pointer used to report errors

Returns:

• (nil)

#can_deactivate ⇒ Boolean

Tells if the plugin can be deactivated using go_plugin_deactivate.

Returns:

• (Boolean) —

  TRUE if plugin can be deactivated and FALSE otherwise.

#db_is_plugin_marked_for_deactivation ⇒ Boolean

Returns:

• (Boolean)

#db_mark_plugin_for_deactivation(mark) ⇒ nil

Parameters:

• mark (Boolean)

Returns:

• (nil)

#deactivate(ret_error) ⇒ nil

Dectivates plugin. Its dependencies will NOT be automatically deactivated. In case of error the plugin won't be deactivated and detailed error information will be returned using ret_error.

Parameters:

• ret_error (GOffice::ErrorInfo) —

  Pointer used to report errors

Returns:

• (nil)

#dependencies_ids ⇒ GLib::SList<String>

plugins that plugin depends on. All these plugins will be automatically activated before activating the plugin itself.

Returns:

• (GLib::SList<String>) —

  the list of identifiers of

#description ⇒ String

Returns textual description of plugin or nil if description is not available. Returned string stays valid during plugin's lifetime.

Returns:

• (String) —

  textual description of plugin or nil if description is not available. Returned string stays valid during plugin's lifetime.

#dir_name ⇒ String

The name of the directory in which plugin is located. Returned string is != NULL and stays valid during plugin's lifetime.

Returns:

• (String) —

  the name of the directory in which plugin is located. Returned string is != NULL and stays valid during plugin's lifetime.

#id ⇒ String

Returns the ID of plugin (unique string used for idenfification of plugin). Returned string is != NULL and stays valid during plugin's lifetime.

Returns:

• (String) —

  the ID of plugin (unique string used for idenfification of plugin). Returned string is != NULL and stays valid during plugin's lifetime.

#init(cc) ⇒ nil

Parameters:

• cc (GOffice::CmdContext)

Returns:

• (nil)

#is_active ⇒ Boolean

Returns TRUE if plugin is active and FALSE otherwise.

Returns:

• (Boolean) —

  TRUE if plugin is active and FALSE otherwise.

#is_loaded ⇒ Boolean

Returns TRUE if plugin is loaded and FALSE otherwise.

Returns:

• (Boolean) —

  TRUE if plugin is loaded and FALSE otherwise.

#load_service(service, ret_error) ⇒ nil

Loads base part of the plugin if it is not loaded and then loads given plugin service (prepares necessary part of the plugin for direct use). This function is intended for use by GOPluginService objects.

Parameters:

• service (GOffice::PluginService) —

  Plugin service

• ret_error (GOffice::ErrorInfo) —

  Pointer used to report errors

Returns:

• (nil)

#loader ⇒ GOffice::PluginLoader

Returns The loader.

Returns:

• (GOffice::PluginLoader) —

  The loader.

#name ⇒ String

Textual name of plugin. If the real name is not available for some reason, automatically generated string will be returned. Returned string is != NULL and stays valid during plugin's lifetime.

Returns:

• (String) —

  textual name of plugin. If the real name is not available for some reason, automatically generated string will be returned. Returned string is != NULL and stays valid during plugin's lifetime.

#services ⇒ GLib::SList<GOffice::PluginService>

The list must not be freed or changed.

Returns:

• (GLib::SList<GOffice::PluginService>) —

  A list of services.

#shutdown(cc) ⇒ nil

Parameters:

• cc (GOffice::CmdContext)

Returns:

• (nil)

#textdomain ⇒ String

Returns plugin's textdomain for use with textdomain(3) and d*gettext(3) functions.

Returns:

• (String) —

  plugin's textdomain for use with textdomain(3) and d*gettext(3) functions.

#type_module ⇒ GObject::TypeModule

creating it if necessary.

Returns:

• (GObject::TypeModule) —

  the GTypeModule associated with the plugin

#unload_service(service, ret_error) ⇒ nil

... This function is intended for use by GOPluginService objects.

Parameters:

• service (GOffice::PluginService) —

  Plugin service

• ret_error (GOffice::ErrorInfo) —

  Pointer used to report errors

Returns:

• (nil)

#use_ref ⇒ nil

Returns:

• (nil)

#use_unref ⇒ nil

Returns:

• (nil)