Tcl Library Source Code

Documentation
Login
EuroTcl/OpenACS 11 - 12 JULY 2024, VIENNA


[ Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

NAME

term::interact::pager - Terminal widget, paging

Table Of Contents

SYNOPSIS

package require Tcl 8.5 9
package require term::interact::pager ?0.2?

term::interact::pager object text ?options...?
object interact
object done
object clear
object text text
object configure
object configure option
object configure option value...
object cget option

DESCRIPTION

This package provides a class for the creation of a simple paging text display.

Class API

The package exports a single command, the class command, enabling the creation of pager instances. Its API is:

Object API

The objects created by the class command provide the methods listed below:

Configuration

A pager instance recognizes the following options:

Interaction

A pager object recognizes the control sequences listed below and acts as described. The user can supply more control sequences to act on via the configuration, but is not able to overide these defaults.

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category term of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

KEYWORDS

control, pager, terminal, text display

CATEGORY

Terminal control

COPYRIGHT

Copyright © 2006 Andreas Kupries