libbeagle/beagle/beagle-property.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; -*- */
   2
   3 /*
   4  * beagle-property.h
   5  *
   6  * Copyright (C) 2005 Novell, Inc.
   7  *
   8  */
   9
  10 /*
  11  * Permission is hereby granted, free of charge, to any person obtaining a
  12  * copy of this software and associated documentation files (the "Software"),
  13  * to deal in the Software without restriction, including without limitation
  14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  15  * and/or sell copies of the Software, and to permit persons to whom the
  16  * Software is furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  27  * DEALINGS IN THE SOFTWARE.
  28  */
  29
  30 #ifndef __BEAGLE_PROPERTY_H
  31 #define __BEAGLE_PROPERTY_H
  32
  33 #include <glib.h>
  34
  35 typedef struct _BeagleProperty BeagleProperty;
  36
  37 typedef enum {
  38         BEAGLE_PROPERTY_TYPE_UNKNOWN = 0,
  39         BEAGLE_PROPERTY_TYPE_TEXT    = 1,
  40         BEAGLE_PROPERTY_TYPE_KEYWORD = 2,
  41         BEAGLE_PROPERTY_TYPE_DATE    = 3,
  42         BEAGLE_PROPERTY_TYPE_LAST    = 4
  43 } BeaglePropertyType;
  44
  45
  46 BeagleProperty *beagle_property_new (BeaglePropertyType type, const char *key, const char *value);
  47 void beagle_property_free (BeagleProperty *prop);
  48
  49 BeaglePropertyType beagle_property_get_type (BeagleProperty *prop);
  50 void beagle_property_set_type (BeagleProperty *prop, BeaglePropertyType type);
  51
  52 G_CONST_RETURN char *beagle_property_get_key (BeagleProperty *prop);
  53 void beagle_property_set_key (BeagleProperty *prop, const char *key);
  54
  55 G_CONST_RETURN char *beagle_property_get_value (BeagleProperty *prop);
  56 void beagle_property_set_value (BeagleProperty *prop, const char *value);
  57
  58 gboolean beagle_property_get_is_searched (BeagleProperty *prop);
  59 void beagle_property_set_is_searched (BeagleProperty *prop, gboolean is_searched);
  60
  61 gboolean beagle_property_get_is_mutable (BeagleProperty *prop);
  62 void beagle_property_set_is_mutable (BeagleProperty *prop, gboolean is_keyword);
  63
  64 gboolean beagle_property_get_is_stored (BeagleProperty *prop);
  65 void beagle_property_set_is_stored (BeagleProperty *prop, gboolean is_stored);
  66
  67 #endif /* __BEAGLE_PROPERTY_H */
  68