beagle-property

beagle-property

Synopsis




                    BeagleProperty;
BeagleProperty*     beagle_property_new                 (BeaglePropertyType type,
                                                         const char *key,
                                                         const char *value);
void                beagle_property_free                (BeagleProperty *prop);
const char*         beagle_property_get_key             (BeagleProperty *prop);
void                beagle_property_set_key             (BeagleProperty *prop,
                                                         const char *key);
const char*         beagle_property_get_value           (BeagleProperty *prop);
void                beagle_property_set_value           (BeagleProperty *prop,
                                                         const char *value);
gboolean            beagle_property_get_is_searched     (BeagleProperty *prop);
void                beagle_property_set_is_searched     (BeagleProperty *prop,
                                                         gboolean is_searched);

Description

Details

BeagleProperty

typedef struct _BeagleProperty BeagleProperty;


beagle_property_new ()

BeagleProperty*     beagle_property_new                 (BeaglePropertyType type,
                                                         const char *key,
                                                         const char *value);

Creates a new BeagleProperty for the key and value.

type :
key : a string
value : a string
Returns : a newly allocated BeagleProperty.

beagle_property_free ()

void                beagle_property_free                (BeagleProperty *prop);

Frees the memory allocated for the BeagleProperty.

prop : a BeagleProperty

beagle_property_get_key ()

const char*         beagle_property_get_key             (BeagleProperty *prop);

Fetches the key of the BeagleProperty.

prop : a BeagleProperty
Returns : the key name of the BeagleProperty.

beagle_property_set_key ()

void                beagle_property_set_key             (BeagleProperty *prop,
                                                         const char *key);

Sets the key of the given BeagleProperty to key.

prop : a BeagleProperty
key : a string

beagle_property_get_value ()

const char*         beagle_property_get_value           (BeagleProperty *prop);

Fetches the value of the given BeagleProperty.

prop : a BeagleProperty
Returns : the value of the BeagleProperty.

beagle_property_set_value ()

void                beagle_property_set_value           (BeagleProperty *prop,
                                                         const char *value);

Sets the value of the given BeagleProperty to value.

prop : a BeagleProperty
value : a string

beagle_property_get_is_searched ()

gboolean            beagle_property_get_is_searched     (BeagleProperty *prop);

Fetches whether the given BeagleProperty is searched.

prop : a BeagleProperty
Returns : whether the BeagleProperty is searched.

beagle_property_set_is_searched ()

void                beagle_property_set_is_searched     (BeagleProperty *prop,
                                                         gboolean is_searched);

Sets whether the given BeagleProperty is searched. By default, text properties are searched and keyword properties are not searched.

prop : a BeagleProperty
is_searched : a boolean