Usage
-----
require "serialize" -- needed to serialize table to string
-- plugin ID needed to call this plugin
ScrollingPlugin = "a160a0dc029b28fc970a935d"
-- example sizes (pixels)
width = 500
height = 300
-- changes scroll window width and height (default 400 x 200)
CallPlugin (ScrollingPlugin, "SetSize" , width, height)
-- set the window title (if an empty string, no title is shown)
CallPlugin (ScrollingPlugin, "SetTitle", "Example title")
-- example table of lines
lines = { }
for i = 1, 300 do
table.insert (lines, string.format ("Line %03i ", i))
end -- for
-- sets the window text (a table of lines)
CallPlugin (ScrollingPlugin, "SetText", serialize.save_simple (lines))
-- add a new line to the end of the table of lines
-- if "wrap" is true then long lines are split at the closest space at
-- the RH side of the window (possibly inserting multiple lines) otherwise
-- the line is inserted "as is" possibly truncating it
CallPlugin (ScrollingPlugin, "AddLine", "New line", wrap)
-- remove "count" lines from the start of the table of lines
CallPlugin (ScrollingPlugin, "RemoveLines", count)
-- find number of lines in the lines table
rc, count = CallPlugin (ScrollingPlugin, "GetLineCount")
-- sets the text colour (RGB values)
CallPlugin (ScrollingPlugin, "SetTextColour", foreground, background)
-- sets the title bar colour (RGB values)
CallPlugin (ScrollingPlugin, "SetTitleColour", foreground, background)
-- show the window
CallPlugin (ScrollingPlugin, "Show")
-- hide the window
CallPlugin (ScrollingPlugin, "Hide")
-- set the scroll position
CallPlugin (ScrollingPlugin, "SetScrollPosition", position)
-- get the scroll position
rc, pos = CallPlugin (ScrollingPlugin, "GetScrollPosition")
-- sets the window font (default 9 point Lucida Console)
CallPlugin (ScrollingPlugin, "SetFont", size, name)
-- sets whether to use Unicode or not (default false)
CallPlugin (ScrollingPlugin, "Unicode", true)
-- RH-click on the window to get a "Copy" and "Font" menu