From e2c31f916967229b6547e68013628ce0082cf875 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Tue, 2 Jun 2009 13:29:59 +0200 Subject: Add gio.FilterInputStream docs --- docs/reference/pygio-classes.xml | 1 + docs/reference/pygio-filterinputstream.xml | 152 +++++++++++++++++++++++++++++ 2 files changed, 153 insertions(+) create mode 100644 docs/reference/pygio-filterinputstream.xml (limited to 'docs/reference') diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index 5c7f9df..eada7c6 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -22,6 +22,7 @@ + diff --git a/docs/reference/pygio-filterinputstream.xml b/docs/reference/pygio-filterinputstream.xml new file mode 100644 index 0000000..e6fb90b --- /dev/null +++ b/docs/reference/pygio-filterinputstream.xml @@ -0,0 +1,152 @@ + + + + + + gio.FilterInputStream + Filter Input Stream + + + + Synopsis + + + gio.FilterInputStream + gio.InputStream + + + get_base_stream + + + + get_close_base_stream + + + + set_close_base_stream + close_base + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.InputStream + +-- gio.FilterInputStream + + + + + + gio.FilterInputStream Properties + +
+ + + + + + + + "base-stream" + Read - Write - Construct only + The underlying base stream on which the io ops will be done. + + + "close-base-stream" + Read - Write - Construct only + If the base stream should be closed when the filter stream is closed. + Default value: True. + + + + +
+ + + + + Description + + + Filter Input Stream. + + + + + Methods + + + gio.FilterInputStream.get_base_stream + + + get_base_stream + + + + + + Returns : + A + gio.InputStream + + + + + + The get_base_stream() method gets the base + stream for the filter stream. + + + + + gio.FilterInputStream.get_close_base_stream + + + get_close_base_stream + + + + + + Returns : + True if the base stream + will be closed. + + + + + + The get_close_base_stream() method returns + whether the base stream will be closed when stream is closed. + + + + + gio.FilterInputStream.set_close_base_stream + + + set_close_base_stream + close_base + + + + + close_base : + True to close the base stream. + + + + + + The set_close_base_stream() method sets whether + the base stream will be closed when stream is closed. + + + + -- cgit