HDPluginItem

HDPluginItem — Base interface for plugable items.

Synopsis


#include <libhildondesktop/libhildondesktop.h>

                    HDPluginItem;
const gchar*        hd_plugin_item_get_dl_filename      (HDPluginItem *item);
gchar*              hd_plugin_item_get_plugin_id        (HDPluginItem *item);
void                hd_plugin_item_load_desktop_file    (HDPluginItem *item,
                                                         GKeyFile *key_file);

Object Hierarchy

  GInterface
   +----HDPluginItem

Prerequisites

HDPluginItem requires GObject.

Known Implementations

HDPluginItem is implemented by HDHomePluginItem, HDStatusMenuItem and HDStatusPluginItem.

Properties

  "plugin-id"                gchar*                : Read / Write / Construct Only

Description

HDPluginItem is a base interface for plugable items. It defines functions properties which are basically only useful for the Hildon desktop itself and not for widget/plugin developers.

It defines a hd_plugin_item_get_dl_filename() function which returns the filename of the dynamic library for debugging purposes.

It defines the "plugin-id" property for the unique plugin ID which is used internally by the Hildon Desktop to identify widget/plugins. It is usually not used by widget/plugin developers.

And it defines a hd_plugin_item_load_desktop_file() function for internal use by the Hildon desktop.

Details

HDPluginItem

typedef struct _HDPluginItem HDPluginItem;


hd_plugin_item_get_dl_filename ()

const gchar*        hd_plugin_item_get_dl_filename      (HDPluginItem *item);

Returns the filename of the dynamic library file from which this item was loaded. Useful for debugging purposes.

item : a HDPluginItem.
Returns : filename of the dynamic library file. The result must not be freed.

hd_plugin_item_get_plugin_id ()

gchar*              hd_plugin_item_get_plugin_id        (HDPluginItem *item);

Returns the unique plugin ID of item.

It is used internally by the Hildon desktop to identify widgets/plugins. It is usually not used by widget/plugin developers.

item : a HDPluginItem.
Returns : the plugin ID. The result should be freed if no longer used.

hd_plugin_item_load_desktop_file ()

void                hd_plugin_item_load_desktop_file    (HDPluginItem *item,
                                                         GKeyFile *key_file);

Used internally by the Hildon desktop to load additional keys from the plugins .desktop file.

item : a HDPluginItem.
key_file : the plugins .desktop GKeyFile

Property Details

The "plugin-id" property

  "plugin-id"                gchar*                : Read / Write / Construct Only

The id to identify the plugin item (used internally by the Hildon desktop to identify widgets/plugins. It is usually not used by widget/plugin developers).

Default value: NULL