From 0c8e99a2fdc89f3ec72ad13439ed4b6228d6d788 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sun, 8 Mar 2009 22:35:53 +0000 Subject: Complete cancellable docs. 2009-03-08 Gian Mario Tagliaretti * docs/reference/pygio-classes.xml: * docs/reference/pygio-cancellable.xml: Complete cancellable docs. svn path=/trunk/; revision=1024 --- docs/reference/pygio-cancellable.xml | 131 +++++++++++++++++++++++++++++++++++ docs/reference/pygio-classes.xml | 1 + 2 files changed, 132 insertions(+) (limited to 'docs/reference') diff --git a/docs/reference/pygio-cancellable.xml b/docs/reference/pygio-cancellable.xml index d36421c..c35388d 100644 --- a/docs/reference/pygio-cancellable.xml +++ b/docs/reference/pygio-cancellable.xml @@ -50,6 +50,15 @@ + + +Functions + + + gio.cancellable_get_current + + + @@ -155,5 +164,127 @@ on Unix systems. The returned fd will turn readable when cancellable is cancelled. + + + gio.Cancellable.is_cancelled + + + is_cancelled + + + + + + Returns : + True if cancellable is cancelled, + False if called with None or if + item is not cancelled. + + + + + The get_fd() method gets the file descriptor + for a cancellable job. This can be used to implement cancellable operations + on Unix systems. The returned fd will turn readable when cancellable is cancelled. + + + + + gio.Cancellable.pop_current + + + pop_current + + + + + + + + The pop_current() method pops cancellable off + the cancellable stack (verifying that cancellable is on the top of the stack). + + + + + gio.Cancellable.push_current + + + push_current + + + + + + + + The push_current() method pushes cancellable onto + the cancellable stack. The current cancllable can then be recieved using + gio.cancellable_get_current(). + + + + + gio.Cancellable.reset + + + reset + + + + + + + + The reset() method resets cancellable to its uncancelled state. + + + + + gio.Cancellable.set_error_if_cancelled + + + set_error_if_cancelled + + + + + + Returns : + True if cancellable was cancelled, + False if it was not. + + + + + The set_error_if_cancelled() method, if the cancellable + is cancelled, sets the error to notify that the operation was cancelled. + + + + + + Functions + + + gio.cancellable_get_current + + + cancellable_get_current + + + + + + Returns : + A gio.Cancellable + from the top of the stack, or None if the stack is empty. + + + + + The cancellable_get_current() function gets the top cancellable from the stack. + + diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index f4df171..954a1e8 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -8,5 +8,6 @@ + -- cgit