Lumail - The console email client


Lua primitives: scroll_text_down()

NOTE: Lumail-legacy has been superseded by Lumail 2.x, which has a wholly unified Lua API.

When in text-mode, set with global_mode, the user interface consists of some text set by either show_text() or show_file_contents().

The scroll_text_down() function allows the display to be scrolled down.

For example:

function down()
   m = global_mode()

   if ( string.find( m, "maildir" ) ) then
      scroll_maildir_down( 1 )
   elseif (string.find(m, "index" ) ) then
      scroll_index_down( 1 )
   elseif (string.find(m, 'message') ) then
      scroll_message_down( 1 )
   elseif (string.find(m, 'text') ) then
      scroll_text_down( 1 )
   else
      msg( "down() not implemented for mode:" .. m )
   end
end

--
-- Bind the `down` function to the obvious keys.
--
keymap['global']['j'] = 'down()'
keymap['global']['KEY_DOWN'] = 'down()'

Availability

This function has been available since version 0.25.

See Also

See also scroll_text_to, scroll_text_up, show_file_contents, show_text.