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 The Version Number>
  99 gestalt_Version
 100 <SUBSECTION Testing for Unicode Capabilities>
 101 gestalt_Unicode
 102 GLK_MODULE_UNICODE
 103 <SUBSECTION Output>
 104 gestalt_CharOutput
 105 gestalt_CharOutput_CannotPrint
 106 gestalt_CharOutput_ApproxPrint
 107 gestalt_CharOutput_ExactPrint
 108 <SUBSECTION Line Input>
 109 gestalt_LineInput
 110 <SUBSECTION Character Input>
 111 gestalt_CharInput
 112 <SUBSECTION Constants>
 113 gestalt_MouseInput
 114 gestalt_Timer
 115 gestalt_Graphics
 116 gestalt_DrawImage
 117 gestalt_Sound
 118 gestalt_SoundVolume
 119 gestalt_SoundNotify
 120 gestalt_Hyperlinks
 121 gestalt_HyperlinkInput
 122 gestalt_SoundMusic
 123 gestalt_GraphicsTransparency
 124 </SECTION>
 125
 126 <SECTION>
 127 <FILE>glk-character-input</FILE>
 128 <TITLE>Character Input</TITLE>
 129 keycode_Unknown
 130 keycode_Left
 131 keycode_Right
 132 keycode_Up
 133 keycode_Down
 134 keycode_Return
 135 keycode_Delete
 136 keycode_Escape
 137 keycode_Tab
 138 keycode_PageUp
 139 keycode_PageDown
 140 keycode_Home
 141 keycode_End
 142 keycode_Func1
 143 keycode_Func2
 144 keycode_Func3
 145 keycode_Func4
 146 keycode_Func5
 147 keycode_Func6
 148 keycode_Func7
 149 keycode_Func8
 150 keycode_Func9
 151 keycode_Func10
 152 keycode_Func11
 153 keycode_Func12
 154 keycode_MAXVAL
 155 </SECTION>
 156
 157 <SECTION>
 158 <FILE>glk-case</FILE>
 159 <TITLE>Upper and Lower Case</TITLE>
 160 glk_char_to_lower
 161 glk_char_to_upper
 162 glk_buffer_to_lower_case_uni
 163 glk_buffer_to_upper_case_uni
 164 glk_buffer_to_title_case_uni
 165 </SECTION>
 166
 167 <SECTION>
 168 <FILE>glk-window-opening</FILE>
 169 <TITLE>Window Opening, Closing, and Constraints</TITLE>
 170 glk_window_open
 171 winmethod_Left
 172 winmethod_Right
 173 winmethod_Above
 174 winmethod_Below
 175 winmethod_DirMask
 176 winmethod_Fixed
 177 winmethod_Proportional
 178 winmethod_DivisionMask
 179 glk_window_close
 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 style_NUMSTYLES
 346 </SECTION>
 347
 348 <SECTION>
 349 <FILE>glk-stylehints</FILE>
 350 <TITLE>Suggesting the Appearance of Styles</TITLE>
 351 glk_stylehint_set
 352 glk_stylehint_clear
 353 <SUBSECTION Constants>
 354 stylehint_Indentation
 355 stylehint_ParaIndentation
 356 stylehint_Justification
 357 stylehint_Size
 358 stylehint_Weight
 359 stylehint_Oblique
 360 stylehint_Proportional
 361 stylehint_TextColor
 362 stylehint_BackColor
 363 stylehint_ReverseColor
 364 stylehint_NUMHINTS
 365 stylehint_just_LeftFlush
 366 stylehint_just_LeftRight
 367 stylehint_just_Centered
 368 stylehint_just_RightFlush
 369 </SECTION>
 370
 371 <SECTION>
 372 <FILE>glk-style-measure</FILE>
 373 <TITLE>Testing the Appearance of Styles</TITLE>
 374 glk_style_distinguish
 375 glk_style_measure
 376 </SECTION>
 377
 378 <SECTION>
 379 <FILE>glk-stream-types</FILE>
 380 <TITLE>The Types of Streams</TITLE>
 381 glk_stream_open_memory
 382 glk_stream_open_memory_uni
 383 glk_stream_open_file
 384 glk_stream_open_file_uni
 385 </SECTION>
 386
 387 <SECTION>
 388 <FILE>glk-stream-other</FILE>
 389 <TITLE>Other Stream Functions</TITLE>
 390 glk_stream_iterate
 391 glk_stream_get_rock
 392 </SECTION>
 393
 394 <SECTION>
 395 <FILE>glk-fileref</FILE>
 396 <TITLE>File References</TITLE>
 397 fileusage_Data
 398 fileusage_SavedGame
 399 fileusage_Transcript
 400 fileusage_InputRecord
 401 fileusage_TypeMask
 402 fileusage_TextMode
 403 fileusage_BinaryMode
 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 </SECTION>
 579
 580 <SECTION>
 581 <FILE>blorb-errors</FILE>
 582 <TITLE>Blorb Errors</TITLE>
 583 giblorb_err_t
 584 <SUBSECTION Constants>
 585 giblorb_err_None
 586 giblorb_err_CompileTime
 587 giblorb_err_Alloc
 588 giblorb_err_Read
 589 giblorb_err_NotAMap
 590 giblorb_err_Format
 591 giblorb_err_NotFound
 592 </SECTION>
 593
 594 <SECTION>
 595 <FILE>glkext-startup</FILE>
 596 <TITLE>Startup Code</TITLE>
 597 glkunix_argumentlist_t
 598 glkunix_startup_t
 599 <SUBSECTION Constants>
 600 glkunix_arg_NoValue
 601 glkunix_arg_ValueFollows
 602 glkunix_arg_ValueCanFollow
 603 glkunix_arg_NumberValue
 604 glkunix_arg_End
 605 </SECTION>
 606
 607 <SECTION>
 608 <FILE>glkext-unix</FILE>
 609 <TITLE>Unix Extensions</TITLE>
 610 glkunix_stream_open_pathname
 611 glkunix_set_base_file
 612 </SECTION>