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  * MMAttribute:
  29  *
  30  * Structure defining an attribute which the #MMCollection can be queried on.
  31  * This structure is used both to build #MMFilterParam and #MMHit objects.
  32  * The attributes should always be static and owned by the library, and you
  33  * should use a #MMAttributeManager (either a stock one or a custom
  34  * implementation of the interface) to get the #MMAttribute.
  35  */
  36
  37 typedef struct _MMAttribute      MMAttribute;
  38
  39 /* public methods */
  40
  41 MMAttribute * mm_attribute_new             (GType type,
  42                                             const char *id,
  43                                             const char *name,
  44                                             const char *description);
  45 void          mm_attribute_free            (MMAttribute *attr);
  46 const char *  mm_attribute_get_id          (MMAttribute *attr);
  47 const char *  mm_attribute_get_name        (MMAttribute *attr);
  48 const char *  mm_attribute_get_description (MMAttribute *attr);
  49 GType         mm_attribute_get_value_type  (MMAttribute *attr);
  50
  51 #endif /* __MM_ATTRIBUTE_H__ */