PkExtra

PkExtra — Client singleton access to extra metadata about a package

Synopsis




#define             PK_EXTRA_DEFAULT_DATABASE
                    PkExtraPrivate;
                    PkExtra;
enum                PkExtraAccess;
PkExtra*            pk_extra_new                        (void);
gboolean            pk_extra_set_locale                 (PkExtra *extra,
                                                         const gchar *locale);
const gchar*        pk_extra_get_locale                 (PkExtra *extra);
gboolean            pk_extra_set_database               (PkExtra *extra,
                                                         const gchar *filename);
gboolean            pk_extra_set_access                 (PkExtra *extra,
                                                         PkExtraAccess access);
const gchar*        pk_extra_get_summary                (PkExtra *extra,
                                                         const gchar *package);
const gchar*        pk_extra_get_icon_name              (PkExtra *extra,
                                                         const gchar *package);
const gchar*        pk_extra_get_exec                   (PkExtra *extra,
                                                         const gchar *package);
gboolean            pk_extra_set_data_locale            (PkExtra *extra,
                                                         const gchar *package,
                                                         const gchar *summary);
gboolean            pk_extra_set_data_package           (PkExtra *extra,
                                                         const gchar *package,
                                                         const gchar *icon_name,
                                                         const gchar *exec);

Object Hierarchy


  GObject
   +----PkExtra

Description

Extra metadata such as icon name and localised summary may be stored here

Details

PK_EXTRA_DEFAULT_DATABASE

#define PK_EXTRA_DEFAULT_DATABASE	"/var/lib/PackageKit/extra-data.db"

The default location for the database, for client convenience


PkExtraPrivate

typedef struct _PkExtraPrivate PkExtraPrivate;

Private PkExtra data


PkExtra

typedef struct _PkExtra PkExtra;


enum PkExtraAccess

typedef enum {
	PK_EXTRA_ACCESS_READ_ONLY,
	PK_EXTRA_ACCESS_WRITE_ONLY,
	PK_EXTRA_ACCESS_READ_WRITE
} PkExtraAccess;


pk_extra_new ()

PkExtra*            pk_extra_new                        (void);

Returns :


pk_extra_set_locale ()

gboolean            pk_extra_set_locale                 (PkExtra *extra,
                                                         const gchar *locale);

extra :

a valid PkExtra instance

locale :

a correct locale, or NULL if the session default should be used

Returns :

TRUE if set correctly

pk_extra_get_locale ()

const gchar*        pk_extra_get_locale                 (PkExtra *extra);

extra :

a valid PkExtra instance

Returns :

the current locale

pk_extra_set_database ()

gboolean            pk_extra_set_database               (PkExtra *extra,
                                                         const gchar *filename);

extra :

a valid PkExtra instance

filename :

a valid database, or NULL to use the default or previously set value

Returns :

TRUE if set correctly

pk_extra_set_access ()

gboolean            pk_extra_set_access                 (PkExtra *extra,
                                                         PkExtraAccess access);

extra :

a valid PkExtra instance

access :

Returns :

the current locale

pk_extra_get_summary ()

const gchar*        pk_extra_get_summary                (PkExtra *extra,
                                                         const gchar *package);

extra :

a valid PkExtra instance

package :

Returns :

if we managed to get data

pk_extra_get_icon_name ()

const gchar*        pk_extra_get_icon_name              (PkExtra *extra,
                                                         const gchar *package);

extra :

a valid PkExtra instance

package :

Returns :

if we managed to get data

pk_extra_get_exec ()

const gchar*        pk_extra_get_exec                   (PkExtra *extra,
                                                         const gchar *package);

extra :

a valid PkExtra instance

package :

Returns :

if we managed to get data

pk_extra_set_data_locale ()

gboolean            pk_extra_set_data_locale            (PkExtra *extra,
                                                         const gchar *package,
                                                         const gchar *summary);

extra :

a valid PkExtra instance

package :

summary :

Returns :

the current locale

pk_extra_set_data_package ()

gboolean            pk_extra_set_data_package           (PkExtra *extra,
                                                         const gchar *package,
                                                         const gchar *icon_name,
                                                         const gchar *exec);

extra :

a valid PkExtra instance

package :

icon_name :

exec :

Returns :

the current locale