File: wx.LanguageInfo.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (174 lines) | stat: -rw-r--r-- 6,420 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
.. 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.