src/mm-category.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_CATEGORY_H__
  22 #define __MM_CATEGORY_H__
  23
  24 #include <glib.h>
  25 #include "mm-hit-collection.h"
  26 #include "mm-filter.h"
  27 #include "mm-application.h"
  28
  29 #define MM_TYPE_CATEGORY            (mm_category_get_type())
  30 #define MM_CATEGORY(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj),\
  31                                      MM_TYPE_CATEGORY, MMCategory))
  32 #define MM_CATEGORY_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),\
  33                                      MM_TYPE_CATEGORY, MMCategoryClass))
  34 #define MM_IS_CATEGORY(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj),\
  35                                      MM_TYPE_CATEGORY))
  36 #define MM_IS_CATEGORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj),\
  37                                      MM_TYPE_CATEGORY))
  38 #define MM_CATEGORY_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),\
  39                                      MM_TYPE_CATEGORY, MMCategoryClass))
  40
  41 typedef struct _MMCategory        MMCategory;
  42 typedef struct _MMCategoryDetails MMCategoryDetails;
  43 typedef struct _MMCategoryClass   MMCategoryClass;
  44
  45 struct _MMCategory {
  46   GObject parent_object;
  47   MMCategoryDetails *details;
  48 };
  49
  50 struct _MMCategoryClass {
  51   GObjectClass parent_class;
  52
  53   MMHitCollection * (* get_hits) (MMCategory  *category,
  54                                   MMFilter    *filter,
  55                                   GError     **error);
  56 };
  57
  58 GType             mm_category_get_type        (void);
  59
  60 void              mm_category_set_attributes  (MMCategory    *category,
  61                                                MMApplication *app,
  62                                                const char    *name,
  63                                                GIcon         *icon);
  64 /* return the icon of the category */
  65 GIcon*            mm_category_get_icon        (MMCategory    *category);
  66 /* return the name of the category */
  67 const char*       mm_category_get_name        (MMCategory    *category);
  68 MMApplication *   mm_category_get_application (MMCategory    *category);
  69 /* return a collection of hits inside the category for the given filter */
  70 MMHitCollection*  mm_category_get_hits        (MMCategory    *category,
  71                                                MMFilter      *filter,
  72                                                GError       **error);
  73
  74 #endif /* __MM_CATEGORY_H__ */