|  |  |  | Libbeagle Reference Manual |  | 
|---|---|---|---|---|
                    BeagleProperty;
enum                BeaglePropertyType;
BeagleProperty*     beagle_property_new                 (BeaglePropertyType type,
                                                         const char *key,
                                                         const char *value);
void                beagle_property_free                (BeagleProperty *prop);
BeaglePropertyType  beagle_property_get_type            (BeagleProperty *prop);
void                beagle_property_set_type            (BeagleProperty *prop,
                                                         BeaglePropertyType type);
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);
gboolean            beagle_property_get_is_mutable      (BeagleProperty *prop);
void                beagle_property_set_is_mutable      (BeagleProperty *prop,
                                                         gboolean is_mutable);
gboolean            beagle_property_get_is_stored       (BeagleProperty *prop);
void                beagle_property_set_is_stored       (BeagleProperty *prop,
                                                         gboolean is_stored);
gboolean            beagle_property_get_is_persistent   (BeagleProperty *prop);
void                beagle_property_set_is_persistent   (BeagleProperty *prop,
                                                         gboolean is_persistent);
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;
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. | 
void beagle_property_free (BeagleProperty *prop);
Frees the memory allocated for the BeagleProperty.
| prop: | a BeagleProperty | 
BeaglePropertyType beagle_property_get_type (BeagleProperty *prop);
Fetches the type of the BeagleProperty.
| prop: | a BeagleProperty | 
| Returns : | the BeaglePropertyType of the BeagleProperty. | 
void beagle_property_set_type (BeagleProperty *prop, BeaglePropertyType type);
Sets the type of the given BeagleProperty to type.
| prop: | a BeagleProperty | 
| type: | a BeaglePropertyType | 
const char* beagle_property_get_key (BeagleProperty *prop);
Fetches the key of the BeagleProperty.
| prop: | a BeagleProperty | 
| Returns : | the key name of the BeagleProperty. | 
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 | 
const char* beagle_property_get_value (BeagleProperty *prop);
Fetches the value of the given BeagleProperty.
| prop: | a BeagleProperty | 
| Returns : | the value of the BeagleProperty. | 
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 | 
gboolean beagle_property_get_is_searched (BeagleProperty *prop);
Fetches whether the given BeagleProperty is searched.
| prop: | a BeagleProperty | 
| Returns : | whether the BeagleProperty 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 | 
gboolean beagle_property_get_is_mutable (BeagleProperty *prop);
Fetches whether the given BeagleProperty is mutable.
| prop: | a BeagleProperty | 
| Returns : | whether the BeagleProperty is mutable. | 
void beagle_property_set_is_mutable (BeagleProperty *prop, gboolean is_mutable);
Sets whether the given BeagleProperty is mutable.
| prop: | a BeagleProperty | 
| is_mutable: | a boolean | 
gboolean beagle_property_get_is_stored (BeagleProperty *prop);
Fetches whether the given BeagleProperty is stored in the index, or just a hint to filters.
| prop: | a BeagleProperty | 
| Returns : | whether the BeagleProperty 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.
| prop: | a BeagleProperty | 
| is_stored: | a boolean | 
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.
| prop: | a BeagleProperty | 
| Returns : | whether the BeagleProperty is stored. | 
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.
| prop: | a BeagleProperty | 
| is_persistent: | a boolean |