aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/misc/e-file-activity.h
blob: acd144dec06b34516e2a0635a9796a113dfbc80d (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
/*
 * e-file-activity.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/>  
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef E_FILE_ACTIVITY_H
#define E_FILE_ACTIVITY_H

#include <gio/gio.h>
#include <widgets/misc/e-activity.h>

/* Standard GObject macros */
#define E_TYPE_FILE_ACTIVITY \
    (e_file_activity_get_type ())
#define E_FILE_ACTIVITY(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_FILE_ACTIVITY, EFileActivity))
#define E_FILE_ACTIVITY_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_FILE_ACTIVITY, EFileActivityClass))
#define E_IS_FILE_ACTIVITY(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_FILE_ACTIVITY))
#define E_IS_FILE_ACTIVITY_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_FILE_ACTIVITY))
#define E_FILE_ACTIVITY_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_FILE_ACTIVITY, EFileActivityClass))

G_BEGIN_DECLS

typedef struct _EFileActivity EFileActivity;
typedef struct _EFileActivityClass EFileActivityClass;
typedef struct _EFileActivityPrivate EFileActivityPrivate;

struct _EFileActivity {
    EActivity parent;
    EFileActivityPrivate *priv;
};

struct _EFileActivityClass {
    EActivityClass parent_class;
};

GType       e_file_activity_get_type    (void);
EActivity * e_file_activity_new     (const gchar *primary_text);
EActivity * e_file_activity_newv        (const gchar *format,
                         ...) G_GNUC_PRINTF (1, 2);
GCancellable *  e_file_activity_get_cancellable (EFileActivity *file_activity);
void        e_file_activity_set_cancellable (EFileActivity *file_activity,
                         GCancellable *cancellable);
GFile *     e_file_activity_get_file    (EFileActivity *file_activity);
void        e_file_activity_set_file    (EFileActivity *file_activity,
                         GFile *file);
GAsyncResult *  e_file_activity_get_result  (EFileActivity *file_activity);
void        e_file_activity_set_result  (EFileActivity *file_activity,
                         GAsyncResult *result);

/* This can be used as a GFileProgressCallback. */
void        e_file_activity_progress    (goffset current_num_bytes,
                         goffset total_num_bytes,
                         gpointer activity);

G_END_DECLS

#endif /* E_FILE_ACTIVITY_H */