src/ui/gui/psppire-dict.h

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2004, 2009  Free Software Foundation
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17
  18 #ifndef __PSPPIRE_DICT_H__
  19 #define __PSPPIRE_DICT_H__
  20
  21
  22 #include <glib-object.h>
  23 #include <glib.h>
  24
  25 #include <data/dictionary.h>
  26 #include <data/variable.h>
  27
  28
  29 G_BEGIN_DECLS
  30
  31
  32 /* --- type macros --- */
  33 #define PSPPIRE_TYPE_DICT              (psppire_dict_get_type ())
  34 #define PSPPIRE_DICT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PSPPIRE_TYPE_DICT, PsppireDict))
  35 #define PSPPIRE_DICT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), PSPPIRE_TYPE_DICT, PsppireDictClass))
  36 #define PSPPIRE_IS_DICT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PSPPIRE_TYPE_DICT))
  37 #define PSPPIRE_IS_DICT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPPIRE_TYPE_DICT))
  38 #define PSPPIRE_DICT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PSPPIRE_TYPE_DICT, PsppireDictClass))
  39
  40
  41 /* --- typedefs & structures --- */
  42 typedef struct _PsppireDict        PsppireDict;
  43 typedef struct _PsppireDictClass PsppireDictClass;
  44
  45 enum {DICT_TVM_COL_NAME=0, DICT_TVM_COL_VAR, DICT_TVM_COL_LABEL, n_DICT_COLS} ;
  46
  47 struct _PsppireDict
  48 {
  49   GObject             parent;
  50   struct dictionary *dict;
  51
  52   gboolean disable_insert_signal;
  53   /* For GtkTreeModelIface */
  54   gint stamp;
  55 };
  56
  57 struct _PsppireDictClass
  58 {
  59   GObjectClass parent_class;
  60 };
  61
  62
  63 /* -- PsppireDict --- */
  64 GType          psppire_dict_get_type (void);
  65 PsppireDict*   psppire_dict_new_from_dict (struct dictionary *d);
  66 gboolean       psppire_dict_set_name (PsppireDict* s, gint idx, const gchar *name);
  67 void           psppire_dict_delete_var (PsppireDict *s, gint idx);
  68
  69 /* Return the number of variables in the dictionary */
  70 gint psppire_dict_get_var_cnt (const PsppireDict *d);
  71
  72 /* Return the number of `union value's in the dictionary */
  73 size_t psppire_dict_get_value_cnt (const PsppireDict *d);
  74
  75 /* Returns the prototype for the cases that match the dictionary */
  76 const struct caseproto *psppire_dict_get_proto (const PsppireDict *d);
  77
  78 /* Return a variable by name.
  79    Return NULL if it doesn't exist
  80 */
  81 struct variable * psppire_dict_lookup_var (const PsppireDict *d, const gchar *name);
  82
  83 /* Clears the contents of D */
  84 void psppire_dict_clear (PsppireDict *d);
  85
  86 /* Return the IDXth variable */
  87 struct variable * psppire_dict_get_variable (const PsppireDict *d, gint idx);
  88
  89 /* Delete N variables beginning at FIRST */
  90 void psppire_dict_delete_variables (PsppireDict *d, gint first, gint n);
  91
  92 /* Insert a new variable at posn IDX */
  93 void psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name);
  94
  95 void psppire_dict_resize_variable (PsppireDict *,
  96                                   const struct variable *,
  97                                   gint, gint );
  98
  99 gboolean psppire_dict_check_name (const PsppireDict *dict,
 100                               const gchar *name, gboolean report);
 101
 102 gint psppire_dict_get_next_value_idx (const PsppireDict *dict);
 103
 104 gboolean psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
 105                               const gchar *text);
 106
 107 void psppire_dict_replace_dictionary (PsppireDict *, struct dictionary *);
 108
 109 struct variable * psppire_dict_get_weight_variable (const PsppireDict *);
 110
 111 #if DEBUGGING
 112 void psppire_dict_dump (const PsppireDict *);
 113 #endif
 114
 115 const gchar *psppire_dict_encoding (const PsppireDict *);
 116
 117 G_END_DECLS
 118
 119 #endif /* __PSPPIRE_DICT_H__ */