From e0648ea435e0b309cdd5bb0ebe56d4534efd26e4 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sun, 24 May 2009 22:18:40 +0200 Subject: Add documentation for the gio.OutputStream class The docs for this class are not completed, missing methods descriptions. The index is complete though, it will be completed once all the classes are in place so we can ship a (almost) complete reference. --- docs/Makefile.am | 2 + docs/reference/pygio-classes.xml | 3 +- docs/reference/pygio-outputstream.xml | 140 ++++++++++++++++++++++++++++++++++ 3 files changed, 144 insertions(+), 1 deletion(-) create mode 100644 docs/reference/pygio-outputstream.xml diff --git a/docs/Makefile.am b/docs/Makefile.am index 62c4dc9..0e31a9a 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -34,6 +34,7 @@ HTML_FILES = \ html/class-gioloadableicon.html \ html/class-giomount.html \ html/class-giomountoperation.html \ + html/class-giooutputstream.html \ html/class-gioseekable.html \ html/class-giosimpleasyncresult.html \ html/class-giothemedicon.html \ @@ -84,6 +85,7 @@ XML_FILES = \ reference/pygio-loadableicon.xml \ reference/pygio-mount.xml \ reference/pygio-mountoperation.xml \ + reference/pygio-outputstream.xml \ reference/pygio-seekable.xml \ reference/pygio-simpleasyncresult.xml \ reference/pygio-themedicon.xml \ diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index cb9b70f..c4869ca 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -4,7 +4,7 @@ -PyGioClass Reference +PyGio Class Reference @@ -25,6 +25,7 @@ + diff --git a/docs/reference/pygio-outputstream.xml b/docs/reference/pygio-outputstream.xml new file mode 100644 index 0000000..00ddf2e --- /dev/null +++ b/docs/reference/pygio-outputstream.xml @@ -0,0 +1,140 @@ + + + + + + gio.OutputStream + Base class for implementing streaming input + + + + Synopsis + + + gio.OutputStream + gobject.GObject + + + clear_pending + + + + close + cancellableNone + + + close_async + callback + io_priorityglib.PRIORITY_DEFAULT + cancellableNone + user_dataNone + + + close_finish + result + + + flush + cancellableNone + + + flush_async + callback + io_priorityglib.PRIORITY_DEFAULT + cancellableNone + user_dataNone + + + flush_finish + result + + + has_pending + + + + is_closed + + + + set_pending + + + + splice + cancellableNone + flagsgio.OUTPUT_STREAM_SPLICE_NONE + + + splice_async + source + callback + flagsgio.OUTPUT_STREAM_SPLICE_NONE + io_priorityglib.PRIORITY_DEFAULT + cancellableNone + user_dataNone + + + splice_finish + result + + + write + buffer + cancellableNone + + + write_async + buffer + callback + io_priorityglib.PRIORITY_DEFAULT + cancellableNone + user_dataNone + + + write_finish + result + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.OutputStream + + + + + + Description + + + gio.OutputStream + has functions to write from a stream ( + gio.OutputStream.write() + ), to close a stream ( + gio.OutputStream.close() + ) and to flush pending writes ( + gio.OutputStream.flush() + ). + + + To copy the content of an input stream to an output stream without manually + handling the reads and writes, use + gio.OutputStream.splice(). + + + All of these functions have async variants too. + + + + + Methods + Unfinished section, you may want to see the relevant C API docs for methods descriptions. + + -- cgit