aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/gal-view-collection.h
blob: 83678b02d730accb073a06a30e75191c87d2f04e (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
/*
 * gal-view-collection.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 GAL_VIEW_COLLECTION_H
#define GAL_VIEW_COLLECTION_H

#include <e-util/gal-view-factory.h>

/* Standard GObject macros */
#define GAL_TYPE_VIEW_COLLECTION \
    (gal_view_collection_get_type ())
#define GAL_VIEW_COLLECTION(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), GAL_TYPE_VIEW_COLLECTION, GalViewCollection))
#define GAL_VIEW_COLLECTION_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), GAL_TYPE_VIEW_COLLECTION, GalViewCollectionClass))
#define GAL_IS_VIEW_COLLECTION(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), GAL_TYPE_VIEW_COLLECTION))
#define GAL_IS_VIEW_COLLECTION_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), GAL_TYPE_VIEW_COLLECTION))
#define GAL_VIEW_COLLECTION_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), GAL_TYPE_VIEW_COLLECTION, GalViewCollectionClass))

G_BEGIN_DECLS

typedef struct _GalViewCollection GalViewCollection;
typedef struct _GalViewCollectionClass GalViewCollectionClass;

typedef struct _GalViewCollectionItem GalViewCollectionItem;

struct _GalViewCollection {
    GObject parent;

    GalViewCollectionItem **view_data;
    gint view_count;

    GList *factory_list;

    GalViewCollectionItem **removed_view_data;
    gint removed_view_count;

    gboolean loaded;
    gboolean default_view_built_in;

    gchar *system_dir;
    gchar *local_dir;

    gchar *default_view;
};

struct _GalViewCollectionClass {
    GObjectClass parent_class;

    /* Signals */
    void        (*changed)      (GalViewCollection *collection);
};

struct _GalViewCollectionItem {
    GalView *view;
    gchar *id;
    gboolean changed;
    gboolean ever_changed;
    gboolean built_in;
    gchar *filename;
    gchar *title;
    gchar *type;
    GalViewCollection *collection;
    guint view_changed_id;
};

GType       gal_view_collection_get_type    (void) G_GNUC_CONST;
GalViewCollection *
        gal_view_collection_new     (void);
const gchar *   gal_view_collection_get_system_directory
                        (GalViewCollection *collection);

/* Set up the view collection.  Call these two functions
 * before ever doing load or save and never call them again. */
void        gal_view_collection_set_storage_directories
                        (GalViewCollection *collection,
                         const gchar *system_dir,
                         const gchar *local_dir);
void        gal_view_collection_add_factory (GalViewCollection *collection,
                         GalViewFactory *factory);

/* Query the view collection. */
gint        gal_view_collection_get_count   (GalViewCollection *collection);
GalView *   gal_view_collection_get_view    (GalViewCollection *collection,
                         gint n);
GalViewCollectionItem *
        gal_view_collection_get_view_item
                        (GalViewCollection *collection,
                         gint n);
gint        gal_view_collection_get_view_index_by_id
                        (GalViewCollection *collection,
                         const gchar *view_id);

/* Manipulate the view collection */
void        gal_view_collection_delete_view (GalViewCollection *collection,
                         gint i);

/* Call set_storage_directories and add factories for anything
 * that might be found there before doing either of these. */
void        gal_view_collection_load    (GalViewCollection *collection);
void        gal_view_collection_save    (GalViewCollection *collection);
gboolean    gal_view_collection_loaded  (GalViewCollection *collection);

/* Use factory list to load a GalView file. */
GalView *   gal_view_collection_load_view_from_file
                        (GalViewCollection *collection,
                         const gchar *type,
                         const gchar *filename);

/* Returns id of the new view.  These functions are used for
 * GalViewInstanceSaveAsDialog. */
const gchar *   gal_view_collection_append_with_title
                        (GalViewCollection *collection,
                         const gchar *title,
                         GalView *view);
const gchar *   gal_view_collection_set_nth_view
                        (GalViewCollection *collection,
                         gint i,
                         GalView *view);

const gchar *   gal_view_collection_get_default_view
                        (GalViewCollection *collection);

G_END_DECLS

#endif /* GAL_VIEW_COLLECTION_H */