2
* * Copyright (C) 2006-2011 Anders Brander <anders@brander.dk>,
3
* * Anders Kvist <akv@lnxbx.dk> and Klaus Post <klauspost@gmail.com>
5
* This program is free software; you can redistribute it and/or
6
* modify it under the terms of the GNU General Public License
7
* as published by the Free Software Foundation; either version 2
8
* of the License, or (at your option) any later version.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20
#ifndef RS_JOB_QUEUE_H
21
#define RS_JOB_QUEUE_H
23
#include <glib-object.h>
27
#define RS_TYPE_JOB_QUEUE rs_job_queue_get_type()
28
#define RS_JOB_QUEUE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), RS_TYPE_JOB_QUEUE, RSJobQueue))
29
#define RS_JOB_QUEUE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), RS_TYPE_JOB_QUEUE, RSJobQueueClass))
30
#define RS_IS_JOB_QUEUE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), RS_TYPE_JOB_QUEUE))
31
#define RS_IS_JOB_QUEUE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), RS_TYPE_JOB_QUEUE))
32
#define RS_JOB_QUEUE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), RS_TYPE_JOB_QUEUE, RSJobQueueClass))
34
typedef struct _RSJobQueueSlot RSJobQueueSlot;
35
typedef struct _RSJob RSJob;
36
typedef struct _RSJobQueue RSJobQueue;
39
GObjectClass parent_class;
42
typedef gpointer (*RSJobFunc)(RSJobQueueSlot *, gpointer);
44
GType rs_job_queue_get_type(void);
47
* Add a new job to the job queue
48
* @note When func is called, it WILL be from another thread, it may be
49
* required to acquire the GDK lock if any GTK+ stuff is done in the
51
* @param func A function to call for performing the job
52
* @param data Data to pass to func
53
* @param waitable If TRUE, rs_job_queue_wait() will wait until completion
56
rs_job_queue_add_job(RSJobFunc func, gpointer data, gboolean waitable);
59
* Wait (hang) until a job is finished and then free the memory allocated to job
60
* @param job The RSJob to wait for
61
* @return The value returned by the func given to rs_job_queue_add()
64
rs_job_queue_wait(RSJob *job);
67
* Update the job description
68
* @note You should NOT have aquired the GDK thread lock when calling this
70
* @param slot A job_slot as recieved in the job callback function
71
* @param description The new description or NULL to show nothing
74
rs_job_update_description(RSJobQueueSlot *slot, const gchar *description);
77
* Update the job progress bar
78
* @note You should NOT have aquired the GDK thread lock when calling this
80
* @param slot A job_slot as recieved in the job callback function
81
* @param fraction A value between 0.0 and 1.0 to set the progress bar at
82
* the specific fraction or -1.0 to pulse the progress bar.
85
rs_job_update_progress(RSJobQueueSlot *slot, const gdouble fraction);
89
#endif /* RS_JOB_QUEUE_H */