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