.. include:: headings.inc

.. module:: lib.imagebrowser

.. currentmodule:: lib.imagebrowser

.. highlight:: python



.. _lib.imagebrowser:

==========================================================================================================================================
|phoenix_title|  **imagebrowser**
==========================================================================================================================================





|

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

Inheritance diagram for module **imagebrowser**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.imagebrowser_inheritance.png" alt="Inheritance diagram of imagebrowser" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="519,58,599,89"/> <area shape="rect" id="node8" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="681,5,825,35"/> <area shape="rect" id="node10" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="717,58,789,89"/> <area shape="rect" id="node18" href="lib.imagebrowser.ImageView.html" title="imagebrowser.ImageView" alt="" coords="649,111,857,142"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="369,58,468,89"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="248,58,320,89"/> <area shape="rect" id="node6" href="lib.imagebrowser.FindFiles.html" title="imagebrowser.FindFiles" alt="" coords="5,5,200,35"/> <area shape="rect" id="node7" href="Dialog.html" title="A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen." alt="" coords="979,5,1051,35"/> <area shape="rect" id="node14" href="lib.imagebrowser.ImageDialog.html" title="imagebrowser.ImageDialog" alt="" coords="1172,5,1391,35"/> <area shape="rect" id="node16" href="lib.imagebrowser.ImagePanel.html" title="imagebrowser.ImagePanel" alt="" coords="908,58,1121,89"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.imagebrowser.ConvertBMP`                                             
:func:`~lib.imagebrowser.GetCheckeredBitmap`                                     Creates a square RGB checkered bitmap using the two specified colors.
:func:`~lib.imagebrowser.GetNamedBitmap`                                         
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.imagebrowser.FindFiles`                                                
:ref:`lib.imagebrowser.ImageDialog`                                              
:ref:`lib.imagebrowser.ImagePanel`                                               
:ref:`lib.imagebrowser.ImageView`                                                
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.imagebrowser.FindFiles
   lib.imagebrowser.ImageDialog
   lib.imagebrowser.ImagePanel
   lib.imagebrowser.ImageView





Functions
------------

.. function:: ConvertBMP(file_nm)


.. function:: GetCheckeredBitmap(blocksize=8,ntiles=4,rgb0='\xFF', rgb1='\xCC')

   Creates a square RGB checkered bitmap using the two specified colors.
   
   Inputs:
   
   - blocksize:  the number of pixels in each solid color square
   - ntiles:  the number of tiles along width and height.  Each tile is 2x2 blocks.
   - rbg0, rgb1:  the first and second colors, as 3-byte strings.
     If only 1 byte is provided, it is treated as a grey value.
   
   The bitmap returned will have width = height = blocksize*ntiles*2


.. function:: GetNamedBitmap(name)