.. 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

.. module:: wx.lib.langlistctrl

.. currentmodule:: wx.lib.langlistctrl

.. highlight:: python



.. _wx.lib.langlistctrl:

==========================================================================================================================================
|phoenix_title|  **wx.lib.langlistctrl**
==========================================================================================================================================

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


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

================================================================================ ================================================================================
:func:`~wx.lib.langlistctrl.BuildLanguageCountryMapping`                         Builds a mapping of language ids to LANG_COUNTRY codes.
:func:`~wx.lib.langlistctrl.CreateLanguagesResourceLists`                        Create a language resource list
:func:`~wx.lib.langlistctrl.GetLanguageFlag`                                     Create a language resource list
:func:`~wx.lib.langlistctrl.GetWxIdentifierForLanguage`                          Get the wx identifier for a language.
================================================================================ ================================================================================


|


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

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


|


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

   wx.lib.langlistctrl.LanguageListCtrl





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

.. function:: BuildLanguageCountryMapping()

   Builds a mapping of language ids to LANG_COUNTRY codes.
   
   :returns: the mapping as a {langID: countryCode}


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

   Create a language resource list
   
   :param `filter`: Filter the list of languages (LC_AVAILABLE, LC_ALL or LC_ONLY)
   :param `only`: a tuple of language ids
   
   :returns: a tuple of (bitmaps, language descriptions, language ids)


.. function:: GetLanguageFlag(lang)

   Create a language resource list
   
   :param `filter`: Filter the list of languages (LC_AVAILABLE, LC_ALL or LC_ONLY)
   :param `only`: a tuple of language ids
   
   :returns: a tuple of (bitmaps, language descriptions, language ids)


.. function:: GetWxIdentifierForLanguage(lang)

   Get the wx identifier for a language.
   
   :returns: The language id as a string