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

Inheritance diagram for class
LanguageListCtrl:
|
|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`