1 /* File : Fl_Input.i */
2 //%module Fl_Input
3 
4 %feature("docstring") ::Fl_Input
5 """
6 This is the FLTK text input widget. It displays a single line of text and
7 lets the user edit it. Normally it is drawn with an inset box and a white
8 background. The text may contain any characters (even 0), and will correctly
9 display anything, using ^X notation for unprintable control characters
10 and \nnn notation for unprintable characters with the high bit set. It
11 assumes the font can draw any characters in the ISO-8859-1 character set.
12 Mouse button 1	Moves the cursor to this point. Drag selects characters.
13 Double click selects words. Triple click selects all text. Shift+click
14 extends the selection. When you select text it is automatically copied
15 to the clipboard.
16 Mouse button 2	Insert the clipboard at the point clicked. You can also
17 select a region and replace it with the clipboard by selecting the region
18 with mouse button 2.
19 Mouse button 3	Currently acts like button 1.
20 Backspace	Deletes one character to the left, or deletes the selected
21 region.
22 Enter	May cause the callback, see when().
23 ^A or Home	Go to start of line.
24 ^B or Left	Move left
25 ^C	Copy the selection to the clipboard
26 ^D or Delete	Deletes one character to the right or deletes the selected
27 region.
28 ^E or End	Go to the end of line.
29 ^F or Right	Move right
30 ^K	Delete to the end of line (next \n character) or deletes a single \n
31 character. These deletions are all concatenated into the clipboard.
32 ^N or Down	Move down (for Fl_Multiline_Input only, otherwise it moves
33 to the next input field).
34 ^P or Up	Move up (for Fl_Multiline_Input only, otherwise it moves to
35 the previous input field).
36 ^U	Delete everything.
37 ^V or ^Y	Paste the clipboard
38 ^X or ^W	Copy the region to the clipboard and delete it.
39 ^Z or ^_	Undo. This is a single-level undo mechanism, but all adjacent
40 deletions and insertions are concatenated into a single 'undo'. Often this
41 will undo a lot more than you expected.
42 Shift+move	Move the cursor but also extend the selection.
43 RightCtrl or
44 Compose	Start a compose-character sequence. The next one or two keys typed
45 define the character to insert (see table that follows.)
46 
47 The character 'nbsp' (non-breaking space) is typed by using [compose][space].
48 
49 The single-character sequences may be followed by a space if necessary to
50 remove ambiguity.
51 
52 The same key may be used to 'quote' control characters into the text. If you
53 need a ^Q character you can get one by typing [compose][Control+Q].
54 
55 X may have a key on the keyboard defined as XK_Multi_key. If so this key
56 may be used as well as the right-hand control key. You can set this up
57 with the program xmodmap.
58 
59 If your keyboard is set to support a foreign language you should also be
60 able to type 'dead key' prefix characters. On X you will actually be able
61 to see what dead key you typed, and if you then move the cursor without
62 completing the sequence the accent will remain inserted.
63 """ ;
64 
65 %{
66 #include "FL/Fl_Input.H"
67 %}
68 
69 %include "macros.i"
70 
71 CHANGE_OWNERSHIP(Fl_Input)
72 
73 %include "FL/Fl_Input.H"
74