.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.PCXHandler:

==========================================================================================================================================
|phoenix_title|  **wx.PCXHandler**
==========================================================================================================================================

This is the image handler for the ``PCX`` format. 
         








         



.. seealso:: :ref:`wx.Image`, :ref:`wx.ImageHandler`, `wx.InitAllImageHandlers`         







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>PCXHandler</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.PCXHandler_inheritance.svg" alt="Inheritance diagram of PCXHandler" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.PCXHandler.html" title="This is the image handler for the ``PCX`` format." alt="" coords="10,159,154,188"/> <area shape="rect" id="node2" href="wx.ImageHandler.html" title="This is the base class for implementing image file loading/saving, and image creation from data." alt="" coords="5,82,159,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="33,5,132,34"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.PCXHandler.__init__`                                                  Default constructor for :ref:`wx.PCXHandler`.
:meth:`~wx.PCXHandler.DoCanRead`                                                 Called to test if this handler can read an image from the given stream.
:meth:`~wx.PCXHandler.LoadFile`                                                  Loads an image from a stream, putting the resulting data into `image`.
:meth:`~wx.PCXHandler.SaveFile`                                                  Saves an image in the output stream.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.PCXHandler(ImageHandler)

   **Possible constructors**::

       PCXHandler() -> None
       
   
   This is the image handler for the ``PCX`` format.



   .. method:: __init__(self)

      Default constructor for :ref:`wx.PCXHandler`. 
                 

      :rtype: `None`     








   .. method:: DoCanRead(self, stream : InputStream)

      Called to test if this handler can read an image from the given stream. 
                 

      ``NOTE``: this function is allowed to change the current stream position since CallDoCanRead() will take care of restoring it later 
                 


      :param `stream`: 
      :type `stream`: wx.InputStream




      :rtype: `bool`








   .. method:: LoadFile(self, image : Image, stream : InputStream, verbose: bool=True, index: int=-1)

      Loads an image from a stream, putting the resulting data into `image`. 
                 

      If the image file contains more than one image and the image handler is capable of retrieving these individually, `index`  indicates which image to read from the stream. 




      :param `image`: The image object which is to be affected by this operation.   
      :type `image`: wx.Image
      :param `stream`: Opened input stream for reading image data.   
      :type `stream`: wx.InputStream
      :param `verbose`: If set to ``True``, errors reported by the image handler will produce LogMessages.   
      :type `verbose`: bool
      :param `index`: The index of the image in the file (starting from zero).  
      :type `index`: int












      :rtype: `bool`




                  



      :returns: 

         ``True`` if the operation succeeded, ``False`` otherwise.  







      .. seealso:: :meth:`wx.Image.LoadFile` , :meth:`wx.Image.SaveFile` , :meth:`SaveFile`     








   .. method:: SaveFile(self, image : Image, stream : OutputStream, verbose: bool=True)

      Saves an image in the output stream. 
                 




      :param `image`: The image object which is to be affected by this operation.   
      :type `image`: wx.Image
      :param `stream`: Opened output stream for writing the data.   
      :type `stream`: wx.OutputStream
      :param `verbose`: If set to ``True``, errors reported by the image handler will produce LogMessages.  
      :type `verbose`: bool










      :rtype: `bool`




                  



      :returns: 

         ``True`` if the operation succeeded, ``False`` otherwise.  







      .. seealso:: :meth:`wx.Image.LoadFile` , :meth:`wx.Image.SaveFile` , :meth:`LoadFile`