src/go-data-cache-field.h

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