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