summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authortonycpsu <tonycpsu@gmail.com>2019-04-05 00:22:01 -0400
committerGitHub <noreply@github.com>2019-04-05 00:22:01 -0400
commit28d4bf5ffd6633016ffca47cf66c57e6d618a7e9 (patch)
treebb29684e506a2e06253759534100aa30e561c228 /docs
parent2f3dd6d4c1c11589306c872de5a026479b56b3c0 (diff)
parent29926808ec146b55f688bc260116479f88ab0817 (diff)
downloadurwid-28d4bf5ffd6633016ffca47cf66c57e6d618a7e9.tar.gz
Merge pull request #284 from tonycpsu/24_bit_color
24-bit (true color) support.
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/displayattributes.rst18
-rw-r--r--docs/manual/displaymodules.rst2
-rw-r--r--docs/manual/overview.rst12
3 files changed, 24 insertions, 8 deletions
diff --git a/docs/manual/displayattributes.rst b/docs/manual/displayattributes.rst
index 4f800f6..5a69d6d 100644
--- a/docs/manual/displayattributes.rst
+++ b/docs/manual/displayattributes.rst
@@ -7,7 +7,7 @@
.. currentmodule:: urwid
Urwid supports a number of common display attributes in monochrome, 16-color,
-88-color and 256-color modes.
+88-color, 256-color, and 24-bit (true color) modes.
You are encouraged to provide support for as many of these modes as you like, while
allowing your interface to degrade gracefully by providing command line arguments
@@ -293,6 +293,22 @@ specify bold. To inhibit this you can try setting ``bright_is_bold=False`` with
.. _high-colors:
+.. _24-bit-foreground-background:
+
+24-Bit Foreground and Background Colors
+------------------------------------------
+
+In 24-bit color mode, any hex color code of the form #rrggbb can be used to
+specify a precise RGB value for foreground and background colors. Support for
+24-bit color mode varies widely among terminal programs. Furthermore, terminal
+multiplexers such as tmux and screen can sometimes interfere with the operation
+of 24-bit color mode unless properly configured.
+
+.. seealso::
+ The palette_test.py_ example program
+
+.. _palette_test.py: http://excess.org/urwid/browser/examples/palette_test.py
+
.. _256-foreground-background:
256-Color Foreground and Background Colors
diff --git a/docs/manual/displaymodules.rst b/docs/manual/displaymodules.rst
index eba84c8..e87b8fa 100644
--- a/docs/manual/displaymodules.rst
+++ b/docs/manual/displaymodules.rst
@@ -57,7 +57,7 @@ optimized C code no YES
compatible with any terminal no YES [1]_
UTF-8 support YES YES [2]_
bright foreground without bold YES [3]_ no
-88- or 256-color support YES no
+88-/256-/24-bit color support YES no
mouse dragging support YES no
external event loop support YES no
============================== =========== ==============
diff --git a/docs/manual/overview.rst b/docs/manual/overview.rst
index a9e953b..4fd8d6a 100644
--- a/docs/manual/overview.rst
+++ b/docs/manual/overview.rst
@@ -33,12 +33,12 @@ comes with a configurable :ref:`text layout <text-layout>` that handles the
most of the common alignment and wrapping modes. If you need more flexibility
you can also write your own text layout classes.
-Urwid supports a range of common :ref:`display attributes
-<display-attributes>`, including 256-color foreground and background settings,
-bold, underline and standout settings for displaying text. Not all of these
-are supported by all terminals, so Urwid helps you write applications that
-support different color modes depending on what the user's terminal supports
-and what they choose to enable.
+Urwid supports a range of common :ref:`display attributes <display-attributes>`,
+including 24-bit and 256-color foreground and background settings, bold,
+underline and standout settings for displaying text. Not all of these are
+supported by all terminals, so Urwid helps you write applications that support
+different color modes depending on what the user's terminal supports and what
+they choose to enable.
:class:`ListBox` is one of Urwid's most powerful widgets,
and you may control of the :ref:`listbox contents <listbox-contents>` by using