pyanaconda.modules.localization.localization_interface
======================================================

.. py:module:: pyanaconda.modules.localization.localization_interface


Classes
-------

.. autoapisummary::

   pyanaconda.modules.localization.localization_interface.LocalizationInterface


Module Contents
---------------

.. py:class:: LocalizationInterface

   Bases: :py:obj:`pyanaconda.modules.common.base.KickstartModuleInterface`


   DBus interface for Localization module.


   .. py:method:: connect_signals()

      Connect the signals.



   .. py:method:: GetLanguages()

      Get languages with available translations.

      For example: ["en", "cs"]

      :return: a list of language ids



   .. py:method:: GetLanguageData(language_id)

      Get data about the specified language.

      :param: a language id (for example, "en")
      :return: a language data



   .. py:method:: GetLocales(language_id)

      Get locales available for the specified language.

      For example: ["de_DE.UTF-8", "de_AT.UTF-8", ... ]

      :return: a list of locale ids



   .. py:method:: GetCommonLocales()

      Get a list of the most commonly used locales.

      For example: ["ar_EG.UTF-8", "en_US.UTF-8", "en_GB.UTF-8", ...]

      :return: a list of common locale IDs



   .. py:method:: GetLocaleData(locale_id)

      Get data about the specified locale.

      :param: a locale id (for example, "en_US.UTF-8")
      :return: a locale data



   .. py:property:: Language
      :type: Str


      The language the system will use.


   .. py:property:: LanguageSupport
      :type: List[Str]


      Supported languages on the system.


   .. py:property:: LanguageKickstarted
      :type: Bool


      Was the language set in a kickstart?

      :return: True if it was set in a kickstart, otherwise False


   .. py:method:: SetKeyboard(keyboard)

      Set the system keyboard type in generic way.

      Can contain virtual console keyboard mapping or X layout specification.
      This is deprecated way of specifying keyboard, use either
      SetVirtualConsoleKeymap and/or SetXLayouts.

      :param keyboard: system keyboard specification



   .. py:property:: VirtualConsoleKeymap
      :type: Str


      Virtual Console keyboard mapping.


   .. py:property:: XLayouts
      :type: List[Str]


      X Layouts that should be used on the system.


   .. py:property:: LayoutSwitchOptions
      :type: List[Str]


      List of options for layout switching


   .. py:property:: KeyboardKickstarted
      :type: Bool


      Was keyboard command seen in kickstart?

      :return: True if keyboard command was seen in kickstart, otherwise False


   .. py:method:: PopulateMissingKeyboardConfigurationWithTask()

      Pouplate missing keyboard configuration.

      The configuration is populated by conversion and/or default values.

      :return: DBus path of the task populating the configuration



   .. py:method:: ApplyKeyboardWithTask()

      Apply keyboard configuration to the current system.

      :return: DBus path of the task applying the configuration



   .. py:method:: GetCompositorSelectedLayout()

      Get the activated keyboard layout.

      :return: Current keyboard layout (e.g. "cz (qwerty)")
      :rtype: str



   .. py:method:: SetCompositorSelectedLayout(layout_variant)

      Set the activated keyboard layout.

      :param layout_variant: The layout to set, with format "layout (variant)"
          (e.g. "cz (qwerty)")
      :type layout_variant: str
      :return: If the keyboard layout was activated
      :rtype: bool



   .. py:method:: SelectNextCompositorLayout()

      Set the next available layout as active.



   .. py:method:: CompositorSelectedLayoutChanged(layout)

      Signal emitted when the selected keyboard layout changes.



   .. py:method:: GetCompositorLayouts()

      Get all available keyboard layouts.

      :return: A list of keyboard layouts (e.g. ["cz (qwerty)", cn (mon_todo_galik)])
      :rtype: list of strings



   .. py:method:: SetCompositorLayouts(layout_variants, options)

      Set the available keyboard layouts.

      :param layout_variants: A list of keyboard layouts (e.g. ["cz (qwerty)",
          cn (mon_todo_galik)])
      :type layout_variants: list of strings
      :param options: A list of switching options
      :type options: list of strings



   .. py:method:: CompositorLayoutsChanged(layouts)

      Signal emitted when available layouts change.