RygelPluginInformation

RygelPluginInformation — Parse plugin sidecar file and provide path to the module.

Synopsis

#define             RYGEL_TYPE_PLUGIN_INFORMATION
const gchar *       rygel_plugin_information_get_module_path
                                                        (RygelPluginInformation *self);
const gchar *       rygel_plugin_information_get_name   (RygelPluginInformation *self);
RygelPluginInformation * rygel_plugin_information_new_from_file
                                                        (GFile *file,
                                                         GError **error);
struct              RygelPluginInformation;
struct              RygelPluginInformationClass;

Object Hierarchy

  GObject
   +----RygelPluginInformation

Properties

  "module-path"              gchar*                : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only

Description

Sidecar files are keyfiles, loosely compatible with the files used by libpeas.

A minimal file for the plugin librygel-sompelugin.so looks like this:

[Plugin]
Name = SomeNameForThePlugin
Module = someplugin

Name must not contain any whitespaces.

Details

RYGEL_TYPE_PLUGIN_INFORMATION

#define RYGEL_TYPE_PLUGIN_INFORMATION (rygel_plugin_information_get_type ())

The type for RygelPluginInformation.


rygel_plugin_information_get_module_path ()

const gchar *       rygel_plugin_information_get_module_path
                                                        (RygelPluginInformation *self);

Get and return the current value of the "module-path" property.

self :

the RygelPluginInformation instance to query

Returns :

the value of the "module-path" property

rygel_plugin_information_get_name ()

const gchar *       rygel_plugin_information_get_name   (RygelPluginInformation *self);

Get and return the current value of the "name" property.

self :

the RygelPluginInformation instance to query

Returns :

the value of the "name" property

rygel_plugin_information_new_from_file ()

RygelPluginInformation * rygel_plugin_information_new_from_file
                                                        (GFile *file,
                                                         GError **error);

Factory method to create a RygelPluginInformation from GFile.

file :

 . a GFile pointing to the sidecar file. [in]

error :

location to store the error occuring, or NULL to ignore

Returns :

A new instance of RygelPluginInformation

struct RygelPluginInformation

struct RygelPluginInformation;

Parse plugin sidecar file and provide path to the module.

Sidecar files are keyfiles, loosely compatible with the files used by libpeas.

A minimal file for the plugin librygel-sompelugin.so looks like this:

[Plugin]
Name = SomeNameForThePlugin
Module = someplugin

Name must not contain any whitespaces.


struct RygelPluginInformationClass

struct RygelPluginInformationClass {
	GObjectClass parent_class;
};

The class structure for RYGEL_TYPE_PLUGIN_INFORMATION. All the fields in this structure are private and should never be accessed directly.

GObjectClass parent_class;

the parent class structure

Property Details

The "module-path" property

  "module-path"              gchar*                : Read / Write / Construct Only

module-path.

Default value: NULL


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

name.

Default value: NULL