==========
ui.colours
==========

.. toctree::
   :hidden:



.. index:: ui.colours
.. module:: ui.colours
   :noindex:

Colour scheme support.


Module Members
==============

| :attr:`~defaultTheme`
| :attr:`~styleNames`
| :attr:`~xterm16colours`
| :attr:`~xterm256colours`


.. index::
   xterm256colours; cstest.ui.colours

.. data:: xterm256colours
   :noindex:

   Definition of all colour names for an xterm with 256 colour support.


.. index::
   xterm16colours; cstest.ui.colours

.. data:: xterm16colours
   :noindex:

   Definition of all colour names for an xterm with 16 colour support.


.. index::
   styleNames; cstest.ui.colours

.. data:: styleNames
   :noindex:

   All the style names that can be configured within a scheme.


.. index::
   defaultTheme; cstest.ui.colours

.. data:: defaultTheme
   :noindex:

   Default colour scheme.

   A scheme defines up to 5 different colour schemes.

       "light256", "dark256"
           Used when the the terminal is known to support 256 colours.
           The ``--dark`` or ``--light`` options control which of the two
           is chosen.

       "light16", "dark16"
           Used when the the terminal is known to support only 16 colours or
           when no corresponding 256 colour scheme is defined.

       "fallback"
           Used when none of the more explicit schemes are appropriate.