docs/reference/glk-line-input.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 ]>
   5 <refentry id="chimara-Line-Input">
   6 <refmeta>
   7 <refentrytitle>Line Input</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>CHIMARA Library</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>Line Input</refname>
  13 <refpurpose>Reading lines of text</refpurpose>
  14 </refnamediv>
  15 <refsect1>
  16 <title>Description</title>
  17 <para>
  18 You can request that the player enter a line of text. See <link linkend="chimara-Line-Input-Events">Line Input Events</link>.
  19 </para>
  20 <para>
  21 This text will be placed in a buffer of your choice. There is no length field or null terminator in the buffer. (The length of the text is returned as part of the line-input event.)
  22 </para>
  23 <para>
  24 If you use the basic text API, the buffer will contain only printable Latin-1 characters (32 to 126, 160 to 255).
  25 </para>
  26 <para>
  27 A particular implementation of Glk may not be able to accept all Latin-1 printable characters as input. It is guaranteed to be able to accept the ASCII characters (32 to 126.)
  28 </para>
  29 <para>
  30 You can test for this by using the #gestalt_LineInput selector.
  31 </para>
  32 </refsect1>
  33 </refentry>