libmmanager/mm-filter.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_FILTER_H__
  22 #define __MM_FILTER_H__
  23
  24 #include <glib.h>
  25
  26 #include "mm-filter-param.h"
  27
  28 #define MM_TYPE_FILTER            (mm_filter_get_type())
  29 #define MM_FILTER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  30                                    MM_TYPE_FILTER, MMFilter))
  31 #define MM_FILTER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),\
  32                                    MM_TYPE_FILTER, MMFilterClass))
  33 #define MM_IS_FILTER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  34                                    MM_TYPE_FILTER))
  35 #define MM_IS_FILTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj),\
  36                                    MM_TYPE_FILTER))
  37 #define MM_FILTER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),\
  38                                    MM_TYPE_FILTER, MMFilterClass))
  39
  40 /**
  41  * SECTION:mm-filter
  42  * @short_description: a filter.
  43  *
  44  * #MMFilter is an object representing a query. It is no more than a collection
  45  * of #MMFilterParam objects. You must pass a #MMFilter object to a #MMCategory
  46  * to get a #MMHitCollection.
  47  */
  48
  49 /**
  50  * MMFilter:
  51  *
  52  * A filter, i.e. an object representing a query.
  53  */
  54
  55 typedef struct _MMFilter        MMFilter;
  56 typedef struct _MMFilterPrivate MMFilterPrivate;
  57 typedef struct _MMFilterClass   MMFilterClass;
  58
  59 struct _MMFilter {
  60   GObject parent_object;
  61   MMFilterPrivate *details;
  62 };
  63
  64 struct _MMFilterClass {
  65   GObjectClass parent_class;
  66 };
  67
  68 /* public methods */
  69 GType      mm_filter_get_type             (void);
  70 void       mm_filter_add_filtering_param  (MMFilter        *filter,
  71                                            MMFilterParam   *fp);
  72 void       mm_filter_add_filtering_params (MMFilter        *filter,
  73                                            GList           *fps);
  74 void       mm_filter_clear                (MMFilter        *filter);
  75 GList *    mm_filter_get_filtering_params (MMFilter        *filter);
  76
  77 MMFilter * mm_filter_new                  (void);
  78
  79 #endif /* __MM_FILTER_H__ */