![]() |
![]() |
![]() |
OGMJob Reference Manual | ![]() |
---|---|---|---|---|
#include <ogmjob-spawn.h> 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" : Run Last / No Recursion / No Hooks "progress" : Run Last / No Recursion / No Hooks "resume" : Run Last / No Recursion / No Hooks "run" : Run Last / No Recursion / No Hooks "suspend" : Run Last / No Recursion / No Hooks
gint ogmjob_spawn_run (OGMJobSpawn *spawn, GError **error);
Runs a spawn.
spawn : |
An OGMJobSpawn |
error : |
Location for error, or NULL
|
Returns : | An OGMJobResultType |
void ogmjob_spawn_cancel (OGMJobSpawn *spawn);
Cancels a spawn.
spawn : |
An OGMJobSpawn |
void ogmjob_spawn_suspend (OGMJobSpawn *spawn);
Suspends a spawn.
spawn : |
An OGMJobSpawn |
void ogmjob_spawn_resume (OGMJobSpawn *spawn);
Resumes a suspended spawn.
spawn : |
An OGMJobSpawn |
void ogmjob_spawn_set_async (OGMJobSpawn *spawn, gboolean async);
spawn : |
|
async : |
OGMJobSpawn* ogmjob_spawn_get_parent (OGMJobSpawn *spawn);
Returns the parent container of a spawn.
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.
spawn : |
An OGMJobSpawn |
parent : |
The parent container |
void ogmjob_spawn_propagate_error (OGMJobSpawn *spawn, GError *error);
spawn : |
|
error : |
void user_function (OGMJobSpawn *container, gpointer user_data) : Run Last / No Recursion / No Hooks
Emitted each time a spawn has been canceled.
container : |
the spawn that received the signal |
user_data : |
user data set when the signal handler was connected. |
void user_function (OGMJobSpawn *container, gdouble fraction, gpointer user_data) : Run Last / No Recursion / No Hooks
Emitted each time a spawn progresses.
container : |
the spawn that received the signal |
fraction : |
fraction of the task that's been completed |
user_data : |
user data set when the signal handler was connected. |
void user_function (OGMJobSpawn *container, gpointer user_data) : Run Last / No Recursion / No Hooks
Emitted each time a suspended spawn is resumed.
container : |
the spawn that received the signal |
user_data : |
user data set when the signal handler was connected. |
gint user_function (OGMJobSpawn *spawn, gpointer user_data) : Run Last / No Recursion / No Hooks
Emitted each time a spawn is run.
spawn : |
the spawn that received the signal |
user_data : |
user data set when the signal handler was connected. |
Returns : | An OGMJobResultType |
void user_function (OGMJobSpawn *container, gpointer user_data) : Run Last / No Recursion / No Hooks
Emitted each time a spawn is suspended.
container : |
the spawn that received the signal |
user_data : |
user data set when the signal handler was connected. |