aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/misc/e-activity.h
blob: aca262172cc756a1ebe3f9afad3025c7783b2335 (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
/*
 * e-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_ACTIVITY_H
#define E_ACTIVITY_H

#include <gtk/gtk.h>

/* Standard GObject macros */
#define E_TYPE_ACTIVITY \
    (e_activity_get_type ())
#define E_ACTIVITY(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_ACTIVITY, EActivity))
#define E_ACTIVITY_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_ACTIVITY, EActivityClass))
#define E_IS_ACTIVITY(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_ACTIVITY))
#define E_IS_ACTIVITY_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_ACTIVITY))
#define E_ACTIVITY_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_ACTIVITY, EActivityClass))

G_BEGIN_DECLS

typedef struct _EActivity EActivity;
typedef struct _EActivityClass EActivityClass;
typedef struct _EActivityPrivate EActivityPrivate;

struct _EActivity {
    GObject parent;
    EActivityPrivate *priv;
};

struct _EActivityClass {
    GObjectClass parent_class;

    /* Signals */
    void        (*cancelled)        (EActivity *activity);
    void        (*completed)        (EActivity *activity);
    void        (*clicked)      (EActivity *activity);
    gchar *     (*describe)     (EActivity *activity);
};

GType       e_activity_get_type     (void);
EActivity * e_activity_new          (const gchar *primary_text);
EActivity * e_activity_newv         (const gchar *format,
                         ...) G_GNUC_PRINTF (1, 2);
void        e_activity_cancel       (EActivity *activity);
void        e_activity_cancel_in_idle   (EActivity *activity);
void        e_activity_complete     (EActivity *activity);
void        e_activity_complete_in_idle (EActivity *activity);
void        e_activity_clicked      (EActivity *activity);
gchar *     e_activity_describe     (EActivity *activity);
gboolean    e_activity_is_cancelled     (EActivity *activity);
gboolean    e_activity_is_completed     (EActivity *activity);
gboolean    e_activity_get_allow_cancel (EActivity *activity);
void        e_activity_set_allow_cancel (EActivity *activity,
                         gboolean allow_cancel);
gboolean    e_activity_get_blocking     (EActivity *activity);
void        e_activity_set_blocking     (EActivity *activity,
                         gboolean blocking);
gboolean    e_activity_get_clickable    (EActivity *activity);
void        e_activity_set_clickable    (EActivity *activity,
                         gboolean clickable);
const gchar *   e_activity_get_icon_name    (EActivity *activity);
void        e_activity_set_icon_name    (EActivity *activity,
                         const gchar *icon_name);
gdouble     e_activity_get_percent      (EActivity *activity);
void        e_activity_set_percent      (EActivity *activity,
                         gdouble percent);
const gchar *   e_activity_get_primary_text (EActivity *activity);
void        e_activity_set_primary_text (EActivity *activity,
                         const gchar *primary_text);
const gchar *   e_activity_get_secondary_text   (EActivity *activity);
void        e_activity_set_secondary_text   (EActivity *activity,
                         const gchar *secondary_text);
void        e_activity_set_error        (EActivity *activity,
                         const GError *error);
gboolean    e_activity_propagate_error  (EActivity *activity,
                         GError **destination);

G_END_DECLS

#endif /* E_ACTIVITY_H */