src/core/na-factory-object.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, 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_FACTORY_OBJECT_H__
  32 #define __CORE_NA_FACTORY_OBJECT_H__
  33
  34 /* @title: NAIFactoryObject
  35  * @short_description: The #NAIFactoryObject Internal Functions
  36  * @include: core/na-factory-object.h
  37  *
  38  * Declare the function only accessed from core library, i.e. not
  39  * published as API.
  40  */
  41
  42 #include <api/na-ifactory-provider.h>
  43
  44 G_BEGIN_DECLS
  45
  46 typedef gboolean ( *NAFactoryObjectIterBoxedFn )( const NAIFactoryObject *object, NADataBoxed *boxed, void *data );
  47
  48 #define NA_IFACTORY_OBJECT_PROP_DATA                    "na-ifactory-object-prop-data"
  49
  50 void         na_factory_object_define_properties( GObjectClass *class, const NADataGroup *groups );
  51 NADataDef   *na_factory_object_get_data_def     ( const NAIFactoryObject *object, const gchar *name );
  52 NADataGroup *na_factory_object_get_data_groups  ( const NAIFactoryObject *object );
  53 void         na_factory_object_iter_on_boxed    ( const NAIFactoryObject *object, NAFactoryObjectIterBoxedFn pfn, void *user_data );
  54
  55 gchar       *na_factory_object_get_default      ( NAIFactoryObject *object, const gchar *name );
  56 void         na_factory_object_set_defaults     ( NAIFactoryObject *object );
  57
  58 void         na_factory_object_move_boxed       ( NAIFactoryObject *target, const NAIFactoryObject *source, NADataBoxed *boxed );
  59
  60 void         na_factory_object_copy             ( NAIFactoryObject *target, const NAIFactoryObject *source );
  61 gboolean     na_factory_object_are_equal        ( const NAIFactoryObject *a, const NAIFactoryObject *b );
  62 gboolean     na_factory_object_is_valid         ( const NAIFactoryObject *object );
  63 void         na_factory_object_dump             ( const NAIFactoryObject *object );
  64 void         na_factory_object_finalize         ( NAIFactoryObject *object );
  65
  66 void         na_factory_object_read_item        ( NAIFactoryObject *object, const NAIFactoryProvider *reader, void *reader_data, GSList **messages );
  67 guint        na_factory_object_write_item       ( NAIFactoryObject *object, const NAIFactoryProvider *writer, void *writer_data, GSList **messages );
  68
  69 void        *na_factory_object_get_as_void      ( const NAIFactoryObject *object, const gchar *name );
  70 void         na_factory_object_get_as_value     ( const NAIFactoryObject *object, const gchar *name, GValue *value );
  71
  72 void         na_factory_object_set_from_value   ( NAIFactoryObject *object, const gchar *name, const GValue *value );
  73 void         na_factory_object_set_from_void    ( NAIFactoryObject *object, const gchar *name, const void *data );
  74
  75 G_END_DECLS
  76
  77 #endif /* __CORE_NA_FACTORY_OBJECT_H__ */