src/gnm-sheet-slicer.h

   1 /*
   2  * gnm-sheet-slicer.h : Gnumeric specific display for goffice's DataSlicers
   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 GNM_SHEET_SLICER_H
  22 #define GNM_SHEET_SLICER_H
  23
  24 #include <gnumeric.h>
  25 #include <goffice-data.h>
  26 #include <glib-object.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define GNM_SHEET_SLICER_TYPE   (gnm_sheet_slicer_get_type ())
  31 #define GNM_SHEET_SLICER(o)     (G_TYPE_CHECK_INSTANCE_CAST ((o), GNM_SHEET_SLICER_TYPE, GnmSheetSlicer))
  32 #define GNM_IS_SHEET_SLICER(o)  (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNM_SHEET_SLICER_TYPE))
  33
  34 GType gnm_sheet_slicer_get_type (void);
  35
  36 typedef enum {
  37         GSS_LAYOUT_XL_OUTLINE   = 0,
  38         GSS_LAYOUT_XL_COMPACT   = 1,
  39         GSS_LAYOUT_XL_TABULAR   = 2,
  40         GSS_LAYOUT_MAX
  41 } GnmSheetSlicerLayout;
  42
  43 void             gnm_sheet_slicer_set_sheet      (GnmSheetSlicer *gss, Sheet *sheet);
  44 void             gnm_sheet_slicer_clear_sheet    (GnmSheetSlicer *gss);
  45 GnmRange const  *gnm_sheet_slicer_get_range      (GnmSheetSlicer const *src);
  46 void             gnm_sheet_slicer_set_range      (GnmSheetSlicer *gss, GnmRange const *r);
  47 GnmSheetSlicerLayout
  48                  gnm_sheet_slicer_get_layout     (GnmSheetSlicer const *src);
  49 void             gnm_sheet_slicer_set_layout     (GnmSheetSlicer *gss, GnmSheetSlicerLayout l);
  50
  51 #ifndef GOFFICE_NAMESPACE_DISABLE
  52 GODataSlicerField *gnm_sheet_slicer_field_header_at_pos (GnmSheetSlicer const *gss, GnmCellPos const *pos);
  53 #endif
  54
  55 void               gnm_sheet_slicer_regenerate   (GnmSheetSlicer *gss);
  56
  57 /* Convenience */
  58 gboolean         gnm_sheet_slicer_overlaps_range (GnmSheetSlicer const *gss, GnmRange const *r);
  59
  60 /* Scripting */
  61 GType            gnm_sheet_slicer_layout_get_type (void);
  62
  63 /* Sheet Utilities */
  64 GnmSheetSlicer * gnm_sheet_slicers_at_pos (Sheet const *sheet, GnmCellPos const *pos);
  65
  66 G_END_DECLS
  67
  68 #endif /* GNM_SHEET_SLICER_H */