BeagleProperty

typedef struct _BeagleProperty BeagleProperty;

enum BeaglePropertyType

typedef enum {
	BEAGLE_PROPERTY_TYPE_UNKNOWN = 0,
	BEAGLE_PROPERTY_TYPE_TEXT    = 1,
	BEAGLE_PROPERTY_TYPE_KEYWORD = 2,
	BEAGLE_PROPERTY_TYPE_DATE    = 3,
	BEAGLE_PROPERTY_TYPE_LAST    = 4
} BeaglePropertyType;

beagle_property_new ()

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

Creates a new BeagleProperty for the key and value.

beagle_property_free ()

void                beagle_property_free                (BeagleProperty *prop);

Frees the memory allocated for the BeagleProperty.

beagle_property_get_type ()

BeaglePropertyType  beagle_property_get_type            (BeagleProperty *prop);

Fetches the type of the BeagleProperty.

beagle_property_set_type ()

void                beagle_property_set_type            (BeagleProperty *prop,
                                                         BeaglePropertyType type);

Sets the type of the given BeagleProperty to type.

beagle_property_get_key ()

const char*         beagle_property_get_key             (BeagleProperty *prop);

Fetches the key 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.

beagle_property_get_value ()

const char*         beagle_property_get_value           (BeagleProperty *prop);

Fetches the value of the given BeagleProperty.

beagle_property_set_value ()

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

Sets the value of the given BeagleProperty to value.

beagle_property_get_is_searched ()

gboolean            beagle_property_get_is_searched     (BeagleProperty *prop);

Fetches whether the given 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.

beagle_property_get_is_mutable ()

gboolean            beagle_property_get_is_mutable      (BeagleProperty *prop);

Fetches whether the given BeagleProperty is mutable.

beagle_property_set_is_mutable ()

void                beagle_property_set_is_mutable      (BeagleProperty *prop,
                                                         gboolean is_mutable);

Sets whether the given BeagleProperty is mutable.

beagle_property_get_is_stored ()

gboolean            beagle_property_get_is_stored       (BeagleProperty *prop);

Fetches whether the given BeagleProperty is stored in the index, or just a hint to filters.

beagle_property_set_is_stored ()

void                beagle_property_set_is_stored       (BeagleProperty *prop,
                                                         gboolean is_stored);

Sets whether the given BeagleProperty is stored in the index, or just a hint to filters. By default, properties are stored.

beagle_property_get_is_persistent ()

gboolean            beagle_property_get_is_persistent   (BeagleProperty *prop);

Fetches whether the given BeagleProperty will persist when the document is re-added for indexing e.g. if a file is modified on disk.

beagle_property_set_is_persistent ()

void                beagle_property_set_is_persistent   (BeagleProperty *prop,
                                                         gboolean is_persistent);

Sets whether the given BeagleProperty will persist when the document is re-added for indexing. By default, properties are persistent.