libmmanager/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 /**
  42  * SECTION:mm-category
  43  * @short_description: a category of a library.
  44  *
  45  * A category of an application's library. This could be e.g. "Last Roll"
  46  * for a photo application, a playlist for a video or music application or
  47  * something like "Podcasts". Each category has a name and an icon.
  48  */
  49
  50 /**
  51  * MMCategory:
  52  *
  53  * A basic type for a category object.
  54  */
  55
  56 typedef struct _MMCategory        MMCategory;
  57 typedef struct _MMCategoryPrivate MMCategoryPrivate;
  58 typedef struct _MMCategoryClass   MMCategoryClass;
  59
  60 struct _MMCategory {
  61   GObject parent_object;
  62   MMCategoryPrivate *details;
  63 };
  64
  65 /**
  66  * MMCategoryClass:
  67  * @get_hits: Gets a #MMHitCollection for the specified filter.
  68  *
  69  * Class of a #MMCategory object.
  70  */
  71
  72 struct _MMCategoryClass {
  73   GObjectClass parent_class;
  74
  75   MMHitCollection * (* get_hits) (MMCategory  *category,
  76                                   MMFilter    *filter,
  77                                   GError     **error);
  78 };
  79
  80 GType             mm_category_get_type        (void);
  81
  82 void              mm_category_set_attributes  (MMCategory    *category,
  83                                                MMApplication *app,
  84                                                const char    *name,
  85                                                GIcon         *icon);
  86 GIcon*            mm_category_get_icon        (MMCategory    *category);
  87 const char*       mm_category_get_name        (MMCategory    *category);
  88 MMApplication *   mm_category_get_application (MMCategory    *category);
  89 MMHitCollection*  mm_category_get_hits        (MMCategory    *category,
  90                                                MMFilter      *filter,
  91                                                GError       **error);
  92
  93 #endif /* __MM_CATEGORY_H__ */