src/io-desktop/fma-desktop-monitor.h

   1 /*
   2  * FileManager-Actions
   3  * A file-manager extension which offers configurable context menu actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006-2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009-2015 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * FileManager-Actions 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  * FileManager-Actions 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 GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with FileManager-Actions; see the file COPYING. If not, see
  21  * <http://www.gnu.org/licenses/>.
  22  *
  23  * Authors:
  24  *   Frederic Ruaudel <grumz@grumz.net>
  25  *   Rodrigo Moya <rodrigo@gnome-db.org>
  26  *   Pierre Wieser <pwieser@trychlos.org>
  27  *   ... and many others (see AUTHORS)
  28  */
  29
  30 #ifndef __IO_DESKTOP_FMA_DESKTOP_MONITOR_H__
  31 #define __IO_DESKTOP_FMA_DESKTOP_MONITOR_H__
  32
  33 /**
  34  * SECTION: fma_desktop_monitor
  35  * @short_description: #FMADesktopMonitor class definition.
  36  * @include: fma-desktop-monitor.h
  37  *
  38  * This class manages monitoring on .desktop files and directories.
  39  * We also put a monitor on directories which do not exist, to be
  40  * triggered when a file is dropped there.
  41  *
  42  * During tests of GIO monitoring, we don't have found any case where a
  43  * file monitor would be triggered without the parent directory monitor
  44  * has been itself triggered. We, so only monitor directories (not files).
  45  * More, as several events may be triggered for one user modification,
  46  * we try to factorize all monitor events before advertizing FMAPivot.
  47  */
  48
  49 #include "fma-desktop-provider.h"
  50
  51 G_BEGIN_DECLS
  52
  53 #define FMA_TYPE_DESKTOP_MONITOR                ( fma_desktop_monitor_get_type())
  54 #define FMA_DESKTOP_MONITOR( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, FMA_TYPE_DESKTOP_MONITOR, FMADesktopMonitor ))
  55 #define FMA_DESKTOP_MONITOR_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, FMA_TYPE_DESKTOP_MONITOR, FMADesktopMonitorClass ))
  56 #define FMA_IS_DESKTOP_MONITOR( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, FMA_TYPE_DESKTOP_MONITOR ))
  57 #define FMA_IS_DESKTOP_MONITOR_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), FMA_TYPE_DESKTOP_MONITOR ))
  58 #define FMA_DESKTOP_MONITOR_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), FMA_TYPE_DESKTOP_MONITOR, FMADesktopMonitorClass ))
  59
  60 typedef struct _FMADesktopMonitorPrivate        FMADesktopMonitorPrivate;
  61
  62 typedef struct {
  63         /*< private >*/
  64         GObject                   parent;
  65         FMADesktopMonitorPrivate *private;
  66 }
  67         FMADesktopMonitor;
  68
  69 typedef struct _FMADesktopMonitorClassPrivate   FMADesktopMonitorClassPrivate;
  70
  71 typedef struct {
  72         /*< private >*/
  73         GObjectClass                   parent;
  74         FMADesktopMonitorClassPrivate *private;
  75 }
  76         FMADesktopMonitorClass;
  77
  78 GType              fma_desktop_monitor_get_type( void );
  79
  80 FMADesktopMonitor *fma_desktop_monitor_new     ( const FMADesktopProvider *provider, const gchar *path );
  81
  82 G_END_DECLS
  83
  84 #endif /* __IO_DESKTOP_FMA_DESKTOP_MONITOR_H__ */