IBusPropList

## IBusPropList IBusPropList — An IBusProperty container. |

## Stability Level

Stable, unless otherwise indicated

## Synopsis

                        IBusPropList;
                        IBusPropListClass;
    IBusPropList *      ibus_prop_list_new                  ();
    void                ibus_prop_list_append               (IBusPropList *prop_list,
                                                             IBusProperty *prop);
    IBusProperty *      ibus_prop_list_get                  (IBusPropList *prop_list,
                                                             guint index);
    gboolean            ibus_prop_list_update_property      (IBusPropList *prop_list,
                                                             IBusProperty *prop);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----IBusObject
                   +----IBusSerializable
                         +----IBusPropList

## Description

`See_also`: IBusProperty, IBusEngine

## Details

### IBusPropList

    typedef struct {
        GArray *properties;
    } IBusPropList;

An array of IBusProperties.

GArray *`properties`; | GArray that holds IBusProperties.

### IBusPropListClass

    typedef struct {
        IBusSerializableClass parent;
    } IBusPropListClass;

### ibus_prop_list_new ()

    IBusPropList *      ibus_prop_list_new                  ();

New a IBusPropList.

Returns : | A newly allocated IBusPropList.

### ibus_prop_list_append ()

    void                ibus_prop_list_append               (IBusPropList *prop_list,
                                                             IBusProperty *prop);

Append an IBusProperty to an IBusPropList, and increase reference.

`prop_list` : | An IBusPropList.
`prop` : | IBusProperty to be append to `prop_list`.

### ibus_prop_list_get ()

    IBusProperty *      ibus_prop_list_get                  (IBusPropList *prop_list,
                                                             guint index);

Returns IBusProperty at given index. Borrowed reference.

`prop_list` : | An IBusPropList.
`index` : | Index of an IBusPropList.
Returns : | IBusProperty at given index, NULL if no such IBusProperty. [transfer none]

### ibus_prop_list_update_property ()

    gboolean            ibus_prop_list_update_property      (IBusPropList *prop_list,
                                                             IBusProperty *prop);

Update an IBusProperty in IBusPropList.

`prop_list` : | An IBusPropList.
`prop` : | IBusProperty to be update.
Returns : | TRUE if succeeded, FALSE otherwise.