**************
wx.InputStream
**************

Inheritance diagram for `wx.InputStream`:

|

.. inheritance-diagram:: wx.InputStream

|

Description
===========

`wx.InputStream` is an abstract base class which may not be used directly.


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `CanRead <#CanRead>`_ 
* `Eof <#Eof>`_ 
* `GetC <#GetC>`_ 
* `LastRead <#LastRead>`_ 
* `Peek <#Peek>`_ 
* `SeekI <#SeekI>`_ 
* `TellI <#TellI>`_ 
* `Ungetch <#Ungetch>`_ 
* `close <#close>`_ 
* `eof <#eof>`_ 
* `flush <#flush>`_ 
* `read <#read>`_ 
* `readline <#readline>`_ 
* `readlines <#readlines>`_ 
* `seek <#seek>`_ 
* `tell <#tell>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(p)

   Creates a dummy input stream.

   **Parameters:**

   * `p` (PyObject)

   |

   **Returns:**

   `wx.InputStream <wx.InputStream.html>`_
 

--------

.. method:: CanRead()

   Returns ``True`` if some data is available in the stream right now, so that calling `read <#read>`_ wouldn't block.

   |  

   **Returns:**

   `bool` 

--------

.. method:: Eof()

   Returns ``True`` after an attempt has been made to read past the end of the stream.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetC()

   Returns the first character in the input queue and removes it,  blocking until it appears if necessary.

   |  

   **Returns:**

   `string` 

--------

.. method:: LastRead()

   Returns the last number of bytes read.

   |  

   **Returns:**

   `long` 

--------

.. method:: Peek()

   Returns the first character in the input queue without removing it.

   |  

   **Returns:**

   `string` 

--------

.. method:: SeekI(pos, mode=wx.FromStart)

   Changes the stream current position.

   **Parameters:**

   * `pos` (long): Offset to seek to.
   * `mode` (int): One of ``wx.FromStart``, ``wx.FromEnd``, ``wx.FromCurrent``.

   |  

   **Returns:**

   `long` 

--------

.. method:: TellI()

   Returns the current stream position.

   |  

   **Returns:**

   `long` 

--------

.. method:: Ungetch(buffer)

   This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function.

   **Parameters:**

   * `buffer` (string) 

   |  

   **Returns:**

   `long` 

--------

.. method:: close()

   `No docstrings available for this method.` 

--------


.. method:: eof()

   `No docstrings available for this method.` 

--------


.. method:: flush()

   `No docstrings available for this method.` 

--------


.. method:: read(size=-1)

   |
   
   **Parameters:**

   * `size` (int)

   |

   **Returns:**

   `PyObject` 

--------

.. method:: readline(size=-1)

   |
   
   **Parameters:**

   * `size` (int)

   |

   **Returns:**

   `PyObject` 

--------

.. method:: readlines(sizehint=-1)

   |
   
   **Parameters:**

   * `sizehint` (int)

   |

   **Returns:**

   `PyObject` 

--------

.. method:: seek(offset, whence=0)

   |
   
   **Parameters:**

   * `offset` (int)
   * `whence` (int)

--------

.. method:: tell()

   `No docstrings available for this method.`