1term::interact::pager(n) Terminal control term::interact::pager(n)
2______________________________________________________________________________
6
8 term::interact::pager - Terminal widget, paging
9
11 package require Tcl 8.4
12 package require term::interact::pager ?0.1?
14 term::interact::pager object text ?options...?
16 object interact
18 object done
20 object clear
22 object text text
24 object configure
26 object configure option
28 object configure option value...
30 object cget option
32______________________________________________________________________________
34
36 This package provides a class for the creation of a simple paging text
37 display.
38
40 The package exports a single command, the class command, enabling the
41 creation of pager instances. Its API is:
42 term::interact::pager object text ?options...?
44 This command creates a new pager object with the name object,
45 initializes it, and returns the fully qualified name of the ob‐
46 ject command as its result.
47 The argument is the text to show, possibly followed by configu‐
49 ration options and their values. The options are explained in
50 the section Configuration.
51
53 The objects created by the class command provide the methods listed be‐
54 low:
55 object interact
57 Show the pager in the screen at the configured location and
58 start interacting with it. This opens its own event loop for the
59 processing of incoming characters. The method returns when the
60 interaction has completed. See section Interaction for a de‐
61 scription of the possible interaction.
62 object done
64 This method can be used by user supplied actions to terminate
65 the interaction with the object.
66 object clear
68 This method can be used by user supplied actions to remove the
69 pager from the terminal.
70 object text text
72 This method can be used to change the text shown by the pager.
73 The pager will reset the dispay to show the first line of the
74 text at the top.
75 object configure
77 object configure option
79 object configure option value...
81 object cget option
83 Standard methods to retrieve and configure the options of the
84 pager.
85
87 A pager instance recognizes the following options:
88 -in chan
90 Specifies the channel to read character sequences from. Defaults
91 to stdin.
92 -out chan
94 Specifies the channel to write the pager contents to. Defaults
95 to stdout.
96 -column int
98 Specifies the column of the terminal where the left margin of
99 the pager display should appear. Defaults to 0, i.e. the left-
100 most column.
101 -line int
103 Specifies the line of the terminal where the top margin of the
104 pager display should appear. Defaults to 0, i.e. the top-most
105 line.
106 -height int
108 Specifies the number of lines of text to show at most in the
109 display. Defaults to 25.
110 -actions dict
112 Specifies a dictionary containing additional actions, using
113 character sequences as keys. Note that these sequences cannot
114 override the hardwired sequences described in section Interac‐
115 tion.
116
118 A pager object recognizes the control sequences listed below and acts
119 as described. The user can supply more control sequences to act on via
120 the configuration, but is not able to overide these defaults.
121 Cursor Up
123 The text is scrolled down a single line, making one more line
124 visible at the top. The pager will not react if the first line
125 of the text is already shown.
126 Cursor Down
128 The text is scrolled up a single line, making one more line vis‐
129 ible at the bottom. The pager will not react if the last line of
130 the text is already shown.
131 Page Up
133 The text is scrolled down a page. The pager will not react if
134 the first line of the text is already shown.
135 Page Down
137 The text is scrolled up a page. The pager will not react if the
138 last line of the text is already shown.
139 Enter/Return
141 The interaction with the object is terminated.
142
144 This document, and the package it describes, will undoubtedly contain
145 bugs and other problems. Please report such in the category term of
146 the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
147 also report any ideas for enhancements you may have for either package
148 and/or documentation.
149 When proposing code changes, please provide unified diffs, i.e the out‐
151 put of diff -u.
152 Note further that attachments are strongly preferred over inlined
154 patches. Attachments can be made by going to the Edit form of the
155 ticket immediately after its creation, and then using the left-most
156 button in the secondary navigation bar.
157
159 control, pager, terminal, text display
160
162 Terminal control
163
165 Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net>
166tcllib 0.1 term::interact::pager(n)