src/io-desktop/nadp-desktop-provider.h

   1 /*
   2  * Nautilus-Actions
   3  * A Nautilus extension which offers configurable context menu actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * This Program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This Program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this Library; see the file COPYING.  If not,
  21  * write to the Free Software Foundation, Inc., 59 Temple Place,
  22  * Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  * Authors:
  25  *   Frederic Ruaudel <grumz@grumz.net>
  26  *   Rodrigo Moya <rodrigo@gnome-db.org>
  27  *   Pierre Wieser <pwieser@trychlos.org>
  28  *   ... and many others (see AUTHORS)
  29  */
  30
  31 #ifndef __NADP_DESKTOP_PROVIDER_H__
  32 #define __NADP_DESKTOP_PROVIDER_H__
  33
  34 /**
  35  * SECTION: nadp_desktop_provider
  36  * @short_description: #NadpDesktopProvider class definition.
  37  * @include: nadp-desktop-provider.h
  38  *
  39  * This class manages .desktop files I/O storage subsystem, or, in
  40  * other words, .desktop files as NAIIOProvider providers. As this, it
  41  * should only be used through the NAIIOProvider interface.
  42  */
  43
  44 #include <api/na-object-item.h>
  45
  46 #include "nadp-desktop-file.h"
  47
  48 G_BEGIN_DECLS
  49
  50 #define NADP_DESKTOP_PROVIDER_TYPE                                      ( nadp_desktop_provider_get_type())
  51 #define NADP_DESKTOP_PROVIDER( object )                         ( G_TYPE_CHECK_INSTANCE_CAST( object, NADP_DESKTOP_PROVIDER_TYPE, NadpDesktopProvider ))
  52 #define NADP_DESKTOP_PROVIDER_CLASS( klass )            ( G_TYPE_CHECK_CLASS_CAST( klass, NADP_DESKTOP_PROVIDER_TYPE, NadpDesktopProviderClass ))
  53 #define NADP_IS_DESKTOP_PROVIDER( object )                      ( G_TYPE_CHECK_INSTANCE_TYPE( object, NADP_DESKTOP_PROVIDER_TYPE ))
  54 #define NADP_IS_DESKTOP_PROVIDER_CLASS( klass )         ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NADP_DESKTOP_PROVIDER_TYPE ))
  55 #define NADP_DESKTOP_PROVIDER_GET_CLASS( object )       ( G_TYPE_INSTANCE_GET_CLASS(( object ), NADP_DESKTOP_PROVIDER_TYPE, NadpDesktopProviderClass ))
  56
  57 typedef struct NadpDesktopProviderPrivate      NadpDesktopProviderPrivate;
  58
  59 /* private instance data
  60  */
  61 struct NadpDesktopProviderPrivate {
  62         gboolean dispose_has_run;
  63         GList   *monitors;
  64         GTimeVal last_event;
  65         guint    event_source_id;
  66 };
  67
  68 typedef struct {
  69         GObject                     parent;
  70         NadpDesktopProviderPrivate *private;
  71 }
  72         NadpDesktopProvider;
  73
  74 typedef struct NadpDesktopProviderClassPrivate NadpDesktopProviderClassPrivate;
  75
  76 typedef struct {
  77         GObjectClass                     parent;
  78         NadpDesktopProviderClassPrivate *private;
  79 }
  80         NadpDesktopProviderClass;
  81
  82 /* this is a ':'-separated list of XDG_DATA_DIRS/subdirs searched for
  83  * menus or actions .desktop files.
  84  */
  85 #define NADP_DESKTOP_PROVIDER_SUBDIRS   "file-manager/actions"
  86
  87 GType nadp_desktop_provider_get_type     ( void );
  88 void  nadp_desktop_provider_register_type( GTypeModule *module );
  89
  90 void  nadp_desktop_provider_add_monitor     ( NadpDesktopProvider *provider, const gchar *dir );
  91 void  nadp_desktop_provider_on_monitor_event( NadpDesktopProvider *provider );
  92 void  nadp_desktop_provider_release_monitors( NadpDesktopProvider *provider );
  93
  94 G_END_DECLS
  95
  96 #endif /* __NADP_DESKTOP_PROVIDER_H__ */