libmmanager/mm-attribute-manager.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_MANAGER_H__
  22 #define __MM_ATTRIBUTE_MANAGER_H__
  23
  24 #include <glib.h>
  25 #include <glib-object.h>
  26
  27 #include "mm-attribute.h"
  28
  29 #define MM_TYPE_ATTRIBUTE_MANAGER            (mm_attribute_manager_get_type())
  30 #define MM_ATTRIBUTE_MANAGER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  31                                               MM_TYPE_ATTRIBUTE_MANAGER, MMAttributeManager))
  32 #define MM_IS_ATTRIBUTE_MANAGER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  33                                               MM_TYPE_ATTRIBUTE_MANAGER))
  34 #define MM_ATTRIBUTE_MANAGER_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE((obj),\
  35                                               MM_TYPE_ATTRIBUTE_MANAGER, MMAttributeManagerIface))
  36
  37 /**
  38  * SECTION:mm-attribute-manager
  39  * @short_description: attribute manager.
  40  *
  41  * An object implementing the #MMAttributeManagerIface interface. It manages and
  42  * owns a number of attributes, offering the chance to look them up by their
  43  * unique id.
  44  */
  45
  46
  47 /**
  48  * MMAttributeManager:
  49  *
  50  * Abstract type for attribute managers.
  51  */
  52
  53 typedef struct _MMAttributeManager      MMAttributeManager;
  54 typedef struct _MMAttributeManagerIface MMAttributeManagerIface;
  55
  56 /**
  57  * MMAttributeManagerIface:
  58  * @base_iface: parent interface.
  59  * @get_supported_attributes: Gets a #GList of all the supported attributes.
  60  * @lookup_attribute: Gets the attribute with the specified id.
  61  *
  62  * Interface to manage #MMAttribute objects.
  63  */
  64
  65 struct _MMAttributeManagerIface {
  66   GTypeInterface base_iface;
  67
  68   GList *       (*get_supported_attributes) (MMAttributeManager *attr_manager);
  69   MMAttribute * (*lookup_attribute)         (MMAttributeManager *attr_manager,
  70                                              const char         *attr_id);
  71 };
  72
  73 /* TODO: add a method to validate attributes */
  74
  75 /* public methods */
  76
  77 GType         mm_attribute_manager_get_type                 (void);
  78 GList *       mm_attribute_manager_get_supported_attributes (MMAttributeManager *attr_manager);
  79 MMAttribute * mm_attribute_manager_lookup_attribute         (MMAttributeManager *attr_manager,
  80                                                              const char         *attr_id);
  81
  82 #endif /* __MM_ATTRIBUTE_MANAGER_H__ */