docs/reference/chimara-sections.txt

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