src/tools/scenarios.h

   1 #ifndef __SCENARIOS_H__
   2 #define __SCENARIOS_H__
   3
   4 #include <gnumeric.h>
   5 #include <glib-object.h>
   6
   7 /* ------------------------------------------------------------------------- */
   8
   9 typedef struct {
  10         GnmDependent dep;
  11         GnmValue *value;
  12 } GnmScenarioItem;
  13
  14 GType gnm_scenario_item_get_type (void);
  15 GnmScenarioItem *gnm_scenario_item_new (Sheet *sheet);
  16 void gnm_scenario_item_free (GnmScenarioItem *sci);
  17 void gnm_scenario_item_set_range (GnmScenarioItem *sci,
  18                                   const GnmSheetRange *sr);
  19 void gnm_scenario_item_set_value (GnmScenarioItem *sci,
  20                                   const GnmValue *v);
  21 gboolean gnm_scenario_item_valid (const GnmScenarioItem *sci,
  22                                   GnmSheetRange *sr);
  23
  24 /* ------------------------------------------------------------------------- */
  25
  26 #define GNM_SCENARIO_TYPE        (gnm_scenario_get_type ())
  27 #define GNM_SCENARIO(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), GNM_SCENARIO_TYPE, GnmScenario))
  28 #define GNM_SCENARIO_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST ((k), GNM_SCENARIO_TYPE, GnmScenarioClass))
  29 #define GNM_IS_SCENARIO(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNM_SCENARIO_TYPE))
  30
  31 struct GnmScenario_ {
  32         GObject parent;
  33
  34         Sheet *sheet;
  35         char *name;
  36         char *comment;
  37
  38         GSList *items;
  39 };
  40
  41 typedef struct {
  42         GObjectClass parent_class;
  43 } GnmScenarioClass;
  44
  45 GType gnm_scenario_get_type (void);
  46
  47 GnmScenario *gnm_scenario_new (char const *name, Sheet *sheet);
  48
  49 GnmScenario *gnm_scenario_dup (GnmScenario *sc, Sheet *new_sheet);
  50
  51 void gnm_scenario_set_comment (GnmScenario *sc, const char *comment);
  52
  53 void gnm_scenario_add_area (GnmScenario *sc, const GnmSheetRange *sr);
  54
  55 GOUndo *gnm_scenario_apply (GnmScenario *sc);
  56
  57 char *gnm_scenario_get_range_str (const GnmScenario *sc);
  58
  59 /* ------------------------------------------------------------------------- */
  60
  61 #endif