================================
Type deai.plugin.xorg:Connection
================================

.. lua:module:: deai.plugin.xorg.Connection

See :lua:meth:`xorg.connect <xorg.connect>`, :lua:meth:`xorg.connect_to <xorg.connect_to>` for more information about this type

Properties
==========

.. list-table::
   :header-rows: 0

   * - :lua:attr:`key <key>`
     - Key bindings
   * - :lua:attr:`keymap <keymap>`
     - Keyboard mapping
   * - :lua:attr:`randr <randr>`
     - RandR extension
   * - :lua:attr:`screen <screen>`
     - Information about the current screen
   * - :lua:attr:`xinput <xinput>`
     - XInput extension
   * - :lua:attr:`xrdb <xrdb>`
     - The X resource database (xrdb)

.. lua:attribute:: key: Key

   :type: :lua:mod:`Key <deai.plugin.xorg.Key>`

   Key bindings 

   Manage keyboard short cuts.

.. lua:attribute:: keymap: object

   :type: object

   Keyboard mapping 

   This is a write-only property which allows you to change your keyboard
   mapping. To set your keymap, you need to provide an object with these members:

   - layout (mandatory): The layout, e.g. 'us', 'gb', etc.
   - model (optional)
   - variant (optional)
   - options (optional)

.. lua:attribute:: randr: RandrExt

   :type: :lua:mod:`RandrExt <deai.plugin.xorg.RandrExt>`

   RandR extension 

.. lua:attribute:: screen: Screen

   :type: :lua:mod:`Screen <deai.plugin.xorg.Screen>`

   Information about the current screen 

.. lua:attribute:: xinput: XiExt

   :type: :lua:mod:`XiExt <deai.plugin.xorg.XiExt>`

   XInput extension 

.. lua:attribute:: xrdb: string

   :type: string

   The X resource database (xrdb) 

   This property corresponds to the xrdb, which is usually set with the command
   line tool with the same name. Assigning to this property updates the xrdb.

Methods
==========

.. list-table::
   :header-rows: 0

   * - :lua:meth:`disconnect() <disconnect>`
     - Disconnect from the X server

.. lua:method:: disconnect() -> void

   :rtype: void

   Disconnect from the X server 

   Disconnecting from the X server will stop all related event sources. All objects
   coming from this connection will stop generating any events after this.
   You should stop using the Connection object after you have called disconnect.