BeagleProperty

BeagleProperty

Functions

Types and Values

Description

Functions

beagle_property_new ()

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

Creates a new BeagleProperty for the key and value.

Parameters

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.

Parameters

prop

a BeagleProperty

 

beagle_property_get_type ()

BeaglePropertyType
beagle_property_get_type (BeagleProperty *prop);

Fetches the type of the BeagleProperty.

Parameters

prop

a BeagleProperty

 

Returns

the BeaglePropertyType 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 .

Parameters

prop

a BeagleProperty

 

type

a BeaglePropertyType

 

beagle_property_get_key ()

const char *
beagle_property_get_key (BeagleProperty *prop);

Fetches the key of the BeagleProperty.

Parameters

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 .

Parameters

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.

Parameters

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 .

Parameters

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.

Parameters

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.

Parameters

prop

a BeagleProperty

 

is_searched

a boolean

 

beagle_property_get_is_mutable ()

gboolean
beagle_property_get_is_mutable (BeagleProperty *prop);

Fetches whether the given BeagleProperty is mutable.

Parameters

prop

a BeagleProperty

 

Returns

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

Parameters

prop

a BeagleProperty

 

is_mutable

a boolean

 

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.

Parameters

prop

a BeagleProperty

 

Returns

whether the BeagleProperty is stored.


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.

Parameters

prop

a BeagleProperty

 

is_stored

a boolean

 

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.

Parameters

prop

a BeagleProperty

 

Returns

whether the BeagleProperty is stored.


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.

Parameters

prop

a BeagleProperty

 

is_persistent

a boolean

 

Types and Values

BeagleProperty

typedef struct _BeagleProperty BeagleProperty;


enum BeaglePropertyType

Members

BEAGLE_PROPERTY_TYPE_UNKNOWN

   

BEAGLE_PROPERTY_TYPE_TEXT

   

BEAGLE_PROPERTY_TYPE_KEYWORD

   

BEAGLE_PROPERTY_TYPE_DATE

   

BEAGLE_PROPERTY_TYPE_LAST