src/consolidate.h

   1 #ifndef _GNM_CONSOLIDATE_H_
   2 # define _GNM_CONSOLIDATE_H_
   3
   4 #include <gnumeric.h>
   5 #include <tools/dao.h>
   6 #include <tools/tools.h>
   7
   8 G_BEGIN_DECLS
   9
  10 typedef enum {
  11         /*
  12          * These can be both set, both unset or
  13          * one of them can be set. Indicates
  14          * what sort of consolidation we will
  15          * execute
  16          */
  17         CONSOLIDATE_ROW_LABELS   = 1 << 0,
  18         CONSOLIDATE_COL_LABELS   = 1 << 1,
  19
  20         /*
  21          * If set the row and/or column labels
  22          * will be copied to the destination area
  23          */
  24         CONSOLIDATE_COPY_LABELS  = 1 << 2,
  25
  26         /* If this is set we put the outcome
  27          * of our formulas into the destination
  28          * otherwise we put formulas
  29          */
  30         CONSOLIDATE_PUT_VALUES   = 1 << 3
  31 } GnmConsolidateMode;
  32
  33 struct _GnmConsolidate {
  34         GnmFunc *fd;
  35
  36         GSList      *src;
  37
  38         GnmConsolidateMode mode;
  39
  40         /* <private> */
  41         unsigned ref_count;     /* boxed type */
  42 };
  43
  44 GType        gnm_consolidate_get_type (void);
  45 GnmConsolidate *gnm_consolidate_new  (void);
  46 void         gnm_consolidate_free (GnmConsolidate *cs, gboolean content_only);
  47
  48 void         gnm_consolidate_set_function    (GnmConsolidate *cs, GnmFunc *fd);
  49 void         gnm_consolidate_set_mode        (GnmConsolidate *cs,
  50                                           GnmConsolidateMode mode);
  51
  52 gboolean     gnm_consolidate_add_source      (GnmConsolidate *cs, GnmValue *range);
  53 gboolean     gnm_consolidate_check_destination (GnmConsolidate *cs,
  54                                             data_analysis_output_t *dao);
  55
  56 gboolean gnm_tool_consolidate_engine (GOCmdContext *gcc, data_analysis_output_t *dao, gpointer specs,
  57                              analysis_tool_engine_t selector, gpointer result);
  58
  59 G_END_DECLS
  60
  61 #endif /* _GNM_CONSOLIDATE_H_ */