1SuperText(3) User Contributed Perl Documentation SuperText(3)
2
6 Tk::Text::SuperText - An improved text widget for perl/tk
7
9 $super_text = $paren->SuperText(?options?);
10
12 -background -highlightbackground -insertontime -selectborderwidth
13 -borderwidth -highlightcolor -insertwidth -selectforeground
14 -cursor -highlightthickness -padx -setgrid
15 -exportselection -insertbackground -pady -takefocus
16 -font -insertborderwidth -relief -xscrollcommand
17 -foreground -insertofftime -selectbackground -yscrollcommand
18 -ansicolor
19 See Tk::options for details of the standard options.
21 -height -spacing1 -spacing2 -spacing3
23 -state -tabs -width -wrap
24 See Tk::Text for details of theis options.
26
28 Name: indentMode
29 Class: IndentMode
30 Switch: -indentmode
31 Specifies how to indent when a new line is inserted in the text.
32 The possible modes are none for no indent at all or auto for
33 positioning the insertion cursor right below the first non-white
34 space character of the previous line.
35 Name: undoDepth
37 Class: UndoDepth
38 Switch: -undodepth
39 Sets the maximum depth for the undo buffer:a number specifies the
40 numbers of insert or delete operations that can be stored in the
41 buffer before the oldest one is poped out and forgotten;0 stops the
42 undo feature,undef sets unlimited depth.
43 Name: redoDepth
45 Class: RedoDepth
46 Switch: -redodepth
47 Sets the maximum depth for the redo buffer:a number specifies the
48 numbers of undo operations that can be stored in the buffer before
49 the oldest one is poped out and forgotten;0 stops the redo
50 feature,undef sets unlimited depth.
51 Name: showMatching
53 Class: ShowMatching
54 Switch: -showmatching
55 With a value of 1 activates the matching parentheses feature.0
56 deactivates it.
57 Name: matchHighlightTime
59 Class: MatchHighlightTime
60 Switch: -matchhighlighttime
61 Sets the number of milliseconds the match highlight stays visible;
62 with a value of 0 the highlight stays on till next match.
63 Name: matchForeground
65 Class: MatchForeground
66 Switch: -matchforeground
67 Set the foreground color for the char hilighted by the match-
68 parentheses command.
69 Name: matchBackground
71 Class: MatchBackground
72 Switch: -matchbackground
73 Set the background color for the char hilighted by the match-
74 parentheses command.
75 Name: matchingCouples
77 Class: MatchingCouples
78 Switch: -matchingcouples
79 Sets the chars that are searched for a matching counterpart. The
80 format is a simple string with matching chars coupled in left-right
81 order; here's an example: {}[]()"" . For double couples ("") the
82 match is done only on the forwarding chars.
83 Name: insertMode
85 Class: InsertMode
86 Switch: -insertmode
87 Sets the default insert mode: insert or overwrite .
88 Name: ansiColor
90 Class: AnsiColor
91 Switch: -ansicolor
92 Enables or disables use of Tk-TextANSIColor module (by Tim Jenness
93 <t.jenness@jach.hawaii.edu>). This option was implemented by Jim
94 Turner <turnerjw2@netscape.net> (THANKS for the support!)
95
97 Tk::Text::SuperText implements many new features over the standard
98 Tk::Text widget while supporting all it's standard features.Its used
99 simply as the Tk::Text widget. New Features:
100 · Unlimited undo/redo.
102 So you can undo and redo whatever you deleted/inserted whenever you
104 want. To reset the undo and redo buffers call this method:
105 $w->resetUndo;
106 · Rectangular selections.
108 Rectangular text zones can be selected,copied,deleted,shifted with
110 the mouse or with the keyboard.
111 · Selection right/left char and tab shift.
113 Text selections can be shifted left/right of one or more chars or
115 a tabs.
116 · Normal and 'inline' selection paste.
118 The 'normal' paste is the normal text paste you know :
120 Paste Buffer:
122 line x
123 line y
125 Text Buffer:
127 line 1
128 line2
130 Normal paste at line 1:
132 line x
133 line y
135 line 1
137 line 2
139 The 'inline' paste work as this:
141 Inline paste at line 1:
142 line x line 1
143 line y line 2
145 · Parentheses matching.
147 To help you inspect nested parentheses,brackets and other
149 characters,SuperText has both an automatic parenthesis matching
150 mode,and a find matching command. Automatic parenthesis matching
151 is activated when you type or when you move the insertion cursor
152 after a parenthesis.It momentarily highlightsthe matching character
153 if that character is visible in the window.To find a matching
154 character anywhere in the file,position the cursor after the it,and
155 call the find matching command.
156 · Autoindenting.
158 When you press the Return or Enter key,spaces and tabs are inserted
160 to line up the insert point under the start of the previous line.
161 · Control codes insertion.
163 You can directly insert a non printable control character in the
165 text.
166 · Commands are managed via virtual events.
168 Every SuperText command is binded to a virtual event,so to call it
170 or to bind it to a key sequence use the Tk::event functions. I
171 used this format for key bind so there's no direct key-to-command
172 bind,and this give me more flexibility;however you can use normal
173 binds.
174 Example:
176 $w->eventAdd('Tk::Text::SuperText','<<SelectAll>>','<Control-a>');
177 To set default events bindigs use this methos: $w->bindDefault;
179 · Default key bindings are redefined (not really a feature :).
181 Every virtual event has an associated public method with the same
183 name of the event but with the firts char in lower case (eg:
184 <<MouseSelect>> event has a corresponding $super_text->mouseSelect
185 method).
186 Virtual Event/Command Default Key Binding
188 MouseSetInsert <Button1>
190 MouseSelect <B1-Motion>
191 MouseSelectWord <Double-1>
192 MouseSelectLine <Triple-1>
193 MouseSelectAdd <Shift-1>
194 MouseSelectAddWord <Double-Shift-1>
195 MouseSelectAddLine <Triple-Shift-1>
196 MouseSelectAutoScan <B1-Leave>
197 MouseSelectAutoScanStop <B1-Enter>,<ButtonRelease-1>
198 MouseMoveInsert <Alt-1>
199 MouseRectSelection <Control-B1-Motion>
200 MouseMovePageTo <2> MouseMovePage <B2-Motion>
201 MousePasteSelection <ButtonRelease-2>
202 MoveLeft <Left>
204 SelectLeft <Shift-Left>
205 SelectRectLeft <Shift-Alt-Left>
206 MoveLeftWord <Control-Left>
207 SelectLeftWord <Shift-Control-Left>
208 MoveRight <Right>
209 SelectRight <Shift-Right>
210 SelectRectRight <Shift-Alt-Right>
211 MoveRightWord <Control-Right>
212 SelectRightWord <Shift-Control-Right>
213 MoveUp <Up> SelectUp <Shift-Up>
214 SelectRectUp <Shift-Alt-Up>
215 MoveUpParagraph <Control-Up>
216 SelectUpParagraph <Shift-Control-Up>
217 MoveDown <Down>
218 SelectDown <Shift-Down>
219 SelectRectDown <Shift-Alt-Down>
220 MoveDownParagraph <Control-Down>
221 SelectDownParagraph <Shift-Control-Down>
222 MoveLineStart <Home>
223 SelectToLineStart <Shift-Home>
224 MoveTextStart <Control-Home>
225 SelectToTextStart <Shift-Control-Home>
226 MoveLineEnd <End> SelectToLineEnd <Shift-End>
227 MoveTextEnd <Control-End>
228 SelectToTextEnd <Shift-Control-End>
229 MovePageUp <Prior>
230 SelectToPageUp <Shift-Prior>
231 MovePageLeft <Control-Prior>
232 MovePageDown <Next>
233 SelectToPageDown <Shift-Next>
234 MovePageRight <Control-Next>
235 SetSelectionMark <Control-space>,<Select>
236 SelectToMark <Shift-Control-space>,<Shift-Select>
237 SelectAll <Control-a>
239 SelectionShiftLeft <Control-comma>
240 SelectionShiftLeftTab <Control-Alt-comma>
241 SelectionShiftRight <Control-period>
242 SelectionShiftRightTab <Control-Alt-period>
243 Ins <Insert> Enter <Return>
245 AutoIndentEnter <Control-Return>
246 NoAutoindentEnter <Shift-Return>
247 Del <Delete>
248 BackSpace <BackSpace>
249 DeleteToWordStart <Shift-BackSpace>
250 DeleteToWordEnd <Shift-Delete>
251 DeleteToLineStart <Alt-BackSpace>
252 DeleteToLineEnd <Alt-Delete>
253 DeleteWord <Control-BackSpace>
254 DeleteLine <Control-Delete>
255 InsertControlCode <Control-Escape>
257 FocusNext <Control-Tab>
259 FocusPrev <Shift-Control-Tab>
260 FlashMatchingChar <Control-b>
262 RemoveMatch <Control-B>
263 FindMatchingChar <Control-j>
264 JumpToMatchingChar <Control-J>
265 Escape <Escape>
267 Tab <Tab>
269 LeftTab <Shift-Tab>
271 Copy <Control-c>
273 Cut <Control-x>
275 Paste <Control-v>
277 InlinePaste <Control-V>
279 Undo <Control-z>
281 Redo <Control-Z>
283 Destroy <Destroy>
285 MenuSelect <Alt-KeyPress>
287 · Public methods.
289 $widget->mouseSetInsert
291 $widget->museSelect
293 $widget->mouseSelectWord
295 $widget->mouseSelectLine
297 $widget->mouseSelectAdd
299 $widget->mouseSelectAddWord
301 $widget->mouseSelectAddLine
303 $widget->mouseSelectAutoScan
305 $widget->mouseSelectAutoScanStop
307 $widget->mouseMoveInsert
309 $widget->mouseRectSelection
311 $widget->mouseMovePageTo
313 $widget->mouseMovePage
315 $widget->mousePasteSelection
317 $widget->moveLeft
319 $widget->selectLeft
321 $widget->selectRectLeft
323 $widget->moveLeftWord
325 $widget->selectLeftWord
327 $widget->moveRight
329 $widget->selectRight
331 $widget->selectRectRight
333 $widget->moveRightWord
335 $widget->selectRightWord
337 $widget->moveUp
339 $widget->selectUp
341 $widget->selectRectUp
343 $widget->moveUpParagraph
345 $widget->selectUpParagraph
347 $widget->moveDown
349 $widget->selectDown
351 $widget->selectRectDown
353 $widget->moveDownParagraph
355 $widget->selectDownParagraph
357 $widget->moveLineStart
359 $widget->selectToLineStart
361 $widget->moveTextStart
363 $widget->selectToTextStart
365 $widget->moveLineEnd
367 $widget->selectToLineEnd
369 $widget->moveTextEnd
371 $widget->selectToTextEnd
373 $widget->movePageUp
375 $widget->selectToPageUp
377 $widget->movePageLeft
379 $widget->movePageDown
381 $widget->selectToPageDown
383 $widget->movePageRight
385 $widget->setSelectionMark
387 $widget->selectToMark
389 $widget->selectAll
391 $widget->selectionShiftLeft
393 $widget->selectionShiftLeftTab
395 $widget->selectionShiftRight
397 $widget->selectionShiftRightTab
399 $widget->ins
401 $widget->enter
403 $widget->autoIndentEnter
405 $widget-> noAutoindentEnter
407 $widget->del
409 $widget->backSpace
411 $widget->deleteToWordStart
413 $widget->deleteToWordEnd
415 $widget->deleteToLineStart
417 $widget->deleteToLineEnd
419 $widget->deleteWord
421 $widget->deleteLine
423 $widget->insertControlCode
425 $widget->focusNext
427 $widget->focusPrev
429 $widget->flashMatchingChar
431 $widget->removeMatch
433 $widget->findMatchingChar
435 $widget->jumpToMatchingChar
437 $widget->escape
439 $widget->tab
441 $widget->leftTab
443 $widget->copy
445 $widget->cut
447 $widget->paste
449 $widget->inlinePaste
451 $widget->undo
453 $widget->redo
455 $widget->destroy
457 $widget->menuSelect
459
461 Alessandro Iob <alexiob@dlevel.com>.
462
464 Tk::Text Tk::ROText Tk::TextUndo
465
467 text, widget
468
470 Hey! The above document had some coding errors, which are explained
471 below:
472 Around line 2549:
474 You forgot a '=back' before '=head1'
475perl v5.12.2 2010-11-05 SuperText(3)