gui: Rename psppire_data_sheet_show_variable().
[pspp] / src / ui / gui / psppire-data-sheet.h
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2011, 2012 Free Software Foundation, Inc.
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 #ifndef PSPPIRE_DATA_SHEET_H
18 #define PSPPIRE_DATA_SHEET_H 1
19
20 /* PsppireDataSheet is a PsppSheetView that displays the data in a dataset,
21    with one column per variable and one row per case.
22
23    PsppireDataSheet is usually a child of PsppireDataEditor in the widget
24    hierarchy.  Other widgets can also use it. */
25
26 #include <gtk/gtk.h>
27 #include "ui/gui/pspp-sheet-view.h"
28
29 G_BEGIN_DECLS
30
31 #define PSPP_TYPE_DATA_SHEET              (psppire_data_sheet_get_type())
32 #define PSPPIRE_DATA_SHEET(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj),PSPP_TYPE_DATA_SHEET,PsppireDataSheet))
33 #define PSPPIRE_DATA_SHEET_CLASS(class)   (G_TYPE_CHECK_CLASS_CAST ((class),PSPP_TYPE_DATA_SHEET,PsppireDataSheetClass))
34 #define PSPP_IS_DATA_SHEET(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj),PSPP_TYPE_DATA_SHEET))
35 #define PSPP_IS_DATA_SHEET_CLASS(class)   (G_TYPE_CHECK_CLASS_TYPE ((class),PSPP_TYPE_DATA_SHEET))
36 #define PSPPIRE_DATA_SHEET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj),PSPP_TYPE_DATA_SHEET,PsppireDataSheetClass))
37
38 typedef struct _PsppireDataSheet      PsppireDataSheet;
39 typedef struct _PsppireDataSheetClass PsppireDataSheetClass;
40
41 struct _PsppireDataSheet
42 {
43   PsppSheetView parent;
44
45   struct _PsppireDataStore *data_store;
46   gboolean show_value_labels;
47   gboolean show_case_numbers;
48   gboolean may_create_vars;
49   gboolean may_delete_vars;
50
51   guint scroll_to_bottom_signal;
52   guint scroll_to_right_signal;
53
54   PsppSheetViewColumn *new_variable_column;
55
56   GtkBuilder *builder;
57
58   GtkWidget *container;
59   GtkUIManager *uim;
60   gboolean dispose_has_run;
61 };
62
63 struct _PsppireDataSheetClass 
64 {
65   PsppSheetViewClass parent_class;
66 };
67
68 GType psppire_data_sheet_get_type (void) G_GNUC_CONST;
69 GtkWidget *psppire_data_sheet_new (void);
70
71 struct _PsppireDataStore *psppire_data_sheet_get_data_store (PsppireDataSheet *);
72 void psppire_data_sheet_set_data_store (PsppireDataSheet *,
73                                         struct _PsppireDataStore *);
74
75 gboolean psppire_data_sheet_get_value_labels (const PsppireDataSheet *);
76 void psppire_data_sheet_set_value_labels (PsppireDataSheet *,
77                                           gboolean show_value_labels);
78
79 gboolean psppire_data_sheet_get_case_numbers (const PsppireDataSheet *);
80 void psppire_data_sheet_set_case_numbers (PsppireDataSheet *,
81                                           gboolean show_case_numbers);
82
83 gboolean psppire_data_sheet_get_may_create_vars (PsppireDataSheet *);
84 void psppire_data_sheet_set_may_create_vars (PsppireDataSheet *, gboolean);
85
86 gboolean psppire_data_sheet_get_may_delete_vars (PsppireDataSheet *);
87 void psppire_data_sheet_set_may_delete_vars (PsppireDataSheet *, gboolean);
88
89 void psppire_data_sheet_goto_variable (PsppireDataSheet *, gint dict_index);
90 struct variable *psppire_data_sheet_get_current_variable (const PsppireDataSheet *);
91
92 void psppire_data_sheet_goto_case (PsppireDataSheet *, gint case_index);
93 gint psppire_data_sheet_get_selected_case (const PsppireDataSheet *);
94 gint psppire_data_sheet_get_current_case (const PsppireDataSheet *);
95
96 GtkUIManager *psppire_data_sheet_get_ui_manager (PsppireDataSheet *);
97
98 G_END_DECLS
99
100 #endif /* PSPPIRE_DATA_SHEET_H */