First round of GtkDoc-ize the library.
[mmediamanager.git] / src / mm-attribute-manager.h
blob2a74da469440b1235c46f91da45391a5a9f6a1e5
1 /* MManager - a Desktop wide manager for multimedia applications.
3 * Copyright (C) 2008 Cosimo Cecchi <cosimoc@gnome.org>
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.
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.
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.
21 #ifndef __MM_ATTRIBUTE_MANAGER_H__
22 #define __MM_ATTRIBUTE_MANAGER_H__
24 #include <glib.h>
25 #include <glib-object.h>
27 #include "mm-attribute.h"
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_ATTRIBUTE_MANAGER_IFACE(klass) (G_TYPE_CHECK_CLASS_CAST ((klass),\
33 MM_TYPE_ATTRIBUTE_MANAGER, MMAttributeManagerIface))
34 #define MM_IS_ATTRIBUTE_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
35 MM_TYPE_ATTRIBUTE_MANAGER))
36 #define MM_IS_ATTRIBUTE_MANAGER_IFACE(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj),\
37 MM_TYPE_ATTRIBUTE_MANAGER))
38 #define MM_ATTRIBUTE_MANAGER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE((obj),\
39 MM_TYPE_ATTRIBUTE_MANAGER, MMAttributeManagerIface))
41 typedef struct _MMAttributeManager MMAttributeManager;
42 typedef struct _MMAttributeManagerIface MMAttributeManagerIface;
44 struct _MMAttributeManagerIface {
45 GTypeInterface base_iface;
47 GList * (*get_supported_attributes) (MMAttributeManager *attr_manager);
48 MMAttribute * (*lookup_attribute) (MMAttributeManager *attr_manager,
49 const char *attr_id);
52 /* TODO: add a method to validate attributes */
54 /* public methods */
56 GType mm_attribute_manager_get_type (void);
57 GList * mm_attribute_manager_get_supported_attributes (MMAttributeManager *attr_manager);
58 MMAttribute * mm_attribute_manager_lookup_attribute (MMAttributeManager *attr_manager,
59 const char *attr_id);
61 #endif /* __MM_ATTRIBUTE_MANAGER_H__ */