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  * <refsect2>
  44  *  <title>Versions historic</title>
  45  *  <table>
  46  *    <title>Historic of the versions of the #NADataBoxed interface</title>
  47  *    <tgroup rowsep="1" colsep="1" align="center" cols="3">
  48  *      <colspec colname="na-version" />
  49  *      <colspec colname="api-version" />
  50  *      <colspec colname="current" />
  51  *      <thead>
  52  *        <row>
  53  *          <entry>&prodname; version</entry>
  54  *          <entry>#NADataBoxed interface version</entry>
  55  *          <entry></entry>
  56  *        </row>
  57  *      </thead>
  58  *      <tbody>
  59  *        <row>
  60  *          <entry>since 2.30</entry>
  61  *          <entry>1</entry>
  62  *          <entry>current version</entry>
  63  *        </row>
  64  *      </tbody>
  65  *    </tgroup>
  66  *  </table>
  67  * </refsect2>
  68  */
  69
  70 #include <glib-object.h>
  71
  72 #include "na-data-def.h"
  73
  74 G_BEGIN_DECLS
  75
  76 #define NA_DATA_BOXED_TYPE                  ( na_data_boxed_get_type())
  77 #define NA_DATA_BOXED( object )             ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_DATA_BOXED_TYPE, NADataBoxed ))
  78 #define NA_DATA_BOXED_CLASS( klass )        ( G_TYPE_CHECK_CLASS_CAST( klass, NA_DATA_BOXED_TYPE, NADataBoxedClass ))
  79 #define NA_IS_DATA_BOXED( object )          ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_DATA_BOXED_TYPE ))
  80 #define NA_IS_DATA_BOXED_CLASS( klass )     ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_DATA_BOXED_TYPE ))
  81 #define NA_DATA_BOXED_GET_CLASS( object )   ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_DATA_BOXED_TYPE, NADataBoxedClass ))
  82
  83 typedef struct NADataBoxedPrivate      NADataBoxedPrivate;
  84
  85 typedef struct {
  86         /*< private >*/
  87         GObject             parent;
  88         NADataBoxedPrivate *private;
  89 }
  90         NADataBoxed;
  91
  92 typedef struct NADataBoxedClassPrivate NADataBoxedClassPrivate;
  93
  94 typedef struct {
  95         /*< private >*/
  96         GObjectClass             parent;
  97         NADataBoxedClassPrivate *private;
  98 }
  99         NADataBoxedClass;
 100
 101 GType        na_data_boxed_get_type( void );
 102
 103 GParamSpec  *na_data_boxed_get_param_spec ( const NADataDef *def );
 104
 105 NADataBoxed *na_data_boxed_new            ( const NADataDef *def );
 106
 107 NADataDef   *na_data_boxed_get_data_def   ( const NADataBoxed *boxed );
 108 gboolean     na_data_boxed_are_equal      ( const NADataBoxed *a, const NADataBoxed *b );
 109 gboolean     na_data_boxed_is_default     ( const NADataBoxed *boxed );
 110 gboolean     na_data_boxed_is_valid       ( const NADataBoxed *boxed );
 111 void         na_data_boxed_dump           ( const NADataBoxed *boxed );
 112
 113 void         na_data_boxed_set_data_def   ( NADataBoxed *boxed, const NADataDef *def );
 114
 115 gchar       *na_data_boxed_get_as_string  ( const NADataBoxed *boxed );
 116 void        *na_data_boxed_get_as_void    ( const NADataBoxed *boxed );
 117 void         na_data_boxed_get_as_value   ( const NADataBoxed *boxed, GValue *value );
 118
 119 void         na_data_boxed_set_from_boxed ( NADataBoxed *boxed, const NADataBoxed *value );
 120 void         na_data_boxed_set_from_string( NADataBoxed *boxed, const gchar *value );
 121 void         na_data_boxed_set_from_value ( NADataBoxed *boxed, const GValue *value );
 122 void         na_data_boxed_set_from_void  ( NADataBoxed *boxed, const void *value );
 123
 124 G_END_DECLS
 125
 126 #endif /* __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__ */