aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-sorter.h
blob: 45f8c53af1d1732ea1c8344ec2befa3019612f97 (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
/*
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif

#ifndef E_SORTER_H
#define E_SORTER_H

#include <glib-object.h>

/* Standard GObject macros */
#define E_TYPE_SORTER \
    (e_sorter_get_type ())
#define E_SORTER(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_SORTER, ESorter))
#define E_SORTER_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_SORTER, ESorterClass))
#define E_IS_SORTER(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_SORTER))
#define E_IS_SORTER_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_SORTER))
#define E_SORTER_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_SORTER, ESorterClass))

G_BEGIN_DECLS

typedef struct _ESorter ESorter;
typedef struct _ESorterClass ESorterClass;

struct _ESorter {
    GObject parent;
};

struct _ESorterClass {
    GObjectClass parent_class;

    gint        (*model_to_sorted)  (ESorter *sorter,
                         gint row);
    gint        (*sorted_to_model)  (ESorter *sorter,
                         gint row);

    void        (*get_model_to_sorted_array)
                        (ESorter *sorter,
                         gint **array,
                         gint *count);
    void        (*get_sorted_to_model_array)
                        (ESorter *sorter,
                         gint **array,
                         gint *count);

    gboolean    (*needs_sorting)    (ESorter    *sorter);
};

GType       e_sorter_get_type       (void) G_GNUC_CONST;
ESorter *   e_sorter_new            (void);
gint        e_sorter_model_to_sorted    (ESorter *sorter,
                         gint row);
gint        e_sorter_sorted_to_model    (ESorter *sorter,
                         gint row);
void        e_sorter_get_model_to_sorted_array
                        (ESorter *sorter,
                         gint **array,
                         gint *count);
void        e_sorter_get_sorted_to_model_array
                        (ESorter *sorter,
                         gint **array,
                         gint *count);
gboolean    e_sorter_needs_sorting      (ESorter *sorter);

G_END_DECLS

#endif /* E_SORTER_H */