aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-table-sort-info.h
blob: 583feba67a573636984a795eccc64b79727b804a (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
/*
 * e-table-sort-info.h
 *
 * 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/>
 *
 */

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

#ifndef E_TABLE_SORT_INFO_H
#define E_TABLE_SORT_INFO_H

#include <gtk/gtk.h>
#include <libxml/tree.h>

#include <e-util/e-table-column-specification.h>

/* Standard GObject macros */
#define E_TYPE_TABLE_SORT_INFO \
    (e_table_sort_info_get_type ())
#define E_TABLE_SORT_INFO(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_TABLE_SORT_INFO, ETableSortInfo))
#define E_TABLE_SORT_INFO_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_TABLE_SORT_INFO, ETableSortInfoClass))
#define E_IS_TABLE_SORT_INFO(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_TABLE_SORT_INFO))
#define E_IS_TABLE_SORT_INFO_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_TABLE_SORT_INFO))
#define E_TABLE_SORT_INFO_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_TABLE_SORT_INFO, ETableSortInfoClass))

G_BEGIN_DECLS

/* Avoid a circular dependency. */
struct _ETableSpecification;

typedef struct _ETableSortInfo ETableSortInfo;
typedef struct _ETableSortInfoClass ETableSortInfoClass;
typedef struct _ETableSortInfoPrivate ETableSortInfoPrivate;

struct _ETableSortInfo {
    GObject parent;
    ETableSortInfoPrivate *priv;
};

struct _ETableSortInfoClass {
    GObjectClass parent_class;

    /* Signals */
    void        (*sort_info_changed)    (ETableSortInfo *sort_info);
    void        (*group_info_changed)   (ETableSortInfo *sort_info);
};

GType       e_table_sort_info_get_type
                    (void) G_GNUC_CONST;
ETableSortInfo *e_table_sort_info_new   (struct _ETableSpecification *specification);
struct _ETableSpecification *
        e_table_sort_info_ref_specification
                    (ETableSortInfo *sort_info);
gboolean    e_table_sort_info_get_can_group
                    (ETableSortInfo *sort_info);
void        e_table_sort_info_set_can_group
                    (ETableSortInfo *sort_info,
                     gboolean can_group);
guint       e_table_sort_info_grouping_get_count
                    (ETableSortInfo *sort_info);
void        e_table_sort_info_grouping_truncate
                    (ETableSortInfo *sort_info,
                     guint length);
ETableColumnSpecification *
        e_table_sort_info_grouping_get_nth
                    (ETableSortInfo *sort_info,
                     guint n,
                     GtkSortType *out_sort_type);
void        e_table_sort_info_grouping_set_nth
                    (ETableSortInfo *sort_info,
                     guint n,
                     ETableColumnSpecification *spec,
                     GtkSortType sort_type);

guint       e_table_sort_info_sorting_get_count
                    (ETableSortInfo *sort_info);
void        e_table_sort_info_sorting_remove
                    (ETableSortInfo *sort_info,
                     guint n);
void        e_table_sort_info_sorting_truncate
                    (ETableSortInfo *sort_info,
                     guint length);
ETableColumnSpecification *
        e_table_sort_info_sorting_get_nth
                    (ETableSortInfo *sort_info,
                     guint n,
                     GtkSortType *out_sort_type);
void        e_table_sort_info_sorting_set_nth
                    (ETableSortInfo *sort_info,
                     guint n,
                     ETableColumnSpecification *spec,
                     GtkSortType sort_type);
void        e_table_sort_info_load_from_node
                    (ETableSortInfo *sort_info,
                     xmlNode *node,
                     gdouble state_version);
xmlNode *   e_table_sort_info_save_to_node
                    (ETableSortInfo *sort_info,
                     xmlNode *parent);
ETableSortInfo *e_table_sort_info_duplicate
                    (ETableSortInfo *sort_info);

G_END_DECLS

#endif /* E_TABLE_SORT_INFO_H */