Merge remote-tracking branch 'origin/master' into sheet
[pspp] / src / ui / gui / psppire-data-sheet.h
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2011, 2012, 2013 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 #error "Do not include this file"
21
22 /* PsppireDataSheet is a PsppSheetView that displays the data in a dataset,
23    with one column per variable and one row per case.
24
25    PsppireDataSheet is usually a child of PsppireDataEditor in the widget
26    hierarchy.  Other widgets can also use it. */
27
28 #include <gtk/gtk.h>
29 #include "ui/gui/pspp-sheet-view.h"
30
31 G_BEGIN_DECLS
32
33 #define PSPP_TYPE_DATA_SHEET              (psppire_data_sheet_get_type())
34 #define PSPPIRE_DATA_SHEET(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj),PSPP_TYPE_DATA_SHEET,PsppireDataSheet))
35 #define PSPPIRE_DATA_SHEET_CLASS(class)   (G_TYPE_CHECK_CLASS_CAST ((class),PSPP_TYPE_DATA_SHEET,PsppireDataSheetClass))
36 #define PSPP_IS_DATA_SHEET(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj),PSPP_TYPE_DATA_SHEET))
37 #define PSPP_IS_DATA_SHEET_CLASS(class)   (G_TYPE_CHECK_CLASS_TYPE ((class),PSPP_TYPE_DATA_SHEET))
38 #define PSPPIRE_DATA_SHEET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj),PSPP_TYPE_DATA_SHEET,PsppireDataSheetClass))
39
40 typedef struct _PsppireDataSheet      PsppireDataSheet;
41 typedef struct _PsppireDataSheetClass PsppireDataSheetClass;
42
43 struct _PsppireDataSheet
44 {
45   PsppSheetView parent;
46
47   struct _PsppireDataStore *data_store;
48   gboolean show_value_labels;
49   gboolean show_case_numbers;
50   gboolean may_create_vars;
51   gboolean may_delete_vars;
52
53   gboolean owns_primary_selection;
54
55   guint scroll_to_bottom_signal;
56   guint scroll_to_right_signal;
57
58   GtkClipboard *clip;
59   guint on_owner_change_signal;
60
61   PsppSheetViewColumn *new_variable_column;
62
63   GtkWidget *container;
64   gboolean dispose_has_run;
65
66   GtkWidget *column_popup_menu;
67   GtkWidget *row_popup_menu;
68   
69   GtkWidget *pu_sort_up;
70   GtkWidget *pu_sort_down;
71 };
72
73 struct _PsppireDataSheetClass 
74 {
75   PsppSheetViewClass parent_class;
76 };
77
78 GType psppire_data_sheet_get_type (void) G_GNUC_CONST;
79 GtkWidget *psppire_data_sheet_new (void);
80
81 struct _PsppireDataStore *psppire_data_sheet_get_data_store (PsppireDataSheet *);
82 void psppire_data_sheet_set_data_store (PsppireDataSheet *,
83                                         struct _PsppireDataStore *);
84
85 gboolean psppire_data_sheet_get_value_labels (const PsppireDataSheet *);
86 void psppire_data_sheet_set_value_labels (PsppireDataSheet *,
87                                           gboolean show_value_labels);
88
89 gboolean psppire_data_sheet_get_case_numbers (const PsppireDataSheet *);
90 void psppire_data_sheet_set_case_numbers (PsppireDataSheet *,
91                                           gboolean show_case_numbers);
92
93 gboolean psppire_data_sheet_get_may_create_vars (PsppireDataSheet *);
94 void psppire_data_sheet_set_may_create_vars (PsppireDataSheet *, gboolean);
95
96 gboolean psppire_data_sheet_get_may_delete_vars (PsppireDataSheet *);
97 void psppire_data_sheet_set_may_delete_vars (PsppireDataSheet *, gboolean);
98
99 void psppire_data_sheet_goto_variable (PsppireDataSheet *, gint dict_index);
100 struct variable *psppire_data_sheet_get_current_variable (const PsppireDataSheet *);
101
102 void psppire_data_sheet_goto_case (PsppireDataSheet *, gint case_index);
103 gint psppire_data_sheet_get_selected_case (const PsppireDataSheet *);
104 gint psppire_data_sheet_get_current_case (const PsppireDataSheet *);
105
106 void psppire_data_sheet_insert_case (PsppireDataSheet *data_sheet);
107 void psppire_data_sheet_insert_variable (PsppireDataSheet *data_sheet);
108
109 void psppire_data_sheet_edit_cut (PsppireDataSheet *data_sheet);
110 void psppire_data_sheet_edit_copy (PsppireDataSheet *data_sheet);
111 void psppire_data_sheet_edit_paste (PsppireDataSheet *data_sheet);
112
113 void psppire_data_sheet_edit_clear_cases (PsppireDataSheet *data_sheet);
114 void psppire_data_sheet_edit_clear_variables (PsppireDataSheet *data_sheet);
115
116 G_END_DECLS
117
118 #endif /* PSPPIRE_DATA_SHEET_H */