src/core/na-updater.h

   1 /*
   2  * Nautilus-Actions
   3  * A Nautilus extension which offers configurable context menu pivots.
   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 __CORE_NA_UPDATER_H__
  32 #define __CORE_NA_UPDATER_H__
  33
  34 /* @title: NAUpdater
  35  * @short_description: The #NAUpdater Class Definition
  36  * @include: core/na-updater.h
  37  *
  38  * #NAUpdater is a #NAPivot-derived class which allows its clients
  39  * to update actions and menus.
  40  */
  41
  42 #include "na-pivot.h"
  43
  44 G_BEGIN_DECLS
  45
  46 #define NA_UPDATER_TYPE                ( na_updater_get_type())
  47 #define NA_UPDATER( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_UPDATER_TYPE, NAUpdater ))
  48 #define NA_UPDATER_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, NA_UPDATER_TYPE, NAUpdaterClass ))
  49 #define NA_IS_UPDATER( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_UPDATER_TYPE ))
  50 #define NA_IS_UPDATER_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_UPDATER_TYPE ))
  51 #define NA_UPDATER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_UPDATER_TYPE, NAUpdaterClass ))
  52
  53 typedef struct _NAUpdaterPrivate       NAUpdaterPrivate;
  54
  55 typedef struct {
  56         /*< private >*/
  57         NAPivot           parent;
  58         NAUpdaterPrivate *private;
  59 }
  60         NAUpdater;
  61
  62 typedef struct _NAUpdaterClassPrivate  NAUpdaterClassPrivate;
  63
  64 typedef struct {
  65         /*< private >*/
  66         NAPivotClass           parent;
  67         NAUpdaterClassPrivate *private;
  68 }
  69         NAUpdaterClass;
  70
  71 GType      na_updater_get_type( void );
  72
  73 NAUpdater *na_updater_new( void );
  74
  75 /* writability status
  76  */
  77 gboolean   na_updater_are_preferences_locked( const NAUpdater *updater );
  78 gboolean   na_updater_is_item_writable      ( const NAUpdater *updater, const NAObjectItem *item, guint *reason );
  79 gboolean   na_updater_is_level_zero_writable( const NAUpdater *updater );
  80
  81 /* update the tree in memory
  82  */
  83 void       na_updater_append_item( NAUpdater *updater, NAObjectItem *item );
  84 void       na_updater_insert_item( NAUpdater *updater, NAObjectItem *item, const gchar *parent_id, gint pos );
  85 void       na_updater_remove_item( NAUpdater *updater, NAObject *item );
  86
  87 gboolean   na_updater_should_pasted_be_relabeled( const NAUpdater *updater, const NAObject *item );
  88
  89 /* read from / write to the physical storage subsystem
  90  */
  91 GList     *na_updater_load_items ( NAUpdater *updater );
  92 guint      na_updater_write_item ( const NAUpdater *updater, NAObjectItem *item, GSList **messages );
  93 guint      na_updater_delete_item( const NAUpdater *updater, const NAObjectItem *item, GSList **messages );
  94
  95 G_END_DECLS
  96
  97 #endif /* __CORE_NA_UPDATER_H__ */