aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-table-col.c
blob: fa53fb0d0ce9420b1991f13e3be36d8c41f5aace (plain) (blame)
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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-table-col.c
 * Copyright 1999, 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Miguel de Icaza <miguel@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include <config.h>
#include <gtk/gtkobject.h>
#include <gtk/gtksignal.h>
#include "e-table-col.h"
#include "gal/util/e-util.h"

#define PARENT_TYPE (gtk_object_get_type ())

static GtkObjectClass *parent_class;


enum {
    ARG_0,
    ARG_SORTABLE,
    ARG_COMPARE_COL
};

static void
etc_destroy (GtkObject *object)
{
    ETableCol *etc = E_TABLE_COL (object);

    gtk_object_unref (GTK_OBJECT(etc->ecell));

    if (etc->pixbuf)
        gdk_pixbuf_unref (etc->pixbuf);
    if (etc->text)
        g_free (etc->text);
    
    (*parent_class->destroy)(object);
}
 

static void
etc_set_arg (GtkObject *o, GtkArg *arg, guint arg_id)
{
    ETableCol *etc = E_TABLE_COL (o);
    
    switch (arg_id){
    case ARG_SORTABLE:
        etc->sortable = GTK_VALUE_BOOL(*arg);
        break;
    case ARG_COMPARE_COL:
        etc->compare_col = GTK_VALUE_INT(*arg);
        break;
    }
}

static void
etc_get_arg (GtkObject *o, GtkArg *arg, guint arg_id)
{
    ETableCol *etc = E_TABLE_COL (o);
    
    switch (arg_id){
    case ARG_SORTABLE:
        GTK_VALUE_BOOL(*arg) = etc->sortable;
        break;
    case ARG_COMPARE_COL:
        GTK_VALUE_INT(*arg) = etc->compare_col;
        break;
    default:
        arg->type = GTK_TYPE_INVALID;
        break;
    }
}
     
static void
e_table_col_class_init (GtkObjectClass *object_class)
{
    parent_class = gtk_type_class (PARENT_TYPE);
    object_class->destroy = etc_destroy;
    object_class->get_arg = etc_get_arg;
    object_class->set_arg = etc_set_arg;

    gtk_object_add_arg_type ("ETableCol::sortable",
                 GTK_TYPE_BOOL, GTK_ARG_READWRITE, ARG_SORTABLE);  
    gtk_object_add_arg_type ("ETableCol::compare_col",
                 GTK_TYPE_INT, GTK_ARG_READWRITE, ARG_COMPARE_COL);
}

static void
e_table_col_init (ETableCol *etc)
{
    etc->width = 0;
    etc->sortable = 1;
    etc->groupable = 1;
    etc->justification = GTK_JUSTIFY_LEFT;
    etc->priority = 0;
}

E_MAKE_TYPE(e_table_col, "ETableCol", ETableCol, e_table_col_class_init, e_table_col_init, PARENT_TYPE)

/** 
 * e_table_col_new:
 * @col_idx: the column we represent in the model
 * @text: a title for this column
 * @expansion: FIXME
 * @min_width: minimum width in pixels for this column
 * @ecell: the renderer to be used for this column
 * @compare: comparision function for the elements stored in this column
 * @resizable: whether the column can be resized interactively by the user
 * @priority: FIXME
 *
 * The ETableCol represents a column to be used inside an ETable.  The
 * ETableCol objects are inserted inside an ETableHeader (which is just a collection
 * of ETableCols).  The ETableHeader is the definition of the order in which
 * columns are shown to the user. 
 *
 * The @text argument is the the text that will be shown as a header to the
 * user. @col_idx reflects where the data for this ETableCol object will
 * be fetch from an ETableModel.  So even if the user changes the order
 * of the columns being viewed (the ETableCols in the ETableHeader), the
 * column will always point to the same column inside the ETableModel.
 *
 * The @ecell argument is an ECell object that needs to know how to render the
 * data in the ETableModel for this specific row. 
 *
 * Returns: the newly created ETableCol object.
 */
ETableCol *
e_table_col_new (int col_idx, const char *text, double expansion, int min_width,
         ECell *ecell, GCompareFunc compare, gboolean resizable, gboolean disabled, int priority)
{
    ETableCol *etc;
    
    g_return_val_if_fail (expansion >= 0, NULL);
    g_return_val_if_fail (min_width >= 0, NULL);
    g_return_val_if_fail (ecell != NULL, NULL);
    g_return_val_if_fail (compare != NULL, NULL);
    g_return_val_if_fail (text != NULL, NULL);

    etc = gtk_type_new (E_TABLE_COL_TYPE);
       
    etc->is_pixbuf = FALSE;

    etc->col_idx = col_idx;
    etc->compare_col = col_idx;
    etc->text = g_strdup (text);
    etc->pixbuf = NULL;
    etc->expansion = expansion;
    etc->min_width = min_width;
    etc->ecell = ecell;
    etc->compare = compare;
    etc->disabled = disabled;
    etc->priority = priority;

    etc->selected = 0;
    etc->resizable = resizable;

    gtk_object_ref (GTK_OBJECT(etc->ecell));

    return etc;
}

/** 
 * e_table_col_new_with_pixbuf:
 * @col_idx: the column we represent in the model
 * @pixbuf: the image to be used for the header
 * @expansion: FIXME
 * @min_width: minimum width in pixels for this column
 * @ecell: the renderer to be used for this column
 * @compare: comparision function for the elements stored in this column
 * @resizable: whether the column can be resized interactively by the user
 *
 * The ETableCol represents a column to be used inside an ETable.  The
 * ETableCol objects are inserted inside an ETableHeader (which is just a collection
 * of ETableCols).  The ETableHeader is the definition of the order in which
 * columns are shown to the user. 
 *
 * The @text argument is the the text that will be shown as a header to the
 * user. @col_idx reflects where the data for this ETableCol object will
 * be fetch from an ETableModel.  So even if the user changes the order
 * of the columns being viewed (the ETableCols in the ETableHeader), the
 * column will always point to the same column inside the ETableModel.
 *
 * The @ecell argument is an ECell object that needs to know how to render the
 * data in the ETableModel for this specific row. 
 *
 * Returns: the newly created ETableCol object.
 */
ETableCol *
e_table_col_new_with_pixbuf (int col_idx, const char *text, GdkPixbuf *pixbuf, double expansion, int min_width,
                 ECell *ecell, GCompareFunc compare, gboolean resizable, gboolean disabled, int priority)
{
    ETableCol *etc;
    
    g_return_val_if_fail (expansion >= 0, NULL);
    g_return_val_if_fail (min_width >= 0, NULL);
    g_return_val_if_fail (ecell != NULL, NULL);
    g_return_val_if_fail (compare != NULL, NULL);
    g_return_val_if_fail (pixbuf != NULL, NULL);

    etc = gtk_type_new (E_TABLE_COL_TYPE);

    etc->is_pixbuf = TRUE;

    etc->col_idx = col_idx;
    etc->compare_col = col_idx;
    etc->text = g_strdup(text);
    etc->pixbuf = pixbuf;
    etc->expansion = expansion;
    etc->min_width = min_width;
    etc->ecell = ecell;
    etc->compare = compare;
    etc->disabled = disabled;
    etc->priority = priority;

    etc->selected = 0;
    etc->resizable = resizable;

    gtk_object_ref (GTK_OBJECT(etc->ecell));
    gdk_pixbuf_ref (etc->pixbuf);

    return etc;
}