PageRenderTime 40ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 0ms

/fltk/FL/Fl_Input.H

http://luafltk.googlecode.com/
C Header | 264 lines | 16 code | 7 blank | 241 comment | 0 complexity | 4dee7b039ba93227e5fe140d45545d9a MD5 | raw file
Possible License(s): LGPL-2.0, LGPL-3.0, 0BSD 
    

  1. //

    2. 

  2. // "$Id: Fl_Input.H 6699 2009-03-18 22:58:12Z engelsman $"

    3. 

  3. //

    4. 

  4. // Input header file for the Fast Light Tool Kit (FLTK).

    5. 

  5. //

    6. 

  6. // Copyright 1998-2009 by Bill Spitzak and others.

    7. 

  7. //

    8. 

  8. // This library is free software; you can redistribute it and/or

    9. 

  9. // modify it under the terms of the GNU Library General Public

    10. 

  10. // License as published by the Free Software Foundation; either

    11. 

  11. // version 2 of the License, or (at your option) any later version.

    12. 

  12. //

    13. 

  13. // This library is distributed in the hope that it will be useful,

    14. 

  14. // but WITHOUT ANY WARRANTY; without even the implied warranty of

    15. 

  15. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    16. 

  16. // Library General Public License for more details.

    17. 

  17. //

    18. 

  18. // You should have received a copy of the GNU Library General Public

    19. 

  19. // License along with this library; if not, write to the Free Software

    20. 

  20. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307

    21. 

  21. // USA.

    22. 

  22. //

    23. 

  23. // Please report all bugs and problems on the following page:

    24. 

  24. //

    25. 

  25. //     http://www.fltk.org/str.php

    26. 

  26. //

    27. 

  27. 

    28. 

  28. /* \file

    29. 

  29.    Fl_Input widget . */

    30. 

  30. 

    31. 

  31. #ifndef Fl_Input_H

    32. 

  32. #define Fl_Input_H

    33. 

  33. 

    34. 

  34. #include "Fl_Input_.H"

    35. 

  35. 

    36. 

  36. /**

    37. 

  37.   This is the FLTK text input widget. It displays a single line

    38. 

  38.   of text and lets the user edit it. Normally it is drawn with an

    39. 

  39.   inset box and a white background. The text may contain any

    40. 

  40.   characters (even 0), and will correctly display anything, using

    41. 

  41.   ^X notation for unprintable control characters and \\nnn notation

    42. 

  42.   for unprintable characters with the high bit set. It assumes the

    43. 

  43.   font can draw any characters in the ISO-8859-1 character set.</P>

    44. 

  44.   

    45. 

  45.   <CENTER><TABLE border=1 WIDTH=90% summary="Fl_Input keyboard and mouse bindings.">

    46. 

  46.   

    47. 

  47.   <TR><TD WIDTH=200><B>Mouse button 1</B></TD><TD>Moves the cursor to

    48. 

  48.   this point. Drag selects characters.  Double click selects words.

    49. 

  49.   Triple click selects all text.  Shift+click extends the selection.

    50. 

  50.   When you select text it is automatically copied to the clipboard.

    51. 

  51.   </TD></TR>

    52. 

  52.   

    53. 

  53.   <TR><TD><B>Mouse button 2</B></TD><TD>Insert the clipboard at

    54. 

  54.   the point clicked.  You can also select a region and replace it with the

    55. 

  55.   clipboard by selecting the region with mouse button 2.

    56. 

  56.   </TD></TR>

    57. 

  57.   

    58. 

  58.   <TR><TD><B>Mouse button 3</B></TD><TD>Currently acts like button 1.</TD></TR>

    59. 

  59.   

    60. 

  60.   <TR><TD><B>Backspace</B></TD><TD>Deletes one character to the left, or

    61. 

  61.   deletes the selected region.</TD></TR>

    62. 

  62.   <TR><TD><B>Enter</B></TD><TD>May cause the callback, see when().</TD></TR>

    63. 

  63.   <TR><TD><B>^A or Home</B></TD><TD>Go to start of line.</TD></TR>

    64. 

  64.   <TR><TD><B>^B or Left</B></TD><TD>Move left</TD></TR>

    65. 

  65.   <TR><TD><B>^C</B></TD><TD>Copy the selection to the clipboard</TD></TR>

    66. 

  66.   <TR><TD><B>^D or Delete</B></TD><TD>Deletes one character to the right

    67. 

  67.   or deletes the selected region.</TD></TR>

    68. 

  68.   <TR><TD><B>^E or End</B></TD><TD>Go to the end of line.</TD></TR>

    69. 

  69.   <TR><TD><B>^F or Right</B></TD><TD>Move right</TD></TR>

    70. 

  70.   <TR><TD><B>^K</B></TD><TD>Delete to the end of line (next \\n character)

    71. 

  71.   or deletes a single \\n character.  These deletions are all concatenated

    72. 

  72.   into the clipboard.</TD></TR>

    73. 

  73.   <TR><TD><B>^N or Down</B></TD><TD>Move down (for Fl_Multiline_Input

    74. 

  74.   only, otherwise it moves to the next input field).</TD></TR>

    75. 

  75.   <TR><TD><B>^P or Up</B></TD><TD>Move up (for Fl_Multiline_Input only,

    76. 

  76.   otherwise it moves to the previous input field).</TD></TR>

    77. 

  77.   <TR><TD><B>^U</B></TD><TD>Delete everything.</TD></TR>

    78. 

  78.   <TR><TD><B>^V or ^Y</B></TD><TD>Paste the clipboard</TD></TR>

    79. 

  79.   <TR><TD><B>^X or ^W</B></TD><TD>Copy the region to the clipboard and

    80. 

  80.   delete it.</TD></TR>

    81. 

  81.   <TR><TD><B>^Z or ^_</B></TD><TD>Undo.  This is a single-level undo

    82. 

  82.   mechanism, but all adjacent deletions and insertions are concatenated

    83. 

  83.   into a single "undo".  Often this will undo a lot more than you

    84. 

  84.   expected.</TD></TR>

    85. 

  85.   <TR><TD><B>Shift+move</B></TD><TD>Move the cursor but also extend the

    86. 

  86.   selection.</TD></TR>

    87. 

  87.   

    88. 

  88.   <TR><TD><B>RightCtrl or

    89. 

  89.   <BR>Compose</B></TD><TD>

    90. 

  90.   \anchor Fl_Input_Compose_Character

    91. 

  91.   Start a compose-character

    92. 

  92.   sequence.  The next one or two keys typed define the character to

    93. 

  93.   insert (see table that follows.)

    94. 

  94.   

    95. 

  95.   <p>For instance, to type "á" type [compose][a]['] or [compose]['][a].

    96. 

  96.   

    97. 

  97.   <P>The character "nbsp" (non-breaking space) is typed by using

    98. 

  98.   [compose][space].

    99. 

  99.   

    100. 

  100.   <P>The single-character sequences may be followed by a space if

    101. 

  101.   necessary to remove ambiguity.  For instance, if you really want to

    102. 

  102.   type "?~" rather than "?" you must type [compose][a][space][~].

    103. 

  103.   

    104. 

  104.   <p>The same key may be used to "quote" control characters into the

    105. 

  105.   text.  If you need a ^Q character you can get one by typing

    106. 

  106.   [compose][Control+Q].

    107. 

  107.   

    108. 

  108.   <p>X may have a key on the keyboard

    109. 

  109.   defined as XK_Multi_key.  If so this key may be used as well

    110. 

  110.   as the right-hand control key.  You can set this up with the program

    111. 

  111.   xmodmap.

    112. 

  112.   

    113. 

  113.   <p>If your keyboard is set to support a foreign language you should

    114. 

  114.   also be able to type "dead key" prefix characters.  On X you will

    115. 

  115.   actually be able to see what dead key you typed, and if you then move

    116. 

  116.   the cursor without completing the sequence the accent will remain

    117. 

  117.   inserted.</TD></TR>

    118. 

  118.   </TABLE></CENTER>

    119. 

  119.   

    120. 

  120.   <!-- NEW PAGE -->

    121. 

  121.   <center><table border=1 summary="Character Composition Table">

    122. 

  122.   <caption align="top">Character Composition Table</caption>

    123. 

  123.   <tr>

    124. 

  124.   	<th>Keys</th><th>Char</th>

    125. 

  125.   	<th>Keys</th><th>Char</th>

    126. 

  126.   	<th>Keys</th><th>Char</th>

    127. 

  127.   	<th>Keys</th><th>Char</th>

    128. 

  128.   	<th>Keys</th><th>Char</th>

    129. 

  129.   	<th>Keys</th><th>Char</th>

    130. 

  130.   

    131. 

  131.   </tr><tr>

    132. 

  132.   	<td align=center>sp</td><td align=center><small>nbsp</small></td>

    133. 

  133.   	<td align=center>*</td><td align=center>°</td>

    134. 

  134.   	<td align=center>` A</td><td align=center>?</td>

    135. 

  135.   	<td align=center>D -</td><td align=center>?</td>

    136. 

  136.   	<td align=center>` a</td><td align=center>?</td>

    137. 

  137.   	<td align=center>d -</td><td align=center>?</td>

    138. 

  138.   </tr><tr>

    139. 

  139.   	<td align=center>!</td><td align=center>?</td>

    140. 

  140.   	<td align=center>+ -</td><td align=center>?</td>

    141. 

  141.   	<td align=center>' A</td><td align=center>Á</td>

    142. 

  142.   	<td align=center>~ N</td><td align=center>?</td>

    143. 

  143.   	<td align=center>' a</td><td align=center>á</td>

    144. 

  144.   	<td align=center>~ n</td><td align=center>?</td>

    145. 

  145.   </tr><tr>

    146. 

  146.   	<td align=center>%</td><td align=center>?</td>

    147. 

  147.   	<td align=center>2</td><td align=center>?</td>

    148. 

  148.   	<td align=center>A ^</td><td align=center>Â</td>

    149. 

  149.   	<td align=center>` O</td><td align=center>?</td>

    150. 

  150.   	<td align=center>^ a</td><td align=center>â</td>

    151. 

  151.   	<td align=center>` o</td><td align=center>?</td>

    152. 

  152.   </tr><tr>

    153. 

  153.   	<td align=center>#</td><td align=center>?</td>

    154. 

  154.   	<td align=center>3</td><td align=center>?</td>

    155. 

  155.   	<td align=center>~ A</td><td align=center>?</td>

    156. 

  156.   	<td align=center>' O</td><td align=center>Ó</td>

    157. 

  157.   	<td align=center>~ a</td><td align=center>?</td>

    158. 

  158.   	<td align=center>' o</td><td align=center>ó</td>

    159. 

  159.   </tr><tr>

    160. 

  160.   	<td align=center>$</td><td align=center>¤</td>

    161. 

  161.   	<td align=center>'</td><td align=center>´</td>

    162. 

  162.   	<td align=center>: A</td><td align=center>Ä</td>

    163. 

  163.   	<td align=center>^ O</td><td align=center>Ô</td>

    164. 

  164.   	<td align=center>: a</td><td align=center>ä</td>

    165. 

  165.   	<td align=center>^ o</td><td align=center>ô</td>

    166. 

  166.   </tr><tr>

    167. 

  167.   	<td align=center>y =</td><td align=center>?</td>

    168. 

  168.   	<td align=center>u</td><td align=center>?</td>

    169. 

  169.   	<td align=center>* A</td><td align=center>?</td>

    170. 

  170.   	<td align=center>~ O</td><td align=center>?</td>

    171. 

  171.   	<td align=center>* a</td><td align=center>?</td>

    172. 

  172.   	<td align=center>~ o</td><td align=center>?</td>

    173. 

  173.   </tr><tr>

    174. 

  174.   	<td align=center>|</td><td align=center>?</td>

    175. 

  175.   	<td align=center>p</td><td align=center>?</td>

    176. 

  176.   	<td align=center>A E</td><td align=center>?</td>

    177. 

  177.   	<td align=center>: O</td><td align=center>Ö</td>

    178. 

  178.   	<td align=center>a e</td><td align=center>?</td>

    179. 

  179.   	<td align=center>: o</td><td align=center>ö</td>

    180. 

  180.   </tr><tr>

    181. 

  181.   	<td align=center>&</td><td align=center>§</td>

    182. 

  182.   	<td align=center>.</td><td align=center>?</td>

    183. 

  183.   	<td align=center>, C</td><td align=center>Ç</td>

    184. 

  184.   	<td align=center>x</td><td align=center>×</td>

    185. 

  185.   	<td align=center>, c</td><td align=center>ç</td>

    186. 

  186.   	<td align=center>- :</td><td align=center>÷</td>

    187. 

  187.   </tr><tr>

    188. 

  188.   	<td align=center>:</td><td align=center>¨</td>

    189. 

  189.   	<td align=center>,</td><td align=center>¸</td>

    190. 

  190.   	<td align=center>E `</td><td align=center>?</td>

    191. 

  191.   	<td align=center>O /</td><td align=center>?</td>

    192. 

  192.   	<td align=center>` e</td><td align=center>?</td>

    193. 

  193.   	<td align=center>o /</td><td align=center>?</td>

    194. 

  194.   </tr><tr>

    195. 

  195.   	<td align=center>c</td><td align=center>Š</td>

    196. 

  196.   	<td align=center>1</td><td align=center>š</td>

    197. 

  197.   	<td align=center>' E</td><td align=center>É</td>

    198. 

  198.   	<td align=center>` U</td><td align=center>?</td>

    199. 

  199.   	<td align=center>' e</td><td align=center>é</td>

    200. 

  200.   	<td align=center>` u</td><td align=center>?</td>

    201. 

  201.   </tr><tr>

    202. 

  202.   	<td align=center>a</td><td align=center>?</td>

    203. 

  203.   	<td align=center>o</td><td align=center>?</td>

    204. 

  204.   	<td align=center>^ E</td><td align=center>?</td>

    205. 

  205.   	<td align=center>' U</td><td align=center>Ú</td>

    206. 

  206.   	<td align=center>^ e</td><td align=center>?</td>

    207. 

  207.   	<td align=center>' u</td><td align=center>ú</td>

    208. 

  208.   </tr><tr>

    209. 

  209.   	<td align=center>&lt; &lt;</td><td align=center>?</td>

    210. 

  210.   	<td align=center>&gt; &gt;</td><td align=center>?</td>

    211. 

  211.   	<td align=center>: E</td><td align=center>Ë</td>

    212. 

  212.   	<td align=center>^ U</td><td align=center>?</td>

    213. 

  213.   	<td align=center>: e</td><td align=center>ë</td>

    214. 

  214.   	<td align=center>^ u</td><td align=center>?</td>

    215. 

  215.   </tr><tr>

    216. 

  216.   	<td align=center>~</td><td align=center>?</td>

    217. 

  217.   	<td align=center>1 4</td><td align=center>?</td>

    218. 

  218.   	<td align=center>` I</td><td align=center>?</td>

    219. 

  219.   	<td align=center>: U</td><td align=center>Ü</td>

    220. 

  220.   	<td align=center>` i</td><td align=center>?</td>

    221. 

  221.   	<td align=center>: u</td><td align=center>ü</td>

    222. 

  222.   </tr><tr>

    223. 

  223.   	<td align=center>-</td><td align=center>­</td>

    224. 

  224.   	<td align=center>1 2</td><td align=center>?</td>

    225. 

  225.   	<td align=center>' I</td><td align=center>Í</td>

    226. 

  226.   	<td align=center>' Y</td><td align=center>Ý</td>

    227. 

  227.   	<td align=center>' i</td><td align=center>í</td>

    228. 

  228.   	<td align=center>' y</td><td align=center>ý</td>

    229. 

  229.   </tr><tr>

    230. 

  230.   	<td align=center>r</td><td align=center>Ž</td>

    231. 

  231.   	<td align=center>3 4</td><td align=center>ž</td>

    232. 

  232.   	<td align=center>^ I</td><td align=center>Î</td>

    233. 

  233.   	<td align=center>T H</td><td align=center>?</td>

    234. 

  234.   	<td align=center>^ i</td><td align=center>î</td>

    235. 

  235.   	<td align=center>t h</td><td align=center>?</td>

    236. 

  236.   </tr><tr>

    237. 

  237.   	<td align=center>_</td><td align=center>?</td>

    238. 

  238.   	<td align=center>?</td><td align=center>?</td>

    239. 

  239.   	<td align=center>: I</td><td align=center>?</td>

    240. 

  240.   	<td align=center>s s</td><td align=center>ß</td>

    241. 

  241.   	<td align=center>: i</td><td align=center>?</td>

    242. 

  242.   	<td align=center>: y</td><td align=center>?</td>

    243. 

  243.   </tr>

    244. 

  244.   </table></center>

    245. 

  245. */

    246. 

  246. class FL_EXPORT Fl_Input : public Fl_Input_ {

    247. 

  247.   int handle_key();

    248. 

  248.   int shift_position(int p);

    249. 

  249.   int shift_up_down_position(int p);

    250. 

  250.   void handle_mouse(int keepmark=0);

    251. 

  251. protected:

    252. 

  252.   void draw();

    253. 

  253. public:

    254. 

  254.   int handle(int);

    255. 

  255.   Fl_Input(int,int,int,int,const char * = 0);

    256. 

  256. 

    257. 

  257. DECLARE_CLASS_CHEAP_RTTI_2(Fl_Input, Fl_Input_)

    258. 

  258. };

    259. 

  259. 

    260. 

  260. #endif 

    261. 

  261. 

    262. 

  262. //

    263. 

  263. // End of "$Id: Fl_Input.H 6699 2009-03-18 22:58:12Z engelsman $".

    264. 

  264. //

    265. 

  265.