3 * A Nautilus extension which offers configurable context menu actions.
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)
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.
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.
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.
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)
31 #ifndef __CORE_NA_IPIVOT_CONSUMER_H__
32 #define __CORE_NA_IPIVOT_CONSUMER_H__
34 /* @title: NAIPivotConsumer
35 * @short_description: The #NAIPivotConsumer Interface Definition
36 * @include: runtime/na-ipivot-consumer.h
38 * This interface should be implemented by all classes which embed a
39 * #NAPivot object, in order to receive modification notification
43 #include <glib-object.h>
47 #define NA_IPIVOT_CONSUMER_TYPE ( na_ipivot_consumer_get_type())
48 #define NA_IPIVOT_CONSUMER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumer ))
49 #define NA_IS_IPIVOT_CONSUMER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IPIVOT_CONSUMER_TYPE ))
50 #define NA_IPIVOT_CONSUMER_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumerInterface ))
52 typedef struct _NAIPivotConsumer NAIPivotConsumer
;
53 typedef struct _NAIPivotConsumerInterfacePrivate NAIPivotConsumerInterfacePrivate
;
57 GTypeInterface parent
;
58 NAIPivotConsumerInterfacePrivate
*private;
62 * on_autosave_changed:
63 * @instance: the #NAIPivotConsumer instance which implements this
65 * @enabled: whether auto-save feature is now enabled.
66 * @period: new auto-save period in minutes.
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.
72 void ( *on_autosave_changed
) ( NAIPivotConsumer
*instance
, gboolean enabled
, guint period
);
75 * on_create_root_menu_changed:
76 * @instance: the #NAIPivotConsumer instance which implements this
78 * @enabled: whether a root menu should be created.
80 * This function is triggered each time the setting of the display
81 * of an 'About' item in the Nautilus context menu is changed.
83 void ( *on_create_root_menu_changed
) ( NAIPivotConsumer
*instance
, gboolean enabled
);
86 * on_display_about_changed:
87 * @instance: the #NAIPivotConsumer instance which implements this
89 * @enabled: whether the 'About' may be displayed.
91 * This function is triggered each time the setting of the display
92 * of an 'About' item in the Nautilus context menu is changed.
94 void ( *on_display_about_changed
) ( NAIPivotConsumer
*instance
, gboolean enabled
);
97 * on_display_order_changed:
98 * @instance: the #NAIPivotConsumer instance which implements this
100 * @order_mode: new order mode.
102 * This function is triggered each time the display order preference
105 void ( *on_display_order_changed
) ( NAIPivotConsumer
*instance
, gint order_mode
);
108 * on_io_provider_prefs_changed:
109 * @instance: the #NAIPivotConsumer instance which implements this interface.
111 * This function is triggered each time an i/o provider preference is changed.
113 void ( *on_io_provider_prefs_changed
)( NAIPivotConsumer
*instance
);
117 * @instance: the #NAIPivotConsumer instance which implements this
119 * user_data: user data set when emitting the message. Currently,
122 * This function is triggered once when #NAPivot detects the end of
123 * a bunch of modifications. At this time, the embedded list of
124 * #NAAction has been updated to be up to date.
126 void ( *on_items_changed
) ( NAIPivotConsumer
*instance
, gpointer user_data
);
129 * on_mandatory_prefs_changed:
130 * @instance: the #NAIPivotConsumer instance which implements this interface.
132 * This function is triggered each time a mandatory preference is changed.
134 void ( *on_mandatory_prefs_changed
) ( NAIPivotConsumer
*instance
);
136 NAIPivotConsumerInterface
;
138 GType
na_ipivot_consumer_get_type( void );
140 void na_ipivot_consumer_allow_notify( NAIPivotConsumer
*instance
, gboolean allow
, guint delay
);
142 void na_ipivot_consumer_notify_of_autosave_changed ( NAIPivotConsumer
*instance
, gboolean enabled
, guint period
);
143 void na_ipivot_consumer_notify_of_create_root_menu_changed ( NAIPivotConsumer
*instance
, gboolean enabled
);
144 void na_ipivot_consumer_notify_of_display_about_changed ( NAIPivotConsumer
*instance
, gboolean enabled
);
145 void na_ipivot_consumer_notify_of_display_order_changed ( NAIPivotConsumer
*instance
, gint order_mode
);
146 void na_ipivot_consumer_notify_of_io_provider_prefs_changed( NAIPivotConsumer
*instance
);
147 void na_ipivot_consumer_notify_of_items_changed ( NAIPivotConsumer
*instance
);
148 void na_ipivot_consumer_notify_of_mandatory_prefs_changed ( NAIPivotConsumer
*instance
);
152 #endif /* __CORE_NA_IPIVOT_CONSUMER_H__ */