1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/**
* @file
* GTK widget, extending a \e GtkTreeView, for displaying an experiment's
* structure for navigational purposes.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <assert.h>
#include <inttypes.h>
#include <glib.h>
#include <glib/gprintf.h>
#include <gtk/gtk.h>
#include <experiment-reader.h>
#include "gtk-experiment-navigator.h"
static void gtk_experiment_navigator_class_init(GtkExperimentNavigatorClass *klass);
static void gtk_experiment_navigator_init(GtkExperimentNavigator *klass);
static void time_cell_data_cb(GtkTreeViewColumn *col,
GtkCellRenderer *renderer,
GtkTreeModel *model, GtkTreeIter *iter,
gpointer user_data);
static inline void select_time(GtkExperimentNavigator *navi, gint64 selected_time);
/** @private */
enum {
TIME_SELECTED_SIGNAL,
LAST_SIGNAL
};
static guint gtk_experiment_navigator_signals[LAST_SIGNAL] = {0};
/**
* @private
* Enumeration of tree store columns that serve as Ids when manipulating
* the store.
*/
enum {
COL_NAME, /**< Name of the section, subsection or topic (\e G_TYPE_STRING) */
COL_START_TIME, /**< Start time of the entity (\e G_TYPE_UINT64 in milliseconds) */
NUM_COLS /**< Number of columns */
};
/** @private */
GType
gtk_experiment_navigator_get_type(void)
{
static GType type = 0;
if (!type) {
/* FIXME: destructor needed */
const GTypeInfo info = {
sizeof(GtkExperimentNavigatorClass),
NULL, /* base_init */
NULL, /* base_finalize */
(GClassInitFunc)gtk_experiment_navigator_class_init,
NULL, /* class_finalize */
NULL, /* class_data */
sizeof(GtkExperimentNavigator),
0, /* n_preallocs */
(GInstanceInitFunc)gtk_experiment_navigator_init,
};
type = g_type_register_static(GTK_TYPE_TREE_VIEW,
"GtkExperimentNavigator", &info, 0);
}
return type;
}
static void
gtk_experiment_navigator_class_init(GtkExperimentNavigatorClass *klass)
{
gtk_experiment_navigator_signals[TIME_SELECTED_SIGNAL] =
g_signal_new("time-selected",
G_TYPE_FROM_CLASS(klass),
G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
G_STRUCT_OFFSET(GtkExperimentNavigatorClass, time_selected),
NULL, NULL,
g_cclosure_marshal_VOID__LONG, G_TYPE_NONE,
1, G_TYPE_INT64);
}
/**
* Internal constructor for the \e GtkExperimentNavigator widget.
* It has to create the \e GtkTreeStore (MVC model), add and configure
* view columns and add cell renderers to the view columns.
* It should connect the necessary signals to respond to row activations
* (double click) in order to emit the "time-selected" signal.
*
* @param klass Newly constructed \e GtkExperimentNavigator instance
*/
static void
gtk_experiment_navigator_init(GtkExperimentNavigator *klass)
{
GtkTreeView *view = GTK_TREE_VIEW(klass);
GtkTreeViewColumn *col;
GtkCellRenderer *renderer;
GtkTreeStore *store;
GtkTreeIter toplevel, child;
/*
* Create tree store (and model)
*/
store = gtk_tree_store_new(NUM_COLS, G_TYPE_STRING, G_TYPE_UINT64);
/*
* Create some sample(!) store rows and content
*/
/** @todo remove sample code */
gtk_tree_store_append(store, &toplevel, NULL);
gtk_tree_store_set(store, &toplevel,
COL_NAME, "greeting",
-1);
gtk_tree_store_append(store, &child, &toplevel);
gtk_tree_store_set(store, &child,
COL_NAME, "bz_1",
COL_START_TIME, (gint64)5*60*1000 /* 5 minutes */,
-1);
/*
* Create TreeView column corresponding to the
* TreeStore column \e COL_NAME
*/
col = gtk_tree_view_column_new();
gtk_tree_view_column_set_title(col, "Name");
gtk_tree_view_append_column(view, col);
renderer = gtk_cell_renderer_text_new();
gtk_tree_view_column_pack_start(col, renderer, TRUE);
gtk_tree_view_column_add_attribute(col, renderer, "text", COL_NAME);
/**
* @todo Perhaps an icon should be rendered in front of the name to
* indicate the entity's type (section, subsection, topic...)
*/
/*
* Create TreeView column corresponding to the
* TreeStore column \e COL_START_TIME
*/
col = gtk_tree_view_column_new();
gtk_tree_view_column_set_title(col, "Time");
gtk_tree_view_append_column(view, col);
renderer = gtk_cell_renderer_text_new();
gtk_tree_view_column_pack_start(col, renderer, TRUE);
/* Cell data function for custom formatting */
gtk_tree_view_column_set_cell_data_func(col, renderer, time_cell_data_cb,
NULL, NULL);
/*
* Set TreeView model to store's model
*/
gtk_tree_view_set_model(view, GTK_TREE_MODEL(store));
/* destroy store/model automatically with view */
g_object_unref(store);
/** @todo better \e TreeViewColumn formatting */
/** @todo connect signals to respond to row activations */
}
/**
* Cell data function to invoke when rendering the "Time" column.
*
* @param col \e GtkTreeViewColumn to render for
* @param renderer Cell renderer to use for rendering
* @param model \e GtkTreeModel associated with the view
* @param iter Row identifier
* @param user_data Callback user data
*/
static void
time_cell_data_cb(GtkTreeViewColumn *col __attribute__((unused)),
GtkCellRenderer *renderer,
GtkTreeModel *model, GtkTreeIter *iter,
gpointer user_data __attribute__((unused)))
{
gint64 time_val;
gchar buf[20];
gtk_tree_model_get(model, iter,
COL_START_TIME, &time_val, -1);
/** @todo Improve readability (e.g. h:mm:ss) */
/** @todo Do we always want to render the time column??? */
g_snprintf(buf, sizeof(buf), "%" PRId64 "ms", time_val);
g_object_set(renderer, "text", buf, NULL);
}
/**
* Emit "time-selected" signal on a \e GtkExperimentNavigator instance.
* It should be emitted when a row entry was selected.
*
* @param navi Widget to emit the signal
* @param selected_time Selected time in milliseconds
*/
static inline void
select_time(GtkExperimentNavigator *navi, gint64 selected_time)
{
g_signal_emit(navi, gtk_experiment_navigator_signals[TIME_SELECTED_SIGNAL], 0,
selected_time);
}
/*
* API
*/
/**
* Construct new \e GtkExperimentNavigator widget instance.
*
* @return New \e GtkExperimentNavigator widget instance
*/
GtkWidget *
gtk_experiment_navigator_new(void)
{
return GTK_WIDGET(g_object_new(GTK_TYPE_EXPERIMENT_NAVIGATOR, NULL));
}
/**
* Fills the \e GtkExperimentNavigator widget with the structure specified
* in an experiment-XML file (see session.dtd).
* Any existing contents should be cleared.
*
* @param navi Object instance to display the structure in
* @param exp \e ExperimentReader instance symbolizing the XML-file
* @return \e TRUE on error, else \e FALSE
*/
gboolean
gtk_experiment_navigator_load(GtkExperimentNavigator *navi,
ExperimentReader *exp)
{
/** @todo Clear contents, process XML file and fill \e TreeViewStore */
return TRUE;
}
/**
* Fills the \e GtkExperimentNavigator widget with the structure specified
* in an experiment-XML file (see session.dtd).
* Any existing contents should be cleared.
*
* @param navi Object instance to display the structure in
* @param exp Filename of XML-file to open and use for configuring \e navi
* @return \e TRUE on error, else \e FALSE
*/
gboolean
gtk_experiment_navigator_load_filename(GtkExperimentNavigator *navi,
const gchar *exp)
{
/** @todo Clear contents, process XML file and fill \e TreeViewStore */
return TRUE;
}
|
