Playing around with barf
[rodin/chimara.git] / docs / reference / chimara-sections.txt
1 <SECTION>
2 <FILE>chimara-glk</FILE>
3 <TITLE>ChimaraGlk</TITLE>
4 ChimaraGlk
5 ChimaraError
6 CHIMARA_ERROR
7 chimara_error_quark
8 chimara_glk_new
9 chimara_glk_set_interactive
10 chimara_glk_get_interactive
11 chimara_glk_set_protect
12 chimara_glk_get_protect
13 chimara_glk_set_default_font_description
14 chimara_glk_set_default_font_string
15 chimara_glk_get_default_font_description
16 chimara_glk_set_monospace_font_description
17 chimara_glk_set_monospace_font_string
18 chimara_glk_get_monospace_font_description
19 chimara_glk_set_spacing
20 chimara_glk_get_spacing
21 chimara_glk_run
22 chimara_glk_stop
23 chimara_glk_wait
24 chimara_glk_get_running
25 chimara_glk_feed_char_input
26 chimara_glk_feed_line_input
27 <SUBSECTION Standard>
28 CHIMARA_GLK
29 CHIMARA_IS_GLK
30 CHIMARA_TYPE_GLK
31 chimara_glk_get_type
32 CHIMARA_GLK_CLASS
33 CHIMARA_IS_GLK_CLASS
34 CHIMARA_GLK_GET_CLASS
35 </SECTION>
36
37 <SECTION>
38 <FILE>chimara-if</FILE>
39 ChimaraIFFormat
40 ChimaraIFInterpreter
41 ChimaraIFZmachineVersion
42 <TITLE>ChimaraIF</TITLE>
43 ChimaraIF
44 chimara_if_new
45 chimara_if_set_preferred_interpreter
46 chimara_if_get_preferred_interpreter
47 chimara_if_run_game
48 chimara_if_get_format
49 chimara_if_get_interpreter
50 <SUBSECTION Standard>
51 CHIMARA_IF
52 CHIMARA_IS_IF
53 CHIMARA_TYPE_IF
54 chimara_if_get_type
55 CHIMARA_IF_CLASS
56 CHIMARA_IS_IF_CLASS
57 CHIMARA_IF_GET_CLASS
58 </SECTION>
59
60 <SECTION>
61 <FILE>glk-exiting</FILE>
62 <TITLE>Exiting Your Program</TITLE>
63 glk_exit
64 <SUBSECTION Private>
65 glk_main
66 </SECTION>
67
68 <SECTION>
69 <FILE>glk-interrupt</FILE>
70 <TITLE>The Interrupt Handler</TITLE>
71 glk_set_interrupt_handler
72 </SECTION>
73
74 <SECTION>
75 <FILE>glk-tick</FILE>
76 <TITLE>The Tick Thing</TITLE>
77 glk_tick
78 </SECTION>
79
80 <SECTION>
81 <FILE>glk-types</FILE>
82 <TITLE>Basic Types</TITLE>
83 glui32
84 glsi32
85 </SECTION>
86
87 <SECTION>
88 <FILE>glk-opaque-objects</FILE>
89 <TITLE>Opaque Objects</TITLE>
90 winid_t
91 strid_t
92 frefid_t
93 schanid_t
94 </SECTION>
95
96 <SECTION>
97 <FILE>glk-gestalt</FILE>
98 <TITLE>The Gestalt System</TITLE>
99 glk_gestalt_ext
100 glk_gestalt
101 <SUBSECTION The Version Number>
102 gestalt_Version
103 <SUBSECTION Testing for Unicode Capabilities>
104 gestalt_Unicode
105 GLK_MODULE_UNICODE
106 <SUBSECTION Output>
107 gestalt_CharOutput
108 gestalt_CharOutput_CannotPrint
109 gestalt_CharOutput_ApproxPrint
110 gestalt_CharOutput_ExactPrint
111 <SUBSECTION Line Input>
112 gestalt_LineInput
113 <SUBSECTION Character Input>
114 gestalt_CharInput
115 <SUBSECTION Constants>
116 gestalt_MouseInput
117 gestalt_Timer
118 gestalt_Graphics
119 gestalt_DrawImage
120 gestalt_Sound
121 gestalt_SoundVolume
122 gestalt_SoundNotify
123 gestalt_Hyperlinks
124 gestalt_HyperlinkInput
125 gestalt_SoundMusic
126 gestalt_GraphicsTransparency
127 </SECTION>
128
129 <SECTION>
130 <FILE>glk-character-input</FILE>
131 <TITLE>Character Input</TITLE>
132 keycode_Unknown
133 keycode_Left
134 keycode_Right
135 keycode_Up
136 keycode_Down
137 keycode_Return
138 keycode_Delete
139 keycode_Escape
140 keycode_Tab
141 keycode_PageUp
142 keycode_PageDown
143 keycode_Home
144 keycode_End
145 keycode_Func1
146 keycode_Func2
147 keycode_Func3
148 keycode_Func4
149 keycode_Func5
150 keycode_Func6
151 keycode_Func7
152 keycode_Func8
153 keycode_Func9
154 keycode_Func10
155 keycode_Func11
156 keycode_Func12
157 keycode_MAXVAL
158 </SECTION>
159
160 <SECTION>
161 <FILE>glk-case</FILE>
162 <TITLE>Upper and Lower Case</TITLE>
163 glk_char_to_lower
164 glk_char_to_upper
165 glk_buffer_to_lower_case_uni
166 glk_buffer_to_upper_case_uni
167 glk_buffer_to_title_case_uni
168 </SECTION>
169
170 <SECTION>
171 <FILE>glk-window-opening</FILE>
172 <TITLE>Window Opening, Closing, and Constraints</TITLE>
173 glk_window_open
174 winmethod_Left
175 winmethod_Right
176 winmethod_Above
177 winmethod_Below
178 winmethod_DirMask
179 winmethod_Fixed
180 winmethod_Proportional
181 winmethod_DivisionMask
182 glk_window_close
183 </SECTION>
184
185 <SECTION>
186 <FILE>glk-window-constraints</FILE>
187 <TITLE>Changing Window Constraints</TITLE>
188 glk_window_get_size
189 glk_window_set_arrangement
190 glk_window_get_arrangement
191 </SECTION>
192
193 <SECTION>
194 <FILE>glk-window-types</FILE>
195 <TITLE>The Types of Windows</TITLE>
196 wintype_Blank
197 wintype_Pair
198 wintype_TextBuffer
199 wintype_TextGrid
200 glk_window_move_cursor
201 wintype_Graphics
202 wintype_AllTypes
203 </SECTION>
204
205 <SECTION>
206 <FILE>glk-echo-streams</FILE>
207 <TITLE>Echo Streams</TITLE>
208 glk_window_set_echo_stream
209 glk_window_get_echo_stream
210 </SECTION>
211
212 <SECTION>
213 <FILE>glk-window-other</FILE>
214 <TITLE>Other Window Functions</TITLE>
215 glk_window_iterate
216 glk_window_get_rock
217 glk_window_get_type
218 glk_window_get_parent
219 glk_window_get_sibling
220 glk_window_get_root
221 glk_window_clear
222 glk_window_get_stream
223 glk_set_window
224 </SECTION>
225
226 <SECTION>
227 <FILE>glk-events</FILE>
228 <TITLE>Events</TITLE>
229 glk_select
230 event_t
231 glk_select_poll
232 <SUBSECTION Constants>
233 evtype_None
234 evtype_Timer
235 evtype_CharInput
236 evtype_LineInput
237 evtype_MouseInput
238 evtype_Arrange
239 evtype_Redraw
240 evtype_SoundNotify
241 evtype_Hyperlink
242 </SECTION>
243
244 <SECTION>
245 <FILE>glk-character-input-events</FILE>
246 <TITLE>Character Input Events</TITLE>
247 glk_request_char_event
248 glk_request_char_event_uni
249 glk_cancel_char_event
250 </SECTION>
251
252 <SECTION>
253 <FILE>glk-line-input-events</FILE>
254 <TITLE>Line Input Events</TITLE>
255 glk_request_line_event
256 glk_request_line_event_uni
257 glk_cancel_line_event
258 </SECTION>
259
260 <SECTION>
261 <FILE>glk-mouse-events</FILE>
262 <TITLE>Mouse Input Events</TITLE>
263 glk_request_mouse_event
264 glk_cancel_mouse_event
265 </SECTION>
266
267 <SECTION>
268 <FILE>glk-timer-events</FILE>
269 <TITLE>Timer Events</TITLE>
270 glk_request_timer_events
271 </SECTION>
272
273 <SECTION>
274 <FILE>glk-streams</FILE>
275 <TITLE>Streams</TITLE>
276 glk_stream_set_current
277 glk_stream_get_current
278 <SUBSECTION Constants>
279 filemode_Write
280 filemode_Read
281 filemode_ReadWrite
282 filemode_WriteAppend
283 </SECTION>
284
285 <SECTION>
286 <FILE>glk-print</FILE>
287 <TITLE>How to Print</TITLE>
288 glk_put_char
289 glk_put_string
290 glk_put_buffer
291 glk_put_char_stream
292 glk_put_string_stream
293 glk_put_buffer_stream
294 glk_put_char_uni
295 glk_put_string_uni
296 glk_put_buffer_uni
297 glk_put_char_stream_uni
298 glk_put_string_stream_uni
299 glk_put_buffer_stream_uni
300 </SECTION>
301
302 <SECTION>
303 <FILE>glk-read</FILE>
304 <TITLE>How to Read</TITLE>
305 glk_get_char_stream
306 glk_get_buffer_stream
307 glk_get_line_stream
308 glk_get_char_stream_uni
309 glk_get_buffer_stream_uni
310 glk_get_line_stream_uni
311 </SECTION>
312
313 <SECTION>
314 <FILE>glk-closing-streams</FILE>
315 <TITLE>Closing Streams</TITLE>
316 glk_stream_close
317 stream_result_t
318 </SECTION>
319
320 <SECTION>
321 <FILE>glk-stream-positions</FILE>
322 <TITLE>Stream Positions</TITLE>
323 glk_stream_set_position
324 glk_stream_get_position
325 <SUBSECTION Constants>
326 seekmode_Start
327 seekmode_Current
328 seekmode_End
329 </SECTION>
330
331 <SECTION>
332 <FILE>glk-styles</FILE>
333 <TITLE>Styles</TITLE>
334 glk_set_style
335 glk_set_style_stream
336 <SUBSECTION Constants>
337 style_Normal
338 style_Emphasized
339 style_Preformatted
340 style_Header
341 style_Subheader
342 style_Alert
343 style_Note
344 style_BlockQuote
345 style_Input
346 style_User1
347 style_User2
348 style_NUMSTYLES
349 </SECTION>
350
351 <SECTION>
352 <FILE>glk-stylehints</FILE>
353 <TITLE>Suggesting the Appearance of Styles</TITLE>
354 glk_stylehint_set
355 glk_stylehint_clear
356 <SUBSECTION Constants>
357 stylehint_Indentation
358 stylehint_ParaIndentation
359 stylehint_Justification
360 stylehint_Size
361 stylehint_Weight
362 stylehint_Oblique
363 stylehint_Proportional
364 stylehint_TextColor
365 stylehint_BackColor
366 stylehint_ReverseColor
367 stylehint_NUMHINTS
368 stylehint_just_LeftFlush
369 stylehint_just_LeftRight
370 stylehint_just_Centered
371 stylehint_just_RightFlush
372 </SECTION>
373
374 <SECTION>
375 <FILE>glk-style-measure</FILE>
376 <TITLE>Testing the Appearance of Styles</TITLE>
377 glk_style_distinguish
378 glk_style_measure
379 </SECTION>
380
381 <SECTION>
382 <FILE>glk-stream-types</FILE>
383 <TITLE>The Types of Streams</TITLE>
384 glk_stream_open_memory
385 glk_stream_open_memory_uni
386 glk_stream_open_file
387 glk_stream_open_file_uni
388 </SECTION>
389
390 <SECTION>
391 <FILE>glk-stream-other</FILE>
392 <TITLE>Other Stream Functions</TITLE>
393 glk_stream_iterate
394 glk_stream_get_rock
395 </SECTION>
396
397 <SECTION>
398 <FILE>glk-fileref</FILE>
399 <TITLE>File References</TITLE>
400 fileusage_Data
401 fileusage_SavedGame
402 fileusage_Transcript
403 fileusage_InputRecord
404 fileusage_TypeMask
405 fileusage_TextMode
406 fileusage_BinaryMode
407 </SECTION>
408
409 <SECTION>
410 <FILE>glk-fileref-types</FILE>
411 <TITLE>The Types of File References</TITLE>
412 glk_fileref_create_temp
413 glk_fileref_create_by_prompt
414 glk_fileref_create_by_name
415 glk_fileref_create_from_fileref
416 </SECTION>
417
418 <SECTION>
419 <FILE>glk-fileref-other</FILE>
420 <TITLE>Other File Reference Functions</TITLE>
421 glk_fileref_destroy
422 glk_fileref_iterate
423 glk_fileref_get_rock
424 glk_fileref_delete_file
425 glk_fileref_does_file_exist
426 </SECTION>
427
428 <SECTION>
429 <FILE>glk-image-resources</FILE>
430 <TITLE>Image Resources</TITLE>
431 glk_image_get_info
432 glk_image_draw
433 glk_image_draw_scaled
434 </SECTION>
435
436 <SECTION>
437 <FILE>glk-graphics-windows</FILE>
438 <TITLE>Graphics in Graphics Windows</TITLE>
439 glk_window_set_background_color
440 glk_window_fill_rect
441 glk_window_erase_rect
442 </SECTION>
443
444 <SECTION>
445 <FILE>glk-graphics-text</FILE>
446 <TITLE>Graphics in Text Buffer Windows</TITLE>
447 glk_window_flow_break
448 <SUBSECTION Constants>
449 imagealign_InlineUp
450 imagealign_InlineDown
451 imagealign_InlineCenter
452 imagealign_MarginLeft
453 imagealign_MarginRight
454 </SECTION>
455
456 <SECTION>
457 <FILE>glk-graphics-testing</FILE>
458 <TITLE>Testing for Graphics Capabilities</TITLE>
459 GLK_MODULE_IMAGE
460 </SECTION>
461
462 <SECTION>
463 <FILE>glk-sound-channels</FILE>
464 <TITLE>Creating and Destroying Sound Channels</TITLE>
465 glk_schannel_create
466 glk_schannel_destroy
467 </SECTION>
468
469 <SECTION>
470 <FILE>glk-playing-sounds</FILE>
471 <TITLE>Playing Sounds</TITLE>
472 glk_schannel_play
473 glk_schannel_play_ext
474 glk_schannel_stop
475 glk_schannel_set_volume
476 glk_sound_load_hint
477 </SECTION>
478
479 <SECTION>
480 <FILE>glk-sound-other</FILE>
481 <TITLE>Other Sound Channel Functions</TITLE>
482 glk_schannel_iterate
483 glk_schannel_get_rock
484 </SECTION>
485
486 <SECTION>
487 <FILE>glk-sound-testing</FILE>
488 <TITLE>Testing for Sound Capabilities</TITLE>
489 GLK_MODULE_SOUND
490 </SECTION>
491
492 <SECTION>
493 <FILE>glk-creating-hyperlinks</FILE>
494 <TITLE>Creating Hyperlinks</TITLE>
495 glk_set_hyperlink
496 glk_set_hyperlink_stream
497 </SECTION>
498
499 <SECTION>
500 <FILE>glk-accepting-hyperlinks</FILE>
501 <TITLE>Accepting Hyperlink Events</TITLE>
502 glk_request_hyperlink_event
503 glk_cancel_hyperlink_event
504 </SECTION>
505
506 <SECTION>
507 <FILE>glk-hyperlinks-testing</FILE>
508 <TITLE>Testing for Hyperlink Capabilities</TITLE>
509 GLK_MODULE_HYPERLINKS
510 </SECTION>
511
512 <SECTION>
513 <FILE>dispatch-interrogating</FILE>
514 <TITLE>Interrogating the Interface</TITLE>
515 gidispatch_count_classes
516 gidispatch_count_intconst
517 gidispatch_get_intconst
518 gidispatch_intconst_t
519 gidispatch_count_functions
520 gidispatch_get_function
521 gidispatch_function_t
522 gidispatch_get_function_by_id
523 <SUBSECTION Constants>
524 gidisp_Class_Window
525 gidisp_Class_Stream
526 gidisp_Class_Fileref
527 gidisp_Class_Schannel
528 </SECTION>
529
530 <SECTION>
531 <FILE>dispatch-dispatching</FILE>
532 <TITLE>Dispatching</TITLE>
533 gidispatch_call
534 gluniversal_t
535 </SECTION>
536
537 <SECTION>
538 <FILE>dispatch-prototypes</FILE>
539 <TITLE>Getting Argument Prototypes</TITLE>
540 gidispatch_prototype
541 </SECTION>
542
543 <SECTION>
544 <FILE>dispatch-library-functions</FILE>
545 <TITLE>Functions the Library Must Provide</TITLE>
546 gidispatch_set_object_registry
547 gidispatch_rock_t
548 gidispatch_get_objrock
549 gidispatch_set_retained_registry
550 </SECTION>
551
552 <SECTION>
553 <FILE>blorb-program</FILE>
554 <TITLE>What the Program Does</TITLE>
555 giblorb_set_resource_map
556 giblorb_get_resource_map
557 giblorb_map_t
558 </SECTION>
559
560 <SECTION>
561 <FILE>blorb-layer</FILE>
562 <TITLE>What the Blorb Layer Does</TITLE>
563 giblorb_create_map
564 giblorb_destroy_map
565 giblorb_result_t
566 giblorb_load_chunk_by_type
567 giblorb_load_chunk_by_number
568 giblorb_unload_chunk
569 giblorb_load_resource
570 giblorb_count_resources
571 <SUBSECTION Constants>
572 giblorb_method_DontLoad
573 giblorb_method_Memory
574 giblorb_method_FilePos
575 giblorb_ID_Snd
576 giblorb_ID_Exec
577 giblorb_ID_Pict
578 giblorb_ID_Copyright
579 giblorb_ID_AUTH
580 giblorb_ID_ANNO
581 </SECTION>
582
583 <SECTION>
584 <FILE>blorb-errors</FILE>
585 <TITLE>Blorb Errors</TITLE>
586 giblorb_err_t
587 <SUBSECTION Constants>
588 giblorb_err_None
589 giblorb_err_CompileTime
590 giblorb_err_Alloc
591 giblorb_err_Read
592 giblorb_err_NotAMap
593 giblorb_err_Format
594 giblorb_err_NotFound
595 </SECTION>
596
597 <SECTION>
598 <FILE>glkext-startup</FILE>
599 <TITLE>Startup Code</TITLE>
600 glkunix_argumentlist_t
601 glkunix_startup_t
602 <SUBSECTION Constants>
603 glkunix_arg_NoValue
604 glkunix_arg_ValueFollows
605 glkunix_arg_ValueCanFollow
606 glkunix_arg_NumberValue
607 glkunix_arg_End
608 </SECTION>
609
610 <SECTION>
611 <FILE>glkext-unix</FILE>
612 <TITLE>Unix Extensions</TITLE>
613 glkunix_stream_open_pathname
614 glkunix_set_base_file
615 </SECTION>