libmmanager/mm-hit.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_HIT_H__
  22 #define __MM_HIT_H__
  23
  24 #include <glib.h>
  25
  26 #include "mm-attribute.h"
  27
  28 #define MM_TYPE_HIT            (mm_hit_get_type())
  29 #define MM_HIT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  30                                 MM_TYPE_HIT, MMHit))
  31 #define MM_HIT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),\
  32                                 MM_TYPE_HIT, MMHitClass))
  33 #define MM_IS_HIT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  34                                 MM_TYPE_HIT))
  35 #define MM_IS_HIT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj),\
  36                                 MM_TYPE_HIT))
  37 #define MM_HIT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),\
  38                                 MM_TYPE_HIT, MMHitClass))
  39
  40 /**
  41  * SECTION:mm-hit
  42  * @short_description: a hit (i.e. a result of a query).
  43  *
  44  * #MMHit is a single result of a query. It's worth to note that #MMHit objects
  45  * are created by the application, so they could have some blank attribute, if
  46  * the application doesn't support it. More generally, a #MMHit should have all
  47  * the basic attributes and all those supported by its media type set, but it's
  48  * up to the applications to fill them in.
  49  */
  50
  51 /**
  52  * MMHit:
  53  *
  54  * An object identifying a single result of a query.
  55  */
  56
  57 typedef struct _MMHit        MMHit;
  58 typedef struct _MMHitDetails MMHitDetails;
  59 typedef struct _MMHitClass   MMHitClass;
  60
  61 struct _MMHit {
  62   GObject parent_object;
  63   MMHitDetails *details;
  64 };
  65
  66 struct _MMHitClass {
  67   GObjectClass parent_class;
  68 };
  69
  70 /* public methods */
  71
  72 GType        mm_hit_get_type       (void);
  73
  74 GHashTable * mm_hit_get_values     (MMHit       *hit,
  75                                     const char  *ids);
  76 GHashTable * mm_hit_get_all_values (MMHit       *hit);
  77
  78 /* this should be private to module implementations */
  79 void         mm_hit_set_values     (MMHit       *hit,
  80                                     GList       *attributes,
  81                                     GList       *values);
  82 void         mm_hit_set_value      (MMHit       *hit,
  83                                     MMAttribute *attribute,
  84                                     GValue      *value);
  85 #endif /* __MM_HIT_H__ */