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