aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-tree-table-adapter.h
blob: 29ec1c740edaad7a84d505db23e4b8c3f0ca1bb8 (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
/*
 * 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>
 *      Chris Toshok <toshok@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_TREE_TABLE_ADAPTER_H_
#define _E_TREE_TABLE_ADAPTER_H_

#include <libxml/tree.h>

#include <e-util/e-table-header.h>
#include <e-util/e-table-model.h>
#include <e-util/e-table-sort-info.h>
#include <e-util/e-tree-model.h>

/* Standard GObject macros */
#define E_TYPE_TREE_TABLE_ADAPTER \
    (e_tree_table_adapter_get_type ())
#define E_TREE_TABLE_ADAPTER(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_TREE_TABLE_ADAPTER, ETreeTableAdapter))
#define E_TREE_TABLE_ADAPTER_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_TREE_TABLE_ADAPTER, ETreeTableAdapterClass))
#define E_IS_TREE_TABLE_ADAPTER(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_TREE_TABLE_ADAPTER))
#define E_IS_TREE_TABLE_ADAPTER_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_TREE_TABLE_ADAPTER))
#define E_TREE_TABLE_ADAPTER_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_TREE_TABLE_ADAPTER, ETreeTableAdapterClass))

G_BEGIN_DECLS

typedef struct _ETreeTableAdapter ETreeTableAdapter;
typedef struct _ETreeTableAdapterClass ETreeTableAdapterClass;
typedef struct _ETreeTableAdapterPrivate ETreeTableAdapterPrivate;

struct _ETreeTableAdapter {
    GObject parent;
    ETreeTableAdapterPrivate *priv;
};

struct _ETreeTableAdapterClass {
    GObjectClass parent_class;

    /* Signals */
    gboolean    (*sorting_changed)  (ETreeTableAdapter *etta);
};

GType       e_tree_table_adapter_get_type   (void) G_GNUC_CONST;
ETableModel *   e_tree_table_adapter_new    (ETreeModel *source,
                         ETableSortInfo *sort_info,
                         ETableHeader *header);
ETableModel *   e_tree_table_adapter_construct  (ETreeTableAdapter *ets,
                         ETreeModel *source,
                         ETableSortInfo *sort_info,
                         ETableHeader   *header);

ETreePath   e_tree_table_adapter_node_get_next
                        (ETreeTableAdapter *etta,
                         ETreePath path);
gboolean    e_tree_table_adapter_node_is_expanded
                        (ETreeTableAdapter *etta,
                         ETreePath path);
void        e_tree_table_adapter_node_set_expanded
                        (ETreeTableAdapter *etta,
                         ETreePath path,
                         gboolean expanded);
void        e_tree_table_adapter_node_set_expanded_recurse
                        (ETreeTableAdapter *etta,
                         ETreePath path,
                         gboolean expanded);
void        e_tree_table_adapter_force_expanded_state
                        (ETreeTableAdapter *etta,
                         gint state);
void        e_tree_table_adapter_root_node_set_visible
                        (ETreeTableAdapter *etta,
                         gboolean visible);
ETreePath   e_tree_table_adapter_node_at_row
                        (ETreeTableAdapter *etta,
                         gint row);
gint        e_tree_table_adapter_row_of_node
                        (ETreeTableAdapter *etta,
                         ETreePath path);
gboolean    e_tree_table_adapter_root_node_is_visible
                        (ETreeTableAdapter *etta);

void        e_tree_table_adapter_show_node  (ETreeTableAdapter *etta,
                         ETreePath path);

void        e_tree_table_adapter_save_expanded_state
                        (ETreeTableAdapter *etta,
                         const gchar *filename);
void        e_tree_table_adapter_load_expanded_state
                        (ETreeTableAdapter *etta,
                         const gchar *filename);

xmlDoc *    e_tree_table_adapter_save_expanded_state_xml
                        (ETreeTableAdapter *etta);
void        e_tree_table_adapter_load_expanded_state_xml
                        (ETreeTableAdapter *etta,
                         xmlDoc *doc);

void        e_tree_table_adapter_set_sort_info
                        (ETreeTableAdapter *etta,
                         ETableSortInfo *sort_info);
ETableSortInfo *e_tree_table_adapter_get_sort_info
                         (ETreeTableAdapter *etta);
ETableHeader *  e_tree_table_adapter_get_header  (ETreeTableAdapter *etta);

G_END_DECLS

#endif /* _E_TREE_TABLE_ADAPTER_H_ */