src/core/na-ipivot-consumer.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 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 __CORE_NA_IPIVOT_CONSUMER_H__
  32 #define __CORE_NA_IPIVOT_CONSUMER_H__
  33
  34 /**
  35  * SECTION: na_ipivot_consumer
  36  * @short_description: #NAIPivotConsumer interface definition.
  37  * @include: runtime/na-ipivot-consumer.h
  38  *
  39  * This interface should be implemented by all classes which embed a
  40  * #NAPivot object, in order to receive modification notification
  41  * messages.
  42  */
  43
  44 #include <glib-object.h>
  45
  46 G_BEGIN_DECLS
  47
  48 #define NA_IPIVOT_CONSUMER_TYPE                                                 ( na_ipivot_consumer_get_type())
  49 #define NA_IPIVOT_CONSUMER( object )                                    ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumer ))
  50 #define NA_IS_IPIVOT_CONSUMER( object )                                 ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IPIVOT_CONSUMER_TYPE ))
  51 #define NA_IPIVOT_CONSUMER_GET_INTERFACE( instance )    ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumerInterface ))
  52
  53 typedef struct NAIPivotConsumer                 NAIPivotConsumer;
  54
  55 typedef struct NAIPivotConsumerInterfacePrivate NAIPivotConsumerInterfacePrivate;
  56
  57 typedef struct {
  58         GTypeInterface                     parent;
  59         NAIPivotConsumerInterfacePrivate *private;
  60
  61         /**
  62          * on_autosave_changed:
  63          * @instance: the #NAIPivotConsumer instance which implements this
  64          * interface.
  65          * @enabled: whether auto-save feature is now enabled.
  66          * @period: new auto-save period in minutes.
  67          *
  68          * This function is triggered once when #NAPivot detects that the
  69          * auto-save preferences have been changed. Parameters are the new
  70          * parameters of the configuration.
  71          */
  72         void ( *on_autosave_changed )        ( NAIPivotConsumer *instance, gboolean enabled, guint period );
  73
  74         /**
  75          * on_create_root_menu_changed:
  76          * @instance: the #NAIPivotConsumer instance which implements this
  77          * interface.
  78          * @enabled: whether a root menu should be created.
  79          *
  80          * This function is triggered each time the setting of the display
  81          * of an 'About' item in the Nautilus context menu is changed.
  82          */
  83         void ( *on_create_root_menu_changed )( NAIPivotConsumer *instance, gboolean enabled );
  84
  85         /**
  86          * on_display_about_changed:
  87          * @instance: the #NAIPivotConsumer instance which implements this
  88          * interface.
  89          * @enabled: whether the 'About' may be displayed.
  90          *
  91          * This function is triggered each time the setting of the display
  92          * of an 'About' item in the Nautilus context menu is changed.
  93          */
  94         void ( *on_display_about_changed )   ( NAIPivotConsumer *instance, gboolean enabled );
  95
  96         /**
  97          * on_display_order_changed:
  98          * @instance: the #NAIPivotConsumer instance which implements this
  99          * interface.
 100          * @order_mode: new order mode.
 101          *
 102          * This function is triggered each time the display order preference
 103          * is changed.
 104          */
 105         void ( *on_display_order_changed )   ( NAIPivotConsumer *instance, gint order_mode );
 106
 107         /**
 108          * on_items_changed:
 109          * @instance: the #NAIPivotConsumer instance which implements this
 110          * interface.
 111          * user_data: user data set when emitting the message. Currently,
 112          * not used.
 113          *
 114          * This function is triggered once when #NAPivot detects the end of
 115          * a bunch of modifications. At this time, the embedded list of
 116          * #NAAction has been updated to be up to date.
 117          */
 118         void ( *on_items_changed )           ( NAIPivotConsumer *instance, gpointer user_data );
 119
 120         /**
 121          * on_mandatory_prefs_changed:
 122          * @instance: the #NAIPivotConsumer instance which implements this interface.
 123          *
 124          * This function is triggered each time a mandatory 'locked' preference is changed.
 125          */
 126         void ( *on_mandatory_prefs_changed ) ( NAIPivotConsumer *instance );
 127 }
 128         NAIPivotConsumerInterface;
 129
 130 GType na_ipivot_consumer_get_type( void );
 131
 132 void  na_ipivot_consumer_allow_notify( NAIPivotConsumer *instance, gboolean allow, guint delay );
 133
 134 void  na_ipivot_consumer_notify_of_autosave_changed        ( NAIPivotConsumer *instance, gboolean enabled, guint period );
 135 void  na_ipivot_consumer_notify_of_create_root_menu_changed( NAIPivotConsumer *instance, gboolean enabled );
 136 void  na_ipivot_consumer_notify_of_display_about_changed   ( NAIPivotConsumer *instance, gboolean enabled );
 137 void  na_ipivot_consumer_notify_of_display_order_changed   ( NAIPivotConsumer *instance, gint order_mode );
 138 void  na_ipivot_consumer_notify_of_items_changed           ( NAIPivotConsumer *instance );
 139 void  na_ipivot_consumer_notify_of_mandatory_prefs_changed ( NAIPivotConsumer *instance );
 140
 141 G_END_DECLS
 142
 143 #endif /* __CORE_NA_IPIVOT_CONSUMER_H__ */