Implemented garglk_set_program_name(), garglk_set_program_info(), garglk_set_story_name()
[rodin/chimara.git] / docs / reference / dispatch-selectors.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 <!ENTITY selectors SYSTEM "selectors.xml">
5 ]>
6 <refentry id="chimara-Table-of-Selectors">
7 <refmeta>
8 <refentrytitle>Table of Selectors</refentrytitle>
9 <manvolnum>3</manvolnum>
10 <refmiscinfo>CHIMARA Library</refmiscinfo>
11 </refmeta>
12 <refnamediv>
13 <refname>Table of Selectors</refname>
14 <refpurpose>Table of dispatch selectors for Glk functions</refpurpose>
15 </refnamediv>
16 <refsect1>
17 <title>Description</title>
18 <para>
19 These values, and the values used for future Glk calls, are integers in the range <code>0x0001</code> to <code>0xFFFF</code> (1 to 65535). The values are not sequential; they are divided into groups, roughly by category. Zero is not the selector of any
20 Glk call, so it may be used for a null value.
21 </para>
22 &selectors;
23 <para>
24 Note that <function>glk_main()</function> does not have a selector, because it's provided by your program, not the library.
25 </para>
26 <para>
27 There is no way to use these selectors directly in the Glk API.
28 <note><para>
29 An earlier version of Glk had gestalt selectors <code>gestalt_FunctionNameToID</code> and <code>gestalt_FunctionIDToName</code>, but these have been withdrawn.
30 </para></note>
31 They are defined and used only in the dispatch layer.
32 </para>
33 </refsect1>
34 </refentry>