.. include:: headings.inc

.. module:: lib.langlistctrl

.. currentmodule:: lib.langlistctrl

.. highlight:: python



.. _lib.langlistctrl:

==========================================================================================================================================
|phoenix_title|  **langlistctrl**
==========================================================================================================================================

ListCtrl and functions to display languages and the flags of their countries



|

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

Inheritance diagram for module **langlistctrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.langlistctrl_inheritance.png" alt="Inheritance diagram of langlistctrl" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="ListCtrl.html" title="A list control presents lists in a number of formats: list view, report view, icon view and small icon view." alt="" coords="648,5,720,35"/> <area shape="rect" id="node10" href="lib.langlistctrl.LanguageListCtrl.html" title="wx.ListCtrl derived control that displays languages and flags" alt="" coords="769,5,988,35"/> <area shape="rect" id="node2" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="525,5,600,35"/> <area shape="rect" id="node4" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,5,476,35"/> <area shape="rect" id="node5" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node7" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:func:`~lib.langlistctrl.BuildLanguageCountryMapping`                            Builds a mapping of language ids to LANG_COUNTRY codes
:func:`~lib.langlistctrl.CreateLanguagesResourceLists`                           Returns a tuple of (bitmaps, language descriptions, language ids)
:func:`~lib.langlistctrl.GetLanguageFlag`                                        Returns a bitmap of the flag for the country of the language id
:func:`~lib.langlistctrl.GetWxIdentifierForLanguage`                             Returns the language id as a string
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:ref:`lib.langlistctrl.LanguageListCtrl`                                         wx.ListCtrl derived control that displays languages and flags
================================================================================ ================================================================================


|


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

   lib.langlistctrl.LanguageListCtrl





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

.. function:: BuildLanguageCountryMapping()

   Builds a mapping of language ids to LANG_COUNTRY codes 


.. function:: CreateLanguagesResourceLists(filter=LC_AVAILABLE, only=())

   Returns a tuple of (bitmaps, language descriptions, language ids) 


.. function:: GetLanguageFlag(lang)

   Returns a bitmap of the flag for the country of the language id 


.. function:: GetWxIdentifierForLanguage(lang)

   Returns the language id as a string