## PkCategory

PkCategory — Category object

## Synopsis

                        PkCategoryPrivate;
                        PkCategory;
                        PkCategoryClass;
    PkCategory *        pk_category_new                     (void);
    const gchar *       pk_category_get_parent_id           (PkCategory *category);
    void                pk_category_set_parent_id           (PkCategory *category,
                                                             const gchar *parent_id);
    const gchar *       pk_category_get_id                  (PkCategory *category);
    void                pk_category_set_id                  (PkCategory *category,
                                                             const gchar *cat_id);
    const gchar *       pk_category_get_name                (PkCategory *category);
    void                pk_category_set_name                (PkCategory *category,
                                                             const gchar *name);
    const gchar *       pk_category_get_summary             (PkCategory *category);
    void                pk_category_set_summary             (PkCategory *category,
                                                             const gchar *summary);
    const gchar *       pk_category_get_icon                (PkCategory *category);
    void                pk_category_set_icon                (PkCategory *category,
                                                             const gchar *icon);

## Object Hierarchy

      GObject
       +----PkSource
             +----PkCategory

## Properties

      "cat-id"                   gchar*                : Read / Write
      "icon"                     gchar*                : Read / Write
      "name"                     gchar*                : Read / Write
      "parent-id"                gchar*                : Read / Write
      "summary"                  gchar*                : Read / Write

## Description

This GObject represents a category in the group system.

## Details

### PkCategoryPrivate

    typedef struct _PkCategoryPrivate PkCategoryPrivate;

Private PkCategory data

### PkCategory

    typedef struct _PkCategory PkCategory;

### PkCategoryClass

    typedef struct {
    	PkSourceClass parent_class;
    	/* padding for future expansion */
    	void (*_pk_reserved1) (void);
    	void (*_pk_reserved2) (void);
    	void (*_pk_reserved3) (void);
    	void (*_pk_reserved4) (void);
    	void (*_pk_reserved5) (void);
    } PkCategoryClass;

### pk_category_new ()

    PkCategory *        pk_category_new                     (void);

Returns : | a new PkCategory object.

Since 0.5.4

### pk_category_get_parent_id ()

    const gchar *       pk_category_get_parent_id           (PkCategory *category);

Gets the parent category id.

`category` : | The `PkCategory`
Returns : | the string value, or `NULL` for unset.

Since 0.6.2

### pk_category_set_parent_id ()

    void                pk_category_set_parent_id           (PkCategory *category,
                                                             const gchar *parent_id);

Sets the parent category id.

`category` : | The `PkCategory`
`parent_id` : | the new value

Since 0.6.2

### pk_category_get_id ()

    const gchar *       pk_category_get_id                  (PkCategory *category);

Gets the id specific to this category.

`category` : | The `PkCategory`
Returns : | the string value, or `NULL` for unset.

Since 0.6.2

### pk_category_set_id ()

    void                pk_category_set_id                  (PkCategory *category,
                                                             const gchar *cat_id);

Sets the id specific to this category.

`category` : | The `PkCategory`
`cat_id` : | the new value

Since 0.6.2

### pk_category_get_name ()

    const gchar *       pk_category_get_name                (PkCategory *category);

Gets the name.

`category` : | The `PkCategory`
Returns : | the string value, or `NULL` for unset.

Since 0.6.2

### pk_category_set_name ()

    void                pk_category_set_name                (PkCategory *category,
                                                             const gchar *name);

Sets the name.

`category` : | The `PkCategory`
`name` : | the new value

Since 0.6.2

### pk_category_get_summary ()

    const gchar *       pk_category_get_summary             (PkCategory *category);

Gets the summary.

`category` : | The `PkCategory`
Returns : | the string value, or `NULL` for unset.

Since 0.6.2

### pk_category_set_summary ()

    void                pk_category_set_summary             (PkCategory *category,
                                                             const gchar *summary);

Sets the summary.

`category` : | The `PkCategory`
`summary` : | the new value

Since 0.6.2

### pk_category_get_icon ()

    const gchar *       pk_category_get_icon                (PkCategory *category);

Gets the icon filename.

`category` : | The `PkCategory`
Returns : | the string value, or `NULL` for unset.

Since 0.6.2

### pk_category_set_icon ()

    void                pk_category_set_icon                (PkCategory *category,
                                                             const gchar *icon);

Sets the icon filename.

`category` : | The `PkCategory`
`icon` : | the new value

Since 0.6.2

## Property Details

### The `"cat-id"` property

      "cat-id"                   gchar*                : Read / Write

Default value: NULL

Since 0.5.4

### The `"icon"` property

      "icon"                     gchar*                : Read / Write

Default value: NULL

Since 0.5.4

### The `"name"` property

      "name"                     gchar*                : Read / Write

Default value: NULL

Since 0.5.4

### The `"parent-id"` property

      "parent-id"                gchar*                : Read / Write

Default value: NULL

Since 0.5.4

### The `"summary"` property

      "summary"                  gchar*                : Read / Write

Default value: NULL

Since 0.5.4