1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2011, 2012 Free Software Foundation, Inc.
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.
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.
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/>. */
17 /* gtktreeviewcolumn.h
18 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
20 * This library is free software; you can redistribute it and/or
21 * modify it under the terms of the GNU Library General Public
22 * License as published by the Free Software Foundation; either
23 * version 2 of the License, or (at your option) any later version.
25 * This library is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
28 * Library General Public License for more details.
30 * You should have received a copy of the GNU Library General Public
31 * License along with this library; if not, write to the
32 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
33 * Boston, MA 02111-1307, USA.
36 #ifndef __PSPP_SHEET_VIEW_COLUMN_H__
37 #define __PSPP_SHEET_VIEW_COLUMN_H__
43 #define PSPP_TYPE_SHEET_VIEW_COLUMN (pspp_sheet_view_column_get_type ())
44 #define PSPP_SHEET_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PSPP_TYPE_SHEET_VIEW_COLUMN, PsppSheetViewColumn))
45 #define PSPP_SHEET_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PSPP_TYPE_SHEET_VIEW_COLUMN, PsppSheetViewColumnClass))
46 #define PSPP_IS_SHEET_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PSPP_TYPE_SHEET_VIEW_COLUMN))
47 #define PSPP_IS_SHEET_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPP_TYPE_SHEET_VIEW_COLUMN))
48 #define PSPP_SHEET_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PSPP_TYPE_SHEET_VIEW_COLUMN, PsppSheetViewColumnClass))
50 typedef struct _PsppSheetViewColumn PsppSheetViewColumn;
51 typedef struct _PsppSheetViewColumnClass PsppSheetViewColumnClass;
53 typedef void (* PsppSheetCellDataFunc) (PsppSheetViewColumn *tree_column,
54 GtkCellRenderer *cell,
55 GtkTreeModel *tree_model,
60 struct _PsppSheetViewColumn
64 GtkWidget *GSEAL (tree_view);
65 GtkWidget *GSEAL (button);
66 GtkWidget *GSEAL (child);
67 GtkWidget *GSEAL (arrow);
68 GtkWidget *GSEAL (alignment);
69 GdkWindow *GSEAL (window);
70 GtkCellEditable *GSEAL (editable_widget);
71 gfloat GSEAL (xalign);
72 guint GSEAL (property_changed_signal);
74 GtkAllocation GSEAL (allocation);
77 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
78 gint GSEAL (requested_width);
79 gint GSEAL (button_request);
80 gint GSEAL (resized_width);
82 gint GSEAL (fixed_width);
83 gint GSEAL (min_width);
84 gint GSEAL (max_width);
86 /* dragging columns */
91 GList *GSEAL (cell_list);
94 guint GSEAL (sort_clicked_signal);
95 guint GSEAL (sort_column_changed_signal);
96 gint GSEAL (sort_column_id);
97 GtkSortType GSEAL (sort_order);
100 guint GSEAL (visible) : 1;
101 guint GSEAL (resizable) : 1;
102 guint GSEAL (clickable) : 1;
103 guint GSEAL (dirty) : 1;
104 guint GSEAL (show_sort_indicator) : 1;
105 guint GSEAL (maybe_reordered) : 1;
106 guint GSEAL (reorderable) : 1;
107 guint GSEAL (use_resized_width) : 1;
108 guint GSEAL (expand) : 1;
109 guint GSEAL (quick_edit) : 1;
110 guint GSEAL (selected) : 1;
111 guint GSEAL (selectable) : 1;
112 guint GSEAL (row_head) : 1;
113 guint GSEAL (tabbable) : 1;
114 guint GSEAL (need_button) : 1;
117 struct _PsppSheetViewColumnClass
119 GtkObjectClass parent_class;
121 gboolean (*clicked) (PsppSheetViewColumn *tree_column);
122 gboolean (*button_press_event) (PsppSheetViewColumn *,
125 /* Padding for future expansion */
126 void (*_gtk_reserved1) (void);
127 void (*_gtk_reserved2) (void);
128 void (*_gtk_reserved3) (void);
129 void (*_gtk_reserved4) (void);
132 GType pspp_sheet_view_column_get_type (void) G_GNUC_CONST;
133 PsppSheetViewColumn *pspp_sheet_view_column_new (void);
134 PsppSheetViewColumn *pspp_sheet_view_column_new_with_attributes (const gchar *title,
135 GtkCellRenderer *cell,
136 ...) G_GNUC_NULL_TERMINATED;
137 void pspp_sheet_view_column_pack_start (PsppSheetViewColumn *tree_column,
138 GtkCellRenderer *cell,
140 void pspp_sheet_view_column_pack_end (PsppSheetViewColumn *tree_column,
141 GtkCellRenderer *cell,
143 void pspp_sheet_view_column_clear (PsppSheetViewColumn *tree_column);
145 GList *pspp_sheet_view_column_get_cell_renderers (PsppSheetViewColumn *tree_column);
147 void pspp_sheet_view_column_add_attribute (PsppSheetViewColumn *tree_column,
148 GtkCellRenderer *cell_renderer,
149 const gchar *attribute,
151 void pspp_sheet_view_column_set_attributes (PsppSheetViewColumn *tree_column,
152 GtkCellRenderer *cell_renderer,
153 ...) G_GNUC_NULL_TERMINATED;
154 void pspp_sheet_view_column_set_cell_data_func (PsppSheetViewColumn *tree_column,
155 GtkCellRenderer *cell_renderer,
156 PsppSheetCellDataFunc func,
158 GDestroyNotify destroy);
159 void pspp_sheet_view_column_clear_attributes (PsppSheetViewColumn *tree_column,
160 GtkCellRenderer *cell_renderer);
161 void pspp_sheet_view_column_set_spacing (PsppSheetViewColumn *tree_column,
163 gint pspp_sheet_view_column_get_spacing (PsppSheetViewColumn *tree_column);
164 void pspp_sheet_view_column_set_visible (PsppSheetViewColumn *tree_column,
166 gboolean pspp_sheet_view_column_get_visible (PsppSheetViewColumn *tree_column);
167 void pspp_sheet_view_column_set_resizable (PsppSheetViewColumn *tree_column,
169 gboolean pspp_sheet_view_column_get_resizable (PsppSheetViewColumn *tree_column);
170 gint pspp_sheet_view_column_get_width (PsppSheetViewColumn *tree_column);
171 gint pspp_sheet_view_column_get_fixed_width (PsppSheetViewColumn *tree_column);
172 void pspp_sheet_view_column_set_fixed_width (PsppSheetViewColumn *tree_column,
174 void pspp_sheet_view_column_set_min_width (PsppSheetViewColumn *tree_column,
176 gint pspp_sheet_view_column_get_min_width (PsppSheetViewColumn *tree_column);
177 void pspp_sheet_view_column_set_max_width (PsppSheetViewColumn *tree_column,
179 gint pspp_sheet_view_column_get_max_width (PsppSheetViewColumn *tree_column);
180 void pspp_sheet_view_column_clicked (PsppSheetViewColumn *tree_column);
184 /* Options for manipulating the column headers
186 void pspp_sheet_view_column_set_title (PsppSheetViewColumn *tree_column,
188 const gchar * pspp_sheet_view_column_get_title (PsppSheetViewColumn *tree_column);
189 void pspp_sheet_view_column_set_expand (PsppSheetViewColumn *tree_column,
191 gboolean pspp_sheet_view_column_get_expand (PsppSheetViewColumn *tree_column);
192 void pspp_sheet_view_column_set_clickable (PsppSheetViewColumn *tree_column,
194 gboolean pspp_sheet_view_column_get_clickable (PsppSheetViewColumn *tree_column);
195 void pspp_sheet_view_column_set_widget (PsppSheetViewColumn *tree_column,
197 GtkWidget *pspp_sheet_view_column_get_widget (PsppSheetViewColumn *tree_column);
198 void pspp_sheet_view_column_set_alignment (PsppSheetViewColumn *tree_column,
200 gfloat pspp_sheet_view_column_get_alignment (PsppSheetViewColumn *tree_column);
201 void pspp_sheet_view_column_set_reorderable (PsppSheetViewColumn *tree_column,
202 gboolean reorderable);
203 gboolean pspp_sheet_view_column_get_reorderable (PsppSheetViewColumn *tree_column);
205 void pspp_sheet_view_column_set_quick_edit (PsppSheetViewColumn *tree_column,
206 gboolean quick_edit);
207 gboolean pspp_sheet_view_column_get_quick_edit (PsppSheetViewColumn *tree_column);
208 void pspp_sheet_view_column_set_selected (PsppSheetViewColumn *tree_column,
210 gboolean pspp_sheet_view_column_get_selected (PsppSheetViewColumn *tree_column);
212 void pspp_sheet_view_column_set_selectable (PsppSheetViewColumn *tree_column,
213 gboolean selectable);
214 gboolean pspp_sheet_view_column_get_selectable (PsppSheetViewColumn *tree_column);
215 void pspp_sheet_view_column_set_row_head (PsppSheetViewColumn *tree_column,
217 gboolean pspp_sheet_view_column_get_row_head (PsppSheetViewColumn *tree_column);
218 void pspp_sheet_view_column_set_tabbable (PsppSheetViewColumn *tree_column,
220 gboolean pspp_sheet_view_column_get_tabbable (PsppSheetViewColumn *tree_column);
224 /* You probably only want to use pspp_sheet_view_column_set_sort_column_id. The
225 * other sorting functions exist primarily to let others do their own custom sorting.
227 void pspp_sheet_view_column_set_sort_column_id (PsppSheetViewColumn *tree_column,
228 gint sort_column_id);
229 gint pspp_sheet_view_column_get_sort_column_id (PsppSheetViewColumn *tree_column);
230 void pspp_sheet_view_column_set_sort_indicator (PsppSheetViewColumn *tree_column,
232 gboolean pspp_sheet_view_column_get_sort_indicator (PsppSheetViewColumn *tree_column);
233 void pspp_sheet_view_column_set_sort_order (PsppSheetViewColumn *tree_column,
235 GtkSortType pspp_sheet_view_column_get_sort_order (PsppSheetViewColumn *tree_column);
238 /* These functions are meant primarily for interaction between the PsppSheetView and the column.
240 void pspp_sheet_view_column_cell_set_cell_data (PsppSheetViewColumn *tree_column,
241 GtkTreeModel *tree_model,
243 void pspp_sheet_view_column_cell_get_size (PsppSheetViewColumn *tree_column,
244 const GdkRectangle *cell_area,
249 gboolean pspp_sheet_view_column_cell_is_visible (PsppSheetViewColumn *tree_column);
250 void pspp_sheet_view_column_focus_cell (PsppSheetViewColumn *tree_column,
251 GtkCellRenderer *cell);
252 gboolean pspp_sheet_view_column_cell_get_position (PsppSheetViewColumn *tree_column,
253 GtkCellRenderer *cell_renderer,
256 void pspp_sheet_view_column_queue_resize (PsppSheetViewColumn *tree_column);
257 GtkWidget *pspp_sheet_view_column_get_tree_view (PsppSheetViewColumn *tree_column);
259 void pspp_sheet_view_column_size_request (PsppSheetViewColumn *tree_column,
260 GtkRequisition *requisition);
262 void pspp_sheet_view_column_size_allocate (PsppSheetViewColumn *tree_column,
263 GtkAllocation *allocation);
264 gboolean pspp_sheet_view_column_can_focus (PsppSheetViewColumn *tree_column);
265 void pspp_sheet_view_column_set_need_button (PsppSheetViewColumn *tree_column,
266 gboolean need_button);
271 #endif /* __PSPP_SHEET_VIEW_COLUMN_H__ */