render package:brick
This widget's rendering function
Render a form.
For each form field, each input for the field is rendered using the
implementation provided by its
FormField. The inputs are then
concatenated with the field's concatenation function (see
setFieldConcat) and are then augmented using the form field's
rendering augmentation function (see
@@=). Fields with invalid
inputs (either due to built-in validator failure or due to external
validation failure via
setFieldValid) will be displayed using
the
invalidFormInputAttr attribute.
Finally, all of the resulting field renderings are concatenated with
the form's concatenation function (see
setFormConcat). A
visibility request is also issued for the currently-focused form field
in case the form is rendered within a viewport.
Render a single form field collection. This is called internally by
renderForm but is exposed in cases where a form field state
needs to be rendered outside of a
Form, so
renderForm is
probably what you want.
This function provides a simplified interface to rendering a list of
Widgets as a
Picture outside of the context of an
App. This can be useful in a testing setting but isn't
intended to be used for normal application rendering. The API is
deliberately narrower than the main interactive API and is not yet
stable. Use at your own risk.
Consult the
Vty library documentation for details on how to
output the resulting
Picture.
How to render the body of the scroll bar. This should provide a widget
that expands in whatever direction(s) this renderer will be used for.
So, for example, this widget would need to be one that expands
horizontally such as fill. The same goes for the trough
widget.
How to render the handle that appears at the bottom or right of the
scrollbar. The result will be allowed to be at most one column wide.
How to render the handle that appears at the top or left of the
scrollbar. The result will be allowed to be at most one column wide.
How to render the "trough" of the scroll bar (the area to either side
of the scroll bar body). This should expand as described in the
documentation for the scroll bar field.
How to render the body of the scroll bar. This should provide a widget
that expands in whatever direction(s) this renderer will be used for.
So, for example, this widget would need to be one that expands
vertically such as fill. The same goes for the trough widget.
How to render the handle that appears at the bottom or right of the
scrollbar. The result will be allowed to be at most one row high.
How to render the handle that appears at the top or left of the
scrollbar. The result will be allowed to be at most one row high.
How to render the "trough" of the scroll bar (the area to either side
of the scroll bar body). This should expand as described in the
documentation for the scroll bar field.
Render a dialog with the specified body widget. This renders the
dialog as a layer, which makes this suitable as a top-level layer in
your rendering function to be rendered on top of the rest of your
interface.
Turn an editor state value into a widget. This uses the editor's name
for its scrollable viewport handle and the name is also used to report
mouse events.
Render a file browser. This renders a list of entries in the working
directory, a cursor to select from among the entries, a header
displaying the working directory, and a footer displaying information
about the selected entry.
Note that if the most recent file browser operation produced an
exception in
fileBrowserException, that exception is not
rendered by this function. That exception needs to be rendered (if at
all) by the calling application.
The file browser is greedy in both dimensions.
Render a list using the specified item drawing function.
Evaluates the underlying container up to, and a bit beyond, the
selected element. The exact amount depends on available height for
drawing and
listItemHeight. At most, it will evaluate up to
element
(i + h + 1) where
i is the selected index
and
h is the available height.
Note that this function renders the list with the
listAttr as
the default attribute and then uses
listSelectedAttr as the
default attribute for the selected item if the list is not focused or
listSelectedFocusedAttr otherwise. This is provided as a
convenience so that the item rendering function doesn't have to be
concerned with attributes, but if those attributes are undesirable for
your purposes,
forceAttr can always be used by the item
rendering function to ensure that another attribute is used instead.
Like
renderList, except the render function is also provided
with the index of each element.
Has the same evaluation characteristics as
renderList.
The widths of the table's columns.
The heights of the table's rows.
The table's cells in row-major order.
The type of the rendering monad. This monad is used by the library's
rendering routines to manage rendering state and communicate rendering
parameters to widgets' rendering functions.