src/go-data-cache-field.h

   1 /*
   2  * go-data-cache-field.h :
   3  *
   4  * Copyright (C) 2008 Jody Goldberg (jody@gnome.org)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) version 3.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  19  * USA
  20  */
  21 #ifndef GO_DATA_CACHE_FIELD_H
  22 #define GO_DATA_CACHE_FIELD_H
  23
  24 #include <goffice-data.h>       /* remove after move to goffice */
  25 #include <goffice/goffice.h>
  26 #include <glib-object.h>
  27 #include <go-val.h>
  28
  29 #include <gnumeric.h>
  30
  31 G_BEGIN_DECLS
  32 #ifndef GOFFICE_NAMESPACE_DISABLE
  33
  34 #define GO_DATA_CACHE_FIELD_TYPE  (go_data_cache_field_get_type ())
  35 #define GO_DATA_CACHE_FIELD(o)    (G_TYPE_CHECK_INSTANCE_CAST ((o), GO_DATA_CACHE_FIELD_TYPE, GODataCacheField))
  36 #define IS_GO_DATA_CACHE_FIELD(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GO_DATA_CACHE_FIELD_TYPE))
  37
  38 typedef enum {
  39         GO_DATA_CACHE_FIELD_TYPE_INDEXED_I8,
  40         GO_DATA_CACHE_FIELD_TYPE_INDEXED_I16,
  41         GO_DATA_CACHE_FIELD_TYPE_INDEXED_I32,
  42         GO_DATA_CACHE_FIELD_TYPE_INLINE,
  43         GO_DATA_CACHE_FIELD_TYPE_NONE   /* e.g. grouped or calculated */
  44 } GODataCacheFieldType;
  45
  46 GType go_data_cache_field_get_type (void);
  47
  48 GODataCache      *go_data_cache_field_get_cache (GODataCacheField const *field);
  49 GOVal const      *go_data_cache_field_get_val   (GODataCacheField const *field, unsigned int record_num);
  50 GOString         *go_data_cache_field_get_name  (GODataCacheField const *field);
  51 GOValArray const *go_data_cache_field_get_vals  (GODataCacheField const *field, gboolean group_val);
  52 void              go_data_cache_field_set_vals  (GODataCacheField       *field, gboolean group_val,
  53                                                  GOValArray *a);
  54
  55 gboolean          go_data_cache_field_is_base (GODataCacheField const *field);
  56 GODataCacheFieldType
  57                   go_data_cache_field_ref_type (GODataCacheField const *field);
  58
  59 #endif
  60 G_END_DECLS
  61
  62 #endif /* GO_DATA_CACHE_FIELD_H */