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

==========================================================================================================================================
|phoenix_title|  **wx.LanguageInfo**
==========================================================================================================================================

Encapsulates a :ref:`wx.Language`  identifier together with OS-specific information related to that language.          





|

|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>LanguageInfo</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.LanguageInfo_inheritance.png" alt="Inheritance diagram of LanguageInfo" 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.LanguageInfo.html" title="wx.LanguageInfo" alt="" coords="5,5,139,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.LanguageInfo.GetCanonicalWithRegion`                                  Return the canonical locale name including the region, if known.
:meth:`~wx.LanguageInfo.GetLocaleName`                                           Return the locale name corresponding to this language usable with  ``setlocale()``   on the current system.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.LanguageInfo.CanonicalWithRegion`                                     See :meth:`~wx.LanguageInfo.GetCanonicalWithRegion`
:attr:`~wx.LanguageInfo.LocaleName`                                              See :meth:`~wx.LanguageInfo.GetLocaleName`
:attr:`~wx.LanguageInfo.CanonicalName`                                           A public C++ attribute of type ``string``. Canonical name of the language, e.g.  ``fr_FR`` .                   
:attr:`~wx.LanguageInfo.CanonicalRef`                                            A public C++ attribute of type ``string``. Canonical reference including region.                  
:attr:`~wx.LanguageInfo.Description`                                             A public C++ attribute of type ``string``. Human-readable name of the language in English.                  
:attr:`~wx.LanguageInfo.DescriptionNative`                                       A public C++ attribute of type ``string``. Human-readable name of the language in this language itself.                  
:attr:`~wx.LanguageInfo.Language`                                                A public C++ attribute of type ``int``. :ref:`wx.Language`  id.                  
:attr:`~wx.LanguageInfo.LayoutDirection`                                         A public C++ attribute of type :ref:`~wx.LayoutDirection`. The layout direction used for this language.                  
:attr:`~wx.LanguageInfo.LocaleTag`                                               A public C++ attribute of type ``string``. Tag for locale in ``BCP`` 47-like notation.                  
================================================================================ ================================================================================


|


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


.. class:: wx.LanguageInfo(object)

   Encapsulates a Language identifier together with OS-specific
   information related to that language.



   .. method:: GetCanonicalWithRegion(self)

      Return the canonical locale name including the region, if known.                  

      The value is identical to  ``CanonicalRef`` , if not empty, otherwise it is identical to   ``CanonicalName`` . 

                

      :rtype: `string`







      .. versionadded:: 4.1/wxWidgets-3.1.6  
     








   .. method:: GetLocaleName(self)

      Return the locale name corresponding to this language usable with  ``setlocale()``   on the current system.                   

      If setting locale for this language is not supported, the returned string is empty.                  

      :rtype: `string`








   .. attribute:: CanonicalName

      A public C++ attribute of type ``string``. Canonical name of the language, e.g.  ``fr_FR`` .                   


   .. attribute:: CanonicalRef

      A public C++ attribute of type ``string``. Canonical reference including region.                  


   .. attribute:: CanonicalWithRegion

      See :meth:`~wx.LanguageInfo.GetCanonicalWithRegion`


   .. attribute:: Description

      A public C++ attribute of type ``string``. Human-readable name of the language in English.                  


   .. attribute:: DescriptionNative

      A public C++ attribute of type ``string``. Human-readable name of the language in this language itself.                  


   .. attribute:: Language

      A public C++ attribute of type ``int``. :ref:`wx.Language`  id.                  


   .. attribute:: LayoutDirection

      A public C++ attribute of type :ref:`~wx.LayoutDirection`. The layout direction used for this language.                  


   .. attribute:: LocaleName

      See :meth:`~wx.LanguageInfo.GetLocaleName`


   .. attribute:: LocaleTag

      A public C++ attribute of type ``string``. Tag for locale in ``BCP`` 47-like notation.                  

