File: wx.lib.langlistctrl.LanguageListCtrl.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (137 lines) | stat: -rw-r--r-- 5,836 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
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.langlistctrl

.. highlight:: python



.. _wx.lib.langlistctrl.LanguageListCtrl:

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

:class:`wx.ListCtrl` derived control that displays languages and flags



|

|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>LanguageListCtrl</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.lib.langlistctrl.LanguageListCtrl_inheritance.png" alt="Inheritance diagram of LanguageListCtrl" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="15,5,116,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="67,83,177,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="62,160,183,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="140,5,221,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="78,237,167,267"/> <area shape="rect" id="node8" href="wx.Control.html" title="wx.Control" alt="" coords="79,315,167,344"/> <area shape="rect" id="node6" href="wx.lib.langlistctrl.LanguageListCtrl.html" title="wx.lib.langlistctrl.LanguageListCtrl" alt="" coords="5,469,240,499"/> <area shape="rect" id="node7" href="wx.ListCtrl.html" title="wx.ListCtrl" alt="" coords="79,392,165,421"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`wx.ListCtrl`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.langlistctrl.LanguageListCtrl.__init__`                           Default class constructor.
:meth:`~wx.lib.langlistctrl.LanguageListCtrl.GetLanguage`                        Get the currently selected language in the control.
:meth:`~wx.lib.langlistctrl.LanguageListCtrl.SetLanguage`                        Selects the given language ids item in the control.
:meth:`~wx.lib.langlistctrl.LanguageListCtrl.SetUpFilter`                        Filters the languages displayed in the control.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.lib.langlistctrl.LanguageListCtrl.Language`                           See `GetLanguage` and `SetLanguage`
================================================================================ ================================================================================


|


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


.. class:: LanguageListCtrl(wx.ListCtrl)

   :class:`wx.ListCtrl` derived control that displays languages and flags

   .. method:: __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.LC_REPORT | wx.LC_NO_HEADER | wx.LC_SINGLE_SEL, filter=LC_AVAILABLE, only=(), select=None, name='languagelistctrl')

      Default class constructor.
      
      :param `parent`: Parent window. Must not be ``None``.
      :type `parent`: wx.Window
      :param `id`: Window identifier. The value ``ID_ANY`` indicates a default value.
      :type `id`: int
      :param `pos`: Window position. If ``DefaultPosition`` is specified then a default position is chosen.
      :type `pos`: wx.Point
      :param `size`: Window size. If ``DefaultSize``   is specified then the window is sized appropriately.
      :type `size`: wx.Size
      :param `style`: Window style. See :ref:`wx.ListCtrl`.
      :type `style`: long
      :param `filter`: Filter the list of languages (LC_AVAILABLE, LC_ALL or LC_ONLY)
      :param `only`: a tuple of language ids
      :param `select`: a 'wx.LANGUAGE_*' id to be selected


   .. method:: GetLanguage(self)

      Get the currently selected language in the control.
      
      :returns: The currently selected language


   .. method:: SetLanguage(self, lang)

      Selects the given language ids item in the control.
      
      :param `lang`: a 'wx.LANGUAGE_*' id


   .. method:: SetUpFilter(self, filter=LC_AVAILABLE, only=())

      Filters the languages displayed in the control.
      
      
      :param `filter`: Filter the list of languages (LC_AVAILABLE, LC_ALL or LC_ONLY)
      :param `only`: a tuple of language ids


   .. attribute:: Language

      See `GetLanguage` and `SetLanguage`