| OGMJob Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Signals | ||||
#include <ogmjob-spawn.h> struct OGMJobSpawn; gint ogmjob_spawn_run (OGMJobSpawn *spawn,GError **error); void ogmjob_spawn_cancel (OGMJobSpawn *spawn); void ogmjob_spawn_suspend (OGMJobSpawn *spawn); void ogmjob_spawn_resume (OGMJobSpawn *spawn); void ogmjob_spawn_set_async (OGMJobSpawn *spawn,gboolean async); gboolean ogmjob_spawn_get_async (OGMJobSpawn *spawn); OGMJobSpawn * ogmjob_spawn_get_parent (OGMJobSpawn *spawn); void ogmjob_spawn_set_parent (OGMJobSpawn *spawn,OGMJobSpawn *parent); void ogmjob_spawn_propagate_error (OGMJobSpawn *spawn,GError *error);
"cancel" :No Hooks"progress" :No Hooks"resume" :No Hooks"run" :No Hooks"suspend" :No Hooks
gint ogmjob_spawn_run (OGMJobSpawn *spawn,GError **error);
Runs a spawn.
|
An OGMJobSpawn |
|
Location for error, or NULL
|
Returns : |
An OGMJobResultType |
void ogmjob_spawn_cancel (OGMJobSpawn *spawn);
Cancels a spawn.
|
An OGMJobSpawn |
void ogmjob_spawn_suspend (OGMJobSpawn *spawn);
Suspends a spawn.
|
An OGMJobSpawn |
void ogmjob_spawn_resume (OGMJobSpawn *spawn);
Resumes a suspended spawn.
|
An OGMJobSpawn |
void ogmjob_spawn_set_async (OGMJobSpawn *spawn,gboolean async);
Sets whether to run the spawn asynchronously.
|
An OGMJobSpawn |
|
TRUE if asynchronous |
gboolean ogmjob_spawn_get_async (OGMJobSpawn *spawn);
Gets whether to run the spawn asynchronously.
|
An OGMJobSpawn |
Returns : |
TRUE if asynchronous |
OGMJobSpawn * ogmjob_spawn_get_parent (OGMJobSpawn *spawn);
Returns the parent container of a spawn.
|
An OGMJobSpawn |
Returns : |
An OGMJobSpawn, or NULL |
void ogmjob_spawn_set_parent (OGMJobSpawn *spawn,OGMJobSpawn *parent);
Sets the container as the parent of a widget.
|
An OGMJobSpawn |
|
The parent container |
void ogmjob_spawn_propagate_error (OGMJobSpawn *spawn,GError *error);
Propagates error in spawn.
|
An OGMJobSpawn |
|
An GError |
"cancel" signalvoid user_function (OGMJobSpawn *spawn,
gpointer user_data) : No Hooks
Emitted each time a spawn is canceled.
|
the spawn that received the signal |
|
user data set when the signal handler was connected. |
"progress" signalvoid user_function (OGMJobSpawn *spawn,
gdouble fraction,
gpointer user_data) : No Hooks
Emitted each time a spawn progresses.
|
the spawn that received the signal |
|
fraction of the spawn that's been completed |
|
user data set when the signal handler was connected. |
"resume" signalvoid user_function (OGMJobSpawn *spawn,
gpointer user_data) : No Hooks
Emitted each time a suspended spawn is resumed.
|
the spawn that received the signal |
|
user data set when the signal handler was connected. |
"run" signalgint user_function (OGMJobSpawn *spawn,
gpointer user_data) : No Hooks
Emitted each time a spawn is run.
|
the spawn that received the signal |
|
user data set when the signal handler was connected. |
Returns : |
An OGMJobResultType |
"suspend" signalvoid user_function (OGMJobSpawn *spawn,
gpointer user_data) : No Hooks
Emitted each time a spawn is suspended.
|
the spawn that received the signal |
|
user data set when the signal handler was connected. |