libmmanager/mm-attribute.h

   1 /* MManager - a Desktop wide manager for multimedia applications.
   2  *
   3  * Copyright (C) 2008 Cosimo Cecchi <cosimoc@gnome.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __MM_ATTRIBUTE_H__
  22 #define __MM_ATTRIBUTE_H__
  23
  24 #include <glib.h>
  25 #include <glib-object.h>
  26
  27 /**
  28  * SECTION:mm-attribute
  29  * @short_description: an attribute.
  30  *
  31  * Structure defining an attribute which the #MMCollection can be queried on.
  32  * This structure is used both to build #MMFilterParam and #MMHit objects.
  33  * The attributes should always be static and owned by the library, and you
  34  * should use a #MMAttributeManager (either a stock one or a custom
  35  * implementation of the interface) to get the #MMAttribute.
  36  */
  37
  38 /**
  39  * MMAttribute:
  40  *
  41  * An opaque structure identifying an attribute.
  42  */
  43
  44 typedef struct _MMAttribute      MMAttribute;
  45
  46 /* public methods */
  47
  48 MMAttribute * mm_attribute_new             (GType type,
  49                                             const char *id,
  50                                             const char *name,
  51                                             const char *description);
  52 void          mm_attribute_free            (MMAttribute *attr);
  53 const char *  mm_attribute_get_id          (MMAttribute *attr);
  54 const char *  mm_attribute_get_name        (MMAttribute *attr);
  55 const char *  mm_attribute_get_description (MMAttribute *attr);
  56 GType         mm_attribute_get_value_type  (MMAttribute *attr);
  57
  58 #endif /* __MM_ATTRIBUTE_H__ */