.. include:: headings.inc

.. currentmodule:: lib.embeddedimage

.. highlight:: python



.. _lib.embeddedimage.PyEmbeddedImage:

==========================================================================================================================================
|phoenix_title|  **PyEmbeddedImage**
==========================================================================================================================================

PyEmbeddedImage is primarily intended to be used by code generated
by img2py as a means of embedding image data in a python module so
the image can be used at runtime without needing to access the
image from an image file.  This makes distributing icons and such
that an application uses simpler since tools like py2exe will
automatically bundle modules that are imported, and the
application doesn't have to worry about how to locate the image
files on the user's filesystem.

The class can also be used for image data that may be acquired
from some other source at runtime, such as over the network or
from a database.  In this case pass ``False`` for isBase64 (unless the
data actually is base64 encoded.)  Any image type that
wx.ImageFromStream can handle should be okay.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **PyEmbeddedImage**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.embeddedimage.PyEmbeddedImage_inheritance.png" alt="Inheritance diagram of PyEmbeddedImage" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node2" href="lib.embeddedimage.PyEmbeddedImage.html" title="PyEmbeddedImage is primarily intended to be used by code generated" alt="" coords="125,5,416,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~lib.embeddedimage.PyEmbeddedImage.__init__`                              
:meth:`~lib.embeddedimage.PyEmbeddedImage.GetBitmap`                             
:meth:`~lib.embeddedimage.PyEmbeddedImage.GetData`                               
:meth:`~lib.embeddedimage.PyEmbeddedImage.GetIcon`                               
:meth:`~lib.embeddedimage.PyEmbeddedImage.GetImage`                              
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~lib.embeddedimage.PyEmbeddedImage.Bitmap`                                
:attr:`~lib.embeddedimage.PyEmbeddedImage.Icon`                                  
:attr:`~lib.embeddedimage.PyEmbeddedImage.Image`                                 
================================================================================ ================================================================================


|


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

.. class:: PyEmbeddedImage(object)

   PyEmbeddedImage is primarily intended to be used by code generated
   by img2py as a means of embedding image data in a python module so
   the image can be used at runtime without needing to access the
   image from an image file.  This makes distributing icons and such
   that an application uses simpler since tools like py2exe will
   automatically bundle modules that are imported, and the
   application doesn't have to worry about how to locate the image
   files on the user's filesystem.
   
   The class can also be used for image data that may be acquired
   from some other source at runtime, such as over the network or
   from a database.  In this case pass ``False`` for isBase64 (unless the
   data actually is base64 encoded.)  Any image type that
   wx.ImageFromStream can handle should be okay.

   .. method:: __init__(self, data, isBase64=True)


   .. method:: GetBitmap(self)


   .. method:: GetData(self)


   .. method:: GetIcon(self)


   .. method:: GetImage(self)


   .. attribute:: Bitmap

      See :meth:`~PyEmbeddedImage.GetBitmap` 


   .. attribute:: Icon

      See :meth:`~PyEmbeddedImage.GetIcon` 


   .. attribute:: Image

      See :meth:`~PyEmbeddedImage.GetImage`