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 #include <api/na-timeout.h>
  46
  47 #include "nadp-desktop-file.h"
  48
  49 G_BEGIN_DECLS
  50
  51 #define NADP_DESKTOP_PROVIDER_TYPE                ( nadp_desktop_provider_get_type())
  52 #define NADP_DESKTOP_PROVIDER( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, NADP_DESKTOP_PROVIDER_TYPE, NadpDesktopProvider ))
  53 #define NADP_DESKTOP_PROVIDER_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, NADP_DESKTOP_PROVIDER_TYPE, NadpDesktopProviderClass ))
  54 #define NADP_IS_DESKTOP_PROVIDER( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, NADP_DESKTOP_PROVIDER_TYPE ))
  55 #define NADP_IS_DESKTOP_PROVIDER_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NADP_DESKTOP_PROVIDER_TYPE ))
  56 #define NADP_DESKTOP_PROVIDER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NADP_DESKTOP_PROVIDER_TYPE, NadpDesktopProviderClass ))
  57
  58 /* private instance data
  59  */
  60 typedef struct _NadpDesktopProviderPrivate {
  61         /*< private >*/
  62         gboolean  dispose_has_run;
  63         GList    *monitors;
  64         NATimeout timeout;
  65 }
  66         NadpDesktopProviderPrivate;
  67
  68 typedef struct {
  69         /*< private >*/
  70         GObject                     parent;
  71         NadpDesktopProviderPrivate *private;
  72 }
  73         NadpDesktopProvider;
  74
  75 typedef struct _NadpDesktopProviderClassPrivate   NadpDesktopProviderClassPrivate;
  76
  77 typedef struct {
  78         /*< private >*/
  79         GObjectClass                     parent;
  80         NadpDesktopProviderClassPrivate *private;
  81 }
  82         NadpDesktopProviderClass;
  83
  84 /* this is a ':'-separated list of XDG_DATA_DIRS/subdirs searched for
  85  * menus or actions .desktop files.
  86  */
  87 #define NADP_DESKTOP_PROVIDER_SUBDIRS   "file-manager/actions"
  88
  89 GType nadp_desktop_provider_get_type     ( void );
  90 void  nadp_desktop_provider_register_type( GTypeModule *module );
  91
  92 void  nadp_desktop_provider_add_monitor     ( NadpDesktopProvider *provider, const gchar *dir );
  93 void  nadp_desktop_provider_on_monitor_event( NadpDesktopProvider *provider );
  94 void  nadp_desktop_provider_release_monitors( NadpDesktopProvider *provider );
  95
  96 G_END_DECLS
  97
  98 #endif /* __NADP_DESKTOP_PROVIDER_H__ */