From 8701883e54d4e7e842d4cb27c17019c03cd33f55 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Mon, 15 Sep 2008 11:10:51 +0000 Subject: Doxygen documentation WP9 Done. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6251 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Input.H | 209 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 209 insertions(+) (limited to 'FL/Fl_Input.H') diff --git a/FL/Fl_Input.H b/FL/Fl_Input.H index 8e3560a5d..97fa4cc19 100644 --- a/FL/Fl_Input.H +++ b/FL/Fl_Input.H @@ -30,6 +30,215 @@ #include "Fl_Input_.H" +/** + This is the FLTK text input widget. It displays a single line + of text and lets the user edit it. Normally it is drawn with an + inset box and a white background. The text may contain any + characters (even 0), and will correctly display anything, using + ^X notation for unprintable control characters and \nnn notation + for unprintable characters with the high bit set. It assumes the + font can draw any characters in the ISO-8859-1 character set.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Mouse button 1Moves the cursor to + this point. Drag selects characters. Double click selects words. + Triple click selects all text. Shift+click extends the selection. + When you select text it is automatically copied to the clipboard. +
Mouse button 2Insert the clipboard at + the point clicked. You can also select a region and replace it with the + clipboard by selecting the region with mouse button 2. +
Mouse button 3Currently acts like button 1.
BackspaceDeletes one character to the left, or + deletes the selected region.
EnterMay cause the callback, see when().
^A or HomeGo to start of line.
^B or LeftMove left
^CCopy the selection to the clipboard
^D or DeleteDeletes one character to the right + or deletes the selected region.
^E or EndGo to the end of line.
^F or RightMove right
^KDelete to the end of line (next \n character) + or deletes a single \n character. These deletions are all concatenated + into the clipboard.
^N or DownMove down (for Fl_Multiline_Input + only, otherwise it moves to the next input field).
^P or UpMove up (for Fl_Multiline_Input only, + otherwise it moves to the previous input field).
^UDelete everything.
^V or ^YPaste the clipboard
^X or ^WCopy the region to the clipboard and + delete it.
^Z or ^_Undo. This is a single-level undo + mechanism, but all adjacent deletions and insertions are concatenated + into a single "undo". Often this will undo a lot more than you + expected.
Shift+moveMove the cursor but also extend the + selection.
RightCtrl or +
Compose		Start + a compose-character + sequence. The next one or two keys typed define the character to + insert (see table that follows.) + +

For instance, to type "á" type [compose][a]['] or [compose]['][a]. + +

The character "nbsp" (non-breaking space) is typed by using + [compose][space]. + +

The single-character sequences may be followed by a space if + necessary to remove ambiguity. For instance, if you really want to + type "ª~" rather than "ã" you must type [compose][a][space][~]. + +

The same key may be used to "quote" control characters into the + text. If you need a ^Q character you can get one by typing + [compose][Control+Q]. + +

X may have a key on the keyboard + defined as XK_Multi_key. If so this key may be used as well + as the right-hand control key. You can set this up with the program + xmodmap. + +

If your keyboard is set to support a foreign language you should + also be able to type "dead key" prefix characters. On X you will + actually be able to see what dead key you typed, and if you then move + the cursor without completing the sequence the accent will remain + inserted.

+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Character Composition Table
KeysCharKeysCharKeysCharKeysCharKeysCharKeysChar
spnbsp*°` AÀD -Ð` aàd -ð
!¡+ -±' AÁ~ NÑ' aá~ nñ
%¢2²A ^Â` OÒ^ aâ` oò
#£3³~ AÃ' OÓ~ aã' oó
$¤'´: AÄ^ OÔ: aä^ oô
y =¥uµ* AÅ~ OÕ* aå~ oõ
|¦pA EÆ: OÖa eæ: oö
&§.·, CÇx×, cç- :÷
:¨,¸E `ÈO /Ø` eèo /ø
c©1¹' EÉ` UÙ' eé` uù
aªoº^ EÊ' UÚ^ eê' uú
< <«> >»: EË^ UÛ: eë^ uû
~¬1 4¼` IÌ: UÜ` iì: uü
-­1 2½' IÍ' YÝ' ií' yý
r®3 4¾^ IÎT HÞ^ iît hþ
_¯?¿: IÏs sß: iï: yÿ
+*/ class FL_EXPORT Fl_Input : public Fl_Input_ { int handle_key(); int shift_position(int p); -- cgit v1.2.3