Skip to content

Commit

Permalink
ui.* commands, some of them done
Browse files Browse the repository at this point in the history
  • Loading branch information
pyroscope committed Mar 19, 2017
1 parent 243d0f9 commit e4775db
Showing 1 changed file with 90 additions and 1 deletion.
91 changes: 90 additions & 1 deletion docs/include-cmd-ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,96 @@
`ui.*` commands
^^^^^^^^^^^^^^^^^^^^^^^^^^

**TODO**
.. glossary::

ui.current_view
ui.current_view.set

Change or query the current view (querying since ``0.9.7``).

ui.torrent_list.layout
ui.torrent_list.layout.set

Offers a choince between ``full`` and ``compact`` layout (since ``0.9.7``).

ui.unfocus_download

Used before erasing an item, to move the focus away from it.

The following are only available in *rTorrent-PS*:

.. glossary::

ui.bind_key
ui.bind_key.verbose
ui.bind_key.verbose.set

``ui.bind_key = display, key, "command=[...]"`` **rTorrent-PS only**

Binds the given key on a specified display to execute the given command when pressed.
Note that this needs to be called in a one-shot schedule, after *rTorrent* is fully initialized.

``display`` must always be ``download_list``, for the moment.

``key`` can be either a single character for normal keys,
``^`` plus a character for control keys,
or a 4 digit octal code for special keys.

The :term:`ui.bind_key.verbose` flag determines whether replacing an existing binding
is logged (``1``, the default) or not (``0``).

Configuration example:

.. code-block:: ini
# Bind '^' to show the "rtcontrol" result
schedule2 = bind_view_rtcontrol, 1, 0,\
"ui.bind_key = download_list, ^, ui.current_view.set=rtcontrol"
ui.color.alarm[.set]
ui.color.complete[.set]
ui.color.even[.set]
ui.color.focus[.set]
ui.color.footer[.set]
ui.color.incomplete[.set]
ui.color.info[.set]
ui.color.label[.set]
ui.color.leeching[.set]
ui.color.odd[.set]
ui.color.progress0[.set]
ui.color.progress20[.set]
ui.color.progress40[.set]
ui.color.progress60[.set]
ui.color.progress80[.set]
ui.color.progress100[.set]
ui.color.progress120[.set]
ui.color.queued[.set]
ui.color.seeding[.set]
ui.color.stopped[.set]
ui.color.title[.set]

**TODO**

See the `color scheme for 256 xterm colors`_ for an example.

ui.focus.end
ui.focus.home
ui.focus.pgdn
ui.focus.pgup
ui.focus.page_size
ui.focus.page_size.set

**TODO**

ui.style.progress
ui.style.progress.set
ui.style.ratio
ui.style.ratio.set

**TODO**

.. _`color scheme for 256 xterm colors`: https://github.com/pyroscope/pyrocore/blob/master/src/pyrocore/data/config/color-schemes/default-256.rc


.. _view-commands:
Expand Down

0 comments on commit e4775db

Please sign in to comment.