1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2011 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 (need_button) : 1;
116 struct _PsppSheetViewColumnClass
118 GtkObjectClass parent_class;
120 gboolean (*clicked) (PsppSheetViewColumn *tree_column);
121 gboolean (*button_press_event) (PsppSheetViewColumn *,
124 /* Padding for future expansion */
125 void (*_gtk_reserved1) (void);
126 void (*_gtk_reserved2) (void);
127 void (*_gtk_reserved3) (void);
128 void (*_gtk_reserved4) (void);
131 GType pspp_sheet_view_column_get_type (void) G_GNUC_CONST;
132 PsppSheetViewColumn *pspp_sheet_view_column_new (void);
133 PsppSheetViewColumn *pspp_sheet_view_column_new_with_attributes (const gchar *title,
134 GtkCellRenderer *cell,
135 ...) G_GNUC_NULL_TERMINATED;
136 void pspp_sheet_view_column_pack_start (PsppSheetViewColumn *tree_column,
137 GtkCellRenderer *cell,
139 void pspp_sheet_view_column_pack_end (PsppSheetViewColumn *tree_column,
140 GtkCellRenderer *cell,
142 void pspp_sheet_view_column_clear (PsppSheetViewColumn *tree_column);
143 #ifndef GTK_DISABLE_DEPRECATED
144 GList *pspp_sheet_view_column_get_cell_renderers (PsppSheetViewColumn *tree_column);
146 void pspp_sheet_view_column_add_attribute (PsppSheetViewColumn *tree_column,
147 GtkCellRenderer *cell_renderer,
148 const gchar *attribute,
150 void pspp_sheet_view_column_set_attributes (PsppSheetViewColumn *tree_column,
151 GtkCellRenderer *cell_renderer,
152 ...) G_GNUC_NULL_TERMINATED;
153 void pspp_sheet_view_column_set_cell_data_func (PsppSheetViewColumn *tree_column,
154 GtkCellRenderer *cell_renderer,
155 PsppSheetCellDataFunc func,
157 GDestroyNotify destroy);
158 void pspp_sheet_view_column_clear_attributes (PsppSheetViewColumn *tree_column,
159 GtkCellRenderer *cell_renderer);
160 void pspp_sheet_view_column_set_spacing (PsppSheetViewColumn *tree_column,
162 gint pspp_sheet_view_column_get_spacing (PsppSheetViewColumn *tree_column);
163 void pspp_sheet_view_column_set_visible (PsppSheetViewColumn *tree_column,
165 gboolean pspp_sheet_view_column_get_visible (PsppSheetViewColumn *tree_column);
166 void pspp_sheet_view_column_set_resizable (PsppSheetViewColumn *tree_column,
168 gboolean pspp_sheet_view_column_get_resizable (PsppSheetViewColumn *tree_column);
169 gint pspp_sheet_view_column_get_width (PsppSheetViewColumn *tree_column);
170 gint pspp_sheet_view_column_get_fixed_width (PsppSheetViewColumn *tree_column);
171 void pspp_sheet_view_column_set_fixed_width (PsppSheetViewColumn *tree_column,
173 void pspp_sheet_view_column_set_min_width (PsppSheetViewColumn *tree_column,
175 gint pspp_sheet_view_column_get_min_width (PsppSheetViewColumn *tree_column);
176 void pspp_sheet_view_column_set_max_width (PsppSheetViewColumn *tree_column,
178 gint pspp_sheet_view_column_get_max_width (PsppSheetViewColumn *tree_column);
179 void pspp_sheet_view_column_clicked (PsppSheetViewColumn *tree_column);
183 /* Options for manipulating the column headers
185 void pspp_sheet_view_column_set_title (PsppSheetViewColumn *tree_column,
187 G_CONST_RETURN gchar *pspp_sheet_view_column_get_title (PsppSheetViewColumn *tree_column);
188 void pspp_sheet_view_column_set_expand (PsppSheetViewColumn *tree_column,
190 gboolean pspp_sheet_view_column_get_expand (PsppSheetViewColumn *tree_column);
191 void pspp_sheet_view_column_set_clickable (PsppSheetViewColumn *tree_column,
193 gboolean pspp_sheet_view_column_get_clickable (PsppSheetViewColumn *tree_column);
194 void pspp_sheet_view_column_set_widget (PsppSheetViewColumn *tree_column,
196 GtkWidget *pspp_sheet_view_column_get_widget (PsppSheetViewColumn *tree_column);
197 void pspp_sheet_view_column_set_alignment (PsppSheetViewColumn *tree_column,
199 gfloat pspp_sheet_view_column_get_alignment (PsppSheetViewColumn *tree_column);
200 void pspp_sheet_view_column_set_reorderable (PsppSheetViewColumn *tree_column,
201 gboolean reorderable);
202 gboolean pspp_sheet_view_column_get_reorderable (PsppSheetViewColumn *tree_column);
204 void pspp_sheet_view_column_set_quick_edit (PsppSheetViewColumn *tree_column,
205 gboolean quick_edit);
206 gboolean pspp_sheet_view_column_get_quick_edit (PsppSheetViewColumn *tree_column);
207 void pspp_sheet_view_column_set_selected (PsppSheetViewColumn *tree_column,
209 gboolean pspp_sheet_view_column_get_selected (PsppSheetViewColumn *tree_column);
211 void pspp_sheet_view_column_set_selectable (PsppSheetViewColumn *tree_column,
212 gboolean selectable);
213 gboolean pspp_sheet_view_column_get_selectable (PsppSheetViewColumn *tree_column);
214 void pspp_sheet_view_column_set_row_head (PsppSheetViewColumn *tree_column,
216 gboolean pspp_sheet_view_column_get_row_head (PsppSheetViewColumn *tree_column);
220 /* You probably only want to use pspp_sheet_view_column_set_sort_column_id. The
221 * other sorting functions exist primarily to let others do their own custom sorting.
223 void pspp_sheet_view_column_set_sort_column_id (PsppSheetViewColumn *tree_column,
224 gint sort_column_id);
225 gint pspp_sheet_view_column_get_sort_column_id (PsppSheetViewColumn *tree_column);
226 void pspp_sheet_view_column_set_sort_indicator (PsppSheetViewColumn *tree_column,
228 gboolean pspp_sheet_view_column_get_sort_indicator (PsppSheetViewColumn *tree_column);
229 void pspp_sheet_view_column_set_sort_order (PsppSheetViewColumn *tree_column,
231 GtkSortType pspp_sheet_view_column_get_sort_order (PsppSheetViewColumn *tree_column);
234 /* These functions are meant primarily for interaction between the PsppSheetView and the column.
236 void pspp_sheet_view_column_cell_set_cell_data (PsppSheetViewColumn *tree_column,
237 GtkTreeModel *tree_model,
239 void pspp_sheet_view_column_cell_get_size (PsppSheetViewColumn *tree_column,
240 const GdkRectangle *cell_area,
245 gboolean pspp_sheet_view_column_cell_is_visible (PsppSheetViewColumn *tree_column);
246 void pspp_sheet_view_column_focus_cell (PsppSheetViewColumn *tree_column,
247 GtkCellRenderer *cell);
248 gboolean pspp_sheet_view_column_cell_get_position (PsppSheetViewColumn *tree_column,
249 GtkCellRenderer *cell_renderer,
252 void pspp_sheet_view_column_queue_resize (PsppSheetViewColumn *tree_column);
253 GtkWidget *pspp_sheet_view_column_get_tree_view (PsppSheetViewColumn *tree_column);
255 void pspp_sheet_view_column_size_request (PsppSheetViewColumn *tree_column,
256 GtkRequisition *requisition);
258 void pspp_sheet_view_column_size_allocate (PsppSheetViewColumn *tree_column,
259 GtkAllocation *allocation);
260 gboolean pspp_sheet_view_column_can_focus (PsppSheetViewColumn *tree_column);
261 void pspp_sheet_view_column_set_need_button (PsppSheetViewColumn *tree_column,
262 gboolean need_button);
267 #endif /* __PSPP_SHEET_VIEW_COLUMN_H__ */