src/api/na-data-boxed.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 __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__
  32 #define __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__
  33
  34 /**
  35  * SECTION: data-boxed
  36  * @title: NADataBoxed
  37  * @short_description: The Data Factory Element Class Definition
  38  * @include: nautilus-actions/na-data-boxed.h
  39  *
  40  * The object which encapsulates an elementary data of #NAIFactoryObject.
  41  * A #NADataBoxed object has a type and a value.
  42  *
  43  * Starting with version 3.1.0, #NAFactoryDataType is deprecated in favour
  44  * of #NABoxed structure. New code should only use #NABoxed structure and
  45  * accessors.
  46  *
  47  * Deprecated: 3.1.0
  48  */
  49
  50 #include <glib-object.h>
  51
  52 #include "na-data-def.h"
  53
  54 G_BEGIN_DECLS
  55
  56 #define NA_DATA_BOXED_TYPE                  ( na_data_boxed_get_type())
  57 #define NA_DATA_BOXED( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_DATA_BOXED_TYPE, NADataBoxed ))
  58 #define NA_DATA_BOXED_CLASS( klass )        ( G_TYPE_CHECK_CLASS_CAST( klass, NA_DATA_BOXED_TYPE, NADataBoxedClass ))
  59 #define NA_IS_DATA_BOXED( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_DATA_BOXED_TYPE ))
  60 #define NA_IS_DATA_BOXED_CLASS( klass )     ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_DATA_BOXED_TYPE ))
  61 #define NA_DATA_BOXED_GET_CLASS( object )   ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_DATA_BOXED_TYPE, NADataBoxedClass ))
  62
  63 typedef struct NADataBoxedPrivate      NADataBoxedPrivate;
  64
  65 typedef struct {
  66         /*< private >*/
  67         GObject             parent;
  68         NADataBoxedPrivate *private;
  69 }
  70         NADataBoxed;
  71
  72 typedef struct NADataBoxedClassPrivate NADataBoxedClassPrivate;
  73
  74 typedef struct {
  75         /*< private >*/
  76         GObjectClass             parent;
  77         NADataBoxedClassPrivate *private;
  78 }
  79         NADataBoxedClass;
  80
  81 GType        na_data_boxed_get_type( void );
  82
  83 GParamSpec  *na_data_boxed_get_param_spec ( const NADataDef *def );
  84
  85 NADataBoxed *na_data_boxed_new            ( const NADataDef *def );
  86
  87 NADataDef   *na_data_boxed_get_data_def   ( const NADataBoxed *boxed );
  88 gboolean     na_data_boxed_are_equal      ( const NADataBoxed *a, const NADataBoxed *b );
  89 gboolean     na_data_boxed_is_default     ( const NADataBoxed *boxed );
  90 gboolean     na_data_boxed_is_valid       ( const NADataBoxed *boxed );
  91 void         na_data_boxed_dump           ( const NADataBoxed *boxed );
  92
  93 void         na_data_boxed_set_data_def   ( NADataBoxed *boxed, const NADataDef *def );
  94
  95 gchar       *na_data_boxed_get_as_string  ( const NADataBoxed *boxed );
  96 void        *na_data_boxed_get_as_void    ( const NADataBoxed *boxed );
  97 void         na_data_boxed_get_as_value   ( const NADataBoxed *boxed, GValue *value );
  98
  99 void         na_data_boxed_set_from_boxed ( NADataBoxed *boxed, const NADataBoxed *value );
 100 void         na_data_boxed_set_from_string( NADataBoxed *boxed, const gchar *value );
 101 void         na_data_boxed_set_from_value ( NADataBoxed *boxed, const GValue *value );
 102 void         na_data_boxed_set_from_void  ( NADataBoxed *boxed, const void *value );
 103
 104 G_END_DECLS
 105
 106 #endif /* __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__ */