1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
</R>Purpose<!R>
This widget provides a way to view any text file. The text file can contain
Cdk display commands, or be a regular text file.
</R>Construction Options<!R>
A viewer widget is defined using the following syntax. The variable
</B>$viewerObject<!B> contains a reference to the viewer object.
<C></B>$viewerObject = new Cdk::Viewer ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Buttons Required Array Ref This is an array of the button labels.
Height Required Scalar The height of the window.
Width Required Scalar The width of the window.
Xpos Center Scalar This is the position of the window on the X axis.
Ypos Center Scalar This is the position of the window on the Y axis.
Shadow False Scalar This Boolean states whether the dialog box will have a shadow on the box.
</R>Available Methods<!R>
</B>activate<!B>
Activation of an object means to make the object available for use. The
following example demonstrates how to activate a viewer widget.
<C></B>$returnValue = $viewerObject->activate ( options );
</U>Option Default Value Type Purpose<!U>
Title Required Scalar The title of the viewer widget.
Info Required Array Ref The information contained inside the viewer.
Highlight Reverse Scalar The attribute of the currently highlighted button.
Interp True Scalar This is a Boolean flag specifying whether or not the file being
read in should have the contents interpreted for the
Cdk display codes.
Box True Scalar This Boolean states whether the dialog box will have a box drawn around it.
The variable </B>$returnValue<!B> is the numeric value of the button chosen.
The value starts at 0 and goes up.
</B>inject<!B>
This function injects a single character into the widget. The following
examples demonstrates how to call the inject method.
<C></B>$viewerObject->inject ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Shadow Required Scalar The character to inject into the widget.
If you are injecting a special character into the widget, then you can
use a pre-defined value to represent the key.
<C><#UL><#HL(12)><#TT><#HL(15)><#UR>
<C><#VL></U>Key <#VL>Key Value <!U><#VL>
<C><#VL>Left Arrow <#VL>KEY_LEFT <#VL>
<C><#VL>Right Arrow <#VL>KEY_RIGHT <#VL>
<C><#VL>Up Arrow <#VL>KEY_UP <#VL>
<C><#VL>Down Arrow <#VL>KEY_DOWN <#VL>
<C><#VL>Delete <#VL>KEY_DELETE <#VL>
<C><#VL>Backspace <#VL>KEY_BACKSPACE <#VL>
<C><#VL>Page Up <#VL>KEY_PPAGE <#VL>
<C><#VL>Page Down <#VL>KEY_NPAGE <#VL>
<C><#VL>Home <#VL>KEY_HOME <#VL>
<C><#VL>End <#VL>KEY_END <#VL>
<C><#VL>Escape <#VL>KEY_ESC <#VL>
<C><#LL><#HL(12)><#BT><#HL(15)><#LR>
</B>set<!B>
Sets or resets certain attributes or features of the widget. The following
example demonstrates how to call the set method.
<C></B>$viewerObject->set ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Highlight Reverse Scalar The attribute of the currently highlighted button.
Box True Scalar This Boolean states whether the dialog box will have a box drawn around it.
</B>bind<!B>
The bind method binds keys to events. The binding is specific to the individual
objects. The following example demonstrates how to call the bind method.
<C></B>$viewerObject->bind ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Key Required Scalar This is the character to bind the event to.
Function Required Scalar This is the name of the callback function.
</B>draw<!B>
This method draws the object on the screen. The following example demonstrates
how to call the draw method.
<C></B>$viewerObject->draw ( options );
The options are defined in the following table.
</U>Option Default Value Type Purpose<!U>
Box True Scalar Draws the window with a box around it.
</B>erase<!B>
This method removes the object from the screen. This does </B/U>NOT<!B!U>
destroy the object. The following example demonstrates how to call the erase
method.
<C></B>$viewerObject->erase ();
</B>raise<!B>
The raise method raises the widget to the top of the screen. This means if there
were any widgets obscuring part of the view, raising the object would bring the
complete object into view. The following example demonstrates how to call the
raise method.
<C></B>$viewerObject->raise();
</B>lower<!B>
The lower method lowers the object so it doesn't obscure the view of any other
objects. The following example demonstrates how to call the lower method.
<C></B>$viewerObject->lower();
</B>register<!B>
The register method registers the object to the default screen. This does </R>NOT<!R>
have to be called since the objects are registered automatically. This method
should be called if the </B>unregister<!B> method was called. The following
example demonstrates how to call the register method.
<C></B>$viewerObject->register();
</B>unregister<!B>
The unregister method should be called when a widget, which is part of the
default screen, needs to be taken away temporarily. This does not delete or free
the object, it just unmaps it from any future screen refreshes. The object can
be registered by calling the </B>register<!B> method. The following example
demonstrates how to call the unregister method.
<C></B>$viewerObject->unregister();
</B>getwin<!B>
This method returns a pointer to the window of the object. Not much use for this
yet. It will be useful in the future when the drawing methods are added. The
following example demonstrates how to call the getwin method.
<C></B>$viewerObject->getwin();
</R>Default Key Bindings<!R>
</U>Key Action<!U>
Tab Selects the next button.
Up Arrow Moves the cursor to one line up.
Down Arrow Moves the cursor to one line down.
Tab Moves the cursor to one line down.
Right Arrow Scrolls the view one character to the right.
Left Arrow Scrolls the view list one character to the left.
Previous Page Moves one screen backwards.
CTRL-B Moves one screen backwards
Next Page Moves one screen forwards.
Space Moves one screen forwards.
CTRL-F Moves one screen forwards.
g Moves to the top of the viewer.
1 Moves to the top of the viewer.
G Moves to the bottom of the viewer.
End Scrolls complete viewer as far left as possible.
$ Scrolls complete viewer as far left as possible.
Home Scrolls complete viewer as far right as possible.
| Scrolls complete viewer as far right as possible.
L Moves halfway to the bottom of the viewer.
l Moves halfway to the top of the viewer.
? Searches upwards for given text.
/ Searches downwards for given text.
n Performs last search, in the same direction.
: Jumps to a given line.
i Displays information about the current file in viewer.
s Displays information about the current file in viewer.
Return Exits the widget and returns the current selection.
Tab Exits the widget and returns the current selection.
Escape Exits the widget and returns undef.
CTRL-R Refreshes the screen.
</R>Tips & Tricks<!R>
None.
</R>Physical Restrictions<!R>
</U>Restriction Value<!U>
Maximum number of lines. 10000
Maximum number of buttons. 50
</R>Example Use Of The Widget<!R>
<F=../examples/viewer>
<C><#HL(70)>
<C>Document Created: June, 1995
<C>Document Revised: November, 1995
<C>Document Revised: March, 1996
<C>Document Revised: March, 2012
|
