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 ChimaraResourceLoadFunc
   9 ChimaraResourceType
  10 chimara_glk_new
  11 chimara_glk_set_interactive
  12 chimara_glk_get_interactive
  13 chimara_glk_set_protect
  14 chimara_glk_get_protect
  15 chimara_glk_set_spacing
  16 chimara_glk_get_spacing
  17 chimara_glk_set_css_to_default
  18 chimara_glk_set_css_from_file
  19 chimara_glk_set_css_from_string
  20 chimara_glk_run
  21 chimara_glk_stop
  22 chimara_glk_wait
  23 chimara_glk_get_running
  24 chimara_glk_feed_char_input
  25 chimara_glk_feed_line_input
  26 chimara_glk_set_resource_load_callback
  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 Constants>
 102 gestalt_Version
 103 gestalt_Unicode
 104 GLK_MODULE_UNICODE
 105 gestalt_CharOutput
 106 gestalt_CharOutput_CannotPrint
 107 gestalt_CharOutput_ApproxPrint
 108 gestalt_CharOutput_ExactPrint
 109 gestalt_LineInput
 110 gestalt_CharInput
 111 gestalt_MouseInput
 112 gestalt_Timer
 113 gestalt_Graphics
 114 gestalt_DrawImage
 115 gestalt_Sound
 116 gestalt_SoundVolume
 117 gestalt_SoundNotify
 118 gestalt_Hyperlinks
 119 gestalt_HyperlinkInput
 120 gestalt_SoundMusic
 121 gestalt_GraphicsTransparency
 122 </SECTION>
 123
 124 <SECTION>
 125 <FILE>glk-character-input</FILE>
 126 <TITLE>Character Input</TITLE>
 127 keycode_Unknown
 128 keycode_Left
 129 keycode_Right
 130 keycode_Up
 131 keycode_Down
 132 keycode_Return
 133 keycode_Delete
 134 keycode_Escape
 135 keycode_Tab
 136 keycode_PageUp
 137 keycode_PageDown
 138 keycode_Home
 139 keycode_End
 140 keycode_Func1
 141 keycode_Func2
 142 keycode_Func3
 143 keycode_Func4
 144 keycode_Func5
 145 keycode_Func6
 146 keycode_Func7
 147 keycode_Func8
 148 keycode_Func9
 149 keycode_Func10
 150 keycode_Func11
 151 keycode_Func12
 152 <SUBSECTION Private>
 153 keycode_MAXVAL
 154 </SECTION>
 155
 156 <SECTION>
 157 <FILE>glk-case</FILE>
 158 <TITLE>Upper and Lower Case</TITLE>
 159 glk_char_to_lower
 160 glk_char_to_upper
 161 glk_buffer_to_lower_case_uni
 162 glk_buffer_to_upper_case_uni
 163 glk_buffer_to_title_case_uni
 164 </SECTION>
 165
 166 <SECTION>
 167 <FILE>glk-window-opening</FILE>
 168 <TITLE>Window Opening, Closing, and Constraints</TITLE>
 169 glk_window_open
 170 winmethod_Left
 171 winmethod_Right
 172 winmethod_Above
 173 winmethod_Below
 174 winmethod_Fixed
 175 winmethod_Proportional
 176 glk_window_close
 177 <SUBSECTION Private>
 178 winmethod_DirMask
 179 winmethod_DivisionMask
 180 </SECTION>
 181
 182 <SECTION>
 183 <FILE>glk-window-constraints</FILE>
 184 <TITLE>Changing Window Constraints</TITLE>
 185 glk_window_get_size
 186 glk_window_set_arrangement
 187 glk_window_get_arrangement
 188 </SECTION>
 189
 190 <SECTION>
 191 <FILE>glk-window-types</FILE>
 192 <TITLE>The Types of Windows</TITLE>
 193 wintype_Blank
 194 wintype_Pair
 195 wintype_TextBuffer
 196 wintype_TextGrid
 197 glk_window_move_cursor
 198 wintype_Graphics
 199 wintype_AllTypes
 200 </SECTION>
 201
 202 <SECTION>
 203 <FILE>glk-echo-streams</FILE>
 204 <TITLE>Echo Streams</TITLE>
 205 glk_window_set_echo_stream
 206 glk_window_get_echo_stream
 207 </SECTION>
 208
 209 <SECTION>
 210 <FILE>glk-window-other</FILE>
 211 <TITLE>Other Window Functions</TITLE>
 212 glk_window_iterate
 213 glk_window_get_rock
 214 glk_window_get_type
 215 glk_window_get_parent
 216 glk_window_get_sibling
 217 glk_window_get_root
 218 glk_window_clear
 219 glk_window_get_stream
 220 glk_set_window
 221 </SECTION>
 222
 223 <SECTION>
 224 <FILE>glk-events</FILE>
 225 <TITLE>Events</TITLE>
 226 glk_select
 227 event_t
 228 glk_select_poll
 229 <SUBSECTION Constants>
 230 evtype_None
 231 evtype_Timer
 232 evtype_CharInput
 233 evtype_LineInput
 234 evtype_MouseInput
 235 evtype_Arrange
 236 evtype_Redraw
 237 evtype_SoundNotify
 238 evtype_Hyperlink
 239 </SECTION>
 240
 241 <SECTION>
 242 <FILE>glk-character-input-events</FILE>
 243 <TITLE>Character Input Events</TITLE>
 244 glk_request_char_event
 245 glk_request_char_event_uni
 246 glk_cancel_char_event
 247 </SECTION>
 248
 249 <SECTION>
 250 <FILE>glk-line-input-events</FILE>
 251 <TITLE>Line Input Events</TITLE>
 252 glk_request_line_event
 253 glk_request_line_event_uni
 254 glk_cancel_line_event
 255 </SECTION>
 256
 257 <SECTION>
 258 <FILE>glk-mouse-events</FILE>
 259 <TITLE>Mouse Input Events</TITLE>
 260 glk_request_mouse_event
 261 glk_cancel_mouse_event
 262 </SECTION>
 263
 264 <SECTION>
 265 <FILE>glk-timer-events</FILE>
 266 <TITLE>Timer Events</TITLE>
 267 glk_request_timer_events
 268 </SECTION>
 269
 270 <SECTION>
 271 <FILE>glk-streams</FILE>
 272 <TITLE>Streams</TITLE>
 273 glk_stream_set_current
 274 glk_stream_get_current
 275 <SUBSECTION Constants>
 276 filemode_Write
 277 filemode_Read
 278 filemode_ReadWrite
 279 filemode_WriteAppend
 280 </SECTION>
 281
 282 <SECTION>
 283 <FILE>glk-print</FILE>
 284 <TITLE>How to Print</TITLE>
 285 glk_put_char
 286 glk_put_string
 287 glk_put_buffer
 288 glk_put_char_stream
 289 glk_put_string_stream
 290 glk_put_buffer_stream
 291 glk_put_char_uni
 292 glk_put_string_uni
 293 glk_put_buffer_uni
 294 glk_put_char_stream_uni
 295 glk_put_string_stream_uni
 296 glk_put_buffer_stream_uni
 297 </SECTION>
 298
 299 <SECTION>
 300 <FILE>glk-read</FILE>
 301 <TITLE>How to Read</TITLE>
 302 glk_get_char_stream
 303 glk_get_buffer_stream
 304 glk_get_line_stream
 305 glk_get_char_stream_uni
 306 glk_get_buffer_stream_uni
 307 glk_get_line_stream_uni
 308 </SECTION>
 309
 310 <SECTION>
 311 <FILE>glk-closing-streams</FILE>
 312 <TITLE>Closing Streams</TITLE>
 313 glk_stream_close
 314 stream_result_t
 315 </SECTION>
 316
 317 <SECTION>
 318 <FILE>glk-stream-positions</FILE>
 319 <TITLE>Stream Positions</TITLE>
 320 glk_stream_set_position
 321 glk_stream_get_position
 322 <SUBSECTION Constants>
 323 seekmode_Start
 324 seekmode_Current
 325 seekmode_End
 326 </SECTION>
 327
 328 <SECTION>
 329 <FILE>glk-styles</FILE>
 330 <TITLE>Styles</TITLE>
 331 glk_set_style
 332 glk_set_style_stream
 333 <SUBSECTION Constants>
 334 style_Normal
 335 style_Emphasized
 336 style_Preformatted
 337 style_Header
 338 style_Subheader
 339 style_Alert
 340 style_Note
 341 style_BlockQuote
 342 style_Input
 343 style_User1
 344 style_User2
 345 <SUBSECTION Private>
 346 style_NUMSTYLES
 347 </SECTION>
 348
 349 <SECTION>
 350 <FILE>glk-stylehints</FILE>
 351 <TITLE>Suggesting the Appearance of Styles</TITLE>
 352 glk_stylehint_set
 353 glk_stylehint_clear
 354 <SUBSECTION Constants>
 355 stylehint_Indentation
 356 stylehint_ParaIndentation
 357 stylehint_Justification
 358 stylehint_Size
 359 stylehint_Weight
 360 stylehint_Oblique
 361 stylehint_Proportional
 362 stylehint_TextColor
 363 stylehint_BackColor
 364 stylehint_ReverseColor
 365 stylehint_just_LeftFlush
 366 stylehint_just_LeftRight
 367 stylehint_just_Centered
 368 stylehint_just_RightFlush
 369 <SUBSECTION Private>
 370 stylehint_NUMHINTS
 371 </SECTION>
 372
 373 <SECTION>
 374 <FILE>glk-style-measure</FILE>
 375 <TITLE>Testing the Appearance of Styles</TITLE>
 376 glk_style_distinguish
 377 glk_style_measure
 378 </SECTION>
 379
 380 <SECTION>
 381 <FILE>glk-stream-types</FILE>
 382 <TITLE>The Types of Streams</TITLE>
 383 glk_stream_open_memory
 384 glk_stream_open_memory_uni
 385 glk_stream_open_file
 386 glk_stream_open_file_uni
 387 </SECTION>
 388
 389 <SECTION>
 390 <FILE>glk-stream-other</FILE>
 391 <TITLE>Other Stream Functions</TITLE>
 392 glk_stream_iterate
 393 glk_stream_get_rock
 394 </SECTION>
 395
 396 <SECTION>
 397 <FILE>glk-fileref</FILE>
 398 <TITLE>File References</TITLE>
 399 fileusage_Data
 400 fileusage_SavedGame
 401 fileusage_Transcript
 402 fileusage_InputRecord
 403 fileusage_TextMode
 404 fileusage_BinaryMode
 405 <SUBSECTION Private>
 406 fileusage_TypeMask
 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 <SUBSECTION Private>
 582 giblorb_make_id
 583 </SECTION>
 584
 585 <SECTION>
 586 <FILE>blorb-errors</FILE>
 587 <TITLE>Blorb Errors</TITLE>
 588 giblorb_err_t
 589 <SUBSECTION Constants>
 590 giblorb_err_None
 591 giblorb_err_CompileTime
 592 giblorb_err_Alloc
 593 giblorb_err_Read
 594 giblorb_err_NotAMap
 595 giblorb_err_Format
 596 giblorb_err_NotFound
 597 </SECTION>
 598
 599 <SECTION>
 600 <FILE>glkext-startup</FILE>
 601 <TITLE>Startup Code</TITLE>
 602 glkunix_argumentlist_t
 603 glkunix_startup_t
 604 <SUBSECTION Constants>
 605 glkunix_arg_NoValue
 606 glkunix_arg_ValueFollows
 607 glkunix_arg_ValueCanFollow
 608 glkunix_arg_NumberValue
 609 glkunix_arg_End
 610 <SUBSECTION Private>
 611 glkunix_startup_code
 612 NULL
 613 </SECTION>
 614
 615 <SECTION>
 616 <FILE>glkext-unix</FILE>
 617 <TITLE>Unix Extensions</TITLE>
 618 glkunix_stream_open_pathname
 619 glkunix_set_base_file
 620 </SECTION>
 621
 622 <SECTION>
 623 <FILE>glkext-garglk</FILE>
 624 <TITLE>Gargoyle Extensions</TITLE>
 625 GARGLK
 626 <SUBSECTION Functions>
 627 garglk_fileref_get_name
 628 garglk_set_program_name
 629 garglk_set_program_info
 630 garglk_set_story_name
 631 garglk_set_line_terminators
 632 garglk_unput_string
 633 garglk_unput_string_uni
 634 garglk_set_zcolors
 635 garglk_set_reversevideo
 636 <SUBSECTION Constants>
 637 zcolor_Current
 638 zcolor_Default
 639 zcolor_Black
 640 zcolor_Red
 641 zcolor_Green
 642 zcolor_Yellow
 643 zcolor_Blue
 644 zcolor_Magenta
 645 zcolor_Cyan
 646 zcolor_White
 647 zcolor_LightGrey
 648 zcolor_MediumGrey
 649 zcolor_DarkGrey
 650 keycode_Erase
 651 <SUBSECTION Private>
 652 zcolor_NUMCOLORS
 653 </SECTION>