src/core/fma-updater.h

   1 /*
   2  * FileManager-Actions
   3  * A file-manager extension which offers configurable context menu pivots.
   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 __CORE_FMA_UPDATER_H__
  31 #define __CORE_FMA_UPDATER_H__
  32
  33 /* @title: FMAUpdater
  34  * @short_description: The #FMAUpdater Class Definition
  35  * @include: core/fma-updater.h
  36  *
  37  * #FMAUpdater is a #FMAPivot-derived class which allows its clients
  38  * to update actions and menus.
  39  */
  40
  41 #include "fma-pivot.h"
  42
  43 G_BEGIN_DECLS
  44
  45 #define FMA_TYPE_UPDATER                ( fma_updater_get_type())
  46 #define FMA_UPDATER( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, FMA_TYPE_UPDATER, FMAUpdater ))
  47 #define FMA_UPDATER_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, FMA_TYPE_UPDATER, FMAUpdaterClass ))
  48 #define FMA_IS_UPDATER( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, FMA_TYPE_UPDATER ))
  49 #define FMA_IS_UPDATER_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), FMA_TYPE_UPDATER ))
  50 #define FMA_UPDATER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), FMA_TYPE_UPDATER, FMAUpdaterClass ))
  51
  52 typedef struct _FMAUpdaterPrivate       FMAUpdaterPrivate;
  53
  54 typedef struct {
  55         /*< private >*/
  56         FMAPivot           parent;
  57         FMAUpdaterPrivate *private;
  58 }
  59         FMAUpdater;
  60
  61 typedef struct _FMAUpdaterClassPrivate  FMAUpdaterClassPrivate;
  62
  63 typedef struct {
  64         /*< private >*/
  65         FMAPivotClass           parent;
  66         FMAUpdaterClassPrivate *private;
  67 }
  68         FMAUpdaterClass;
  69
  70 GType       fma_updater_get_type( void );
  71
  72 FMAUpdater *fma_updater_new( void );
  73
  74 /* writability status
  75  */
  76 void        fma_updater_check_item_writability_status( const FMAUpdater *updater, const FMAObjectItem *item );
  77
  78 gboolean    fma_updater_are_preferences_locked       ( const FMAUpdater *updater );
  79 gboolean    fma_updater_is_level_zero_writable       ( const FMAUpdater *updater );
  80
  81 /* update the tree in memory
  82  */
  83 void        fma_updater_append_item( FMAUpdater *updater, FMAObjectItem *item );
  84 void        fma_updater_insert_item( FMAUpdater *updater, FMAObjectItem *item, const gchar *parent_id, gint pos );
  85 void        fma_updater_remove_item( FMAUpdater *updater, FMAObject *item );
  86
  87 gboolean    fma_updater_should_pasted_be_relabeled( const FMAUpdater *updater, const FMAObject *item );
  88
  89 /* read from / write to the physical storage subsystem
  90  */
  91 GList      *fma_updater_load_items ( FMAUpdater *updater );
  92 guint       fma_updater_write_item ( const FMAUpdater *updater, FMAObjectItem *item, GSList **messages );
  93 guint       fma_updater_delete_item( const FMAUpdater *updater, const FMAObjectItem *item, GSList **messages );
  94
  95 G_END_DECLS
  96
  97 #endif /* __CORE_FMA_UPDATER_H__ */