StoragedObjectInfo

StoragedObjectInfo — Detailed information about objects

Synopsis

                    StoragedObjectInfo;
StoragedObject *    storaged_object_info_get_object     (StoragedObjectInfo *info);
const gchar *       storaged_object_info_get_name       (StoragedObjectInfo *info);
const gchar *       storaged_object_info_get_description
                                                        (StoragedObjectInfo *info);
GIcon *             storaged_object_info_get_icon       (StoragedObjectInfo *info);
GIcon *             storaged_object_info_get_icon_symbolic
                                                        (StoragedObjectInfo *info);
const gchar *       storaged_object_info_get_media_description
                                                        (StoragedObjectInfo *info);
GIcon *             storaged_object_info_get_media_icon (StoragedObjectInfo *info);
GIcon *             storaged_object_info_get_media_icon_symbolic
                                                        (StoragedObjectInfo *info);
const gchar *       storaged_object_info_get_one_liner  (StoragedObjectInfo *info);
const gchar *       storaged_object_info_get_sort_key   (StoragedObjectInfo *info);

Object Hierarchy

  GObject
   +----StoragedObjectInfo

Description

Detailed information about the D-Bus interfaces (such as StoragedBlock and StoragedDrive) on a StoragedObject that is suitable to display in an user interface. Use storaged_client_get_object_info() to get StoragedObjectInfo objects. Note that StoragedObjectInfo is an immutable object; once it has been created it cannot be modified further.

The HintName and/or HintIconName propreties on associated StoragedBlock interfaces (if any) may influence what storaged_object_info_get_icon() and storaged_object_info_get_media_icon() returns.

The value return by storaged_object_info_get_one_liner() is designed to contain enough information such that it is all that needs to be shown about the object. As a result for e.g. block devices or drives it contains the special device device e.g. /dev/sda.

Details

StoragedObjectInfo

typedef struct _StoragedObjectInfo StoragedObjectInfo;

The StoragedObjectInfo structure contains only private data and should only be accessed using the provided API.

Since 2.1


storaged_object_info_get_object ()

StoragedObject *    storaged_object_info_get_object     (StoragedObjectInfo *info);

Gets the StoragedObject that info is for

info :

A StoragedObjectInfo.

Returns :

The object - do not free or unref, the reference belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_name ()

const gchar *       storaged_object_info_get_name       (StoragedObjectInfo *info);

Gets the name.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_description ()

const gchar *       storaged_object_info_get_description
                                                        (StoragedObjectInfo *info);

Gets the description.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_icon ()

GIcon *             storaged_object_info_get_icon       (StoragedObjectInfo *info);

Gets the icon.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_icon_symbolic ()

GIcon *             storaged_object_info_get_icon_symbolic
                                                        (StoragedObjectInfo *info);

Gets the symbolic icon.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_media_description ()

const gchar *       storaged_object_info_get_media_description
                                                        (StoragedObjectInfo *info);

Gets the media description.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_media_icon ()

GIcon *             storaged_object_info_get_media_icon (StoragedObjectInfo *info);

Gets the media icon.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_media_icon_symbolic ()

GIcon *             storaged_object_info_get_media_icon_symbolic
                                                        (StoragedObjectInfo *info);

Gets the symbolic media icon.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_one_liner ()

const gchar *       storaged_object_info_get_one_liner  (StoragedObjectInfo *info);

Gets a one-line description.

info :

A StoragedObjectInfo.

Returns :

The value or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1


storaged_object_info_get_sort_key ()

const gchar *       storaged_object_info_get_sort_key   (StoragedObjectInfo *info);

Gets the sort-key for info. This can be used with g_strcmp0() to sort objects.

info :

A StoragedObjectInfo.

Returns :

The sort key or NULL. Do not free or unref, the value belongs to info. [transfer none]

Since 2.1