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_run
  17 chimara_glk_stop
  18 chimara_glk_wait
  19 <SUBSECTION Standard>
  20 ChimaraGlkClass
  21 CHIMARA_GLK
  22 CHIMARA_IS_GLK
  23 CHIMARA_TYPE_GLK
  24 chimara_glk_get_type
  25 CHIMARA_GLK_CLASS
  26 CHIMARA_IS_GLK_CLASS
  27 CHIMARA_GLK_GET_CLASS
  28 </SECTION>
  29
  30 <SECTION>
  31 <FILE>glk-exiting</FILE>
  32 <TITLE>Exiting Your Program</TITLE>
  33 glk_exit
  34 <SUBSECTION Private>
  35 glk_main
  36 </SECTION>
  37
  38 <SECTION>
  39 <FILE>glk-interrupt</FILE>
  40 <TITLE>The Interrupt Handler</TITLE>
  41 glk_set_interrupt_handler
  42 </SECTION>
  43
  44 <SECTION>
  45 <FILE>glk-tick</FILE>
  46 <TITLE>The Tick Thing</TITLE>
  47 glk_tick
  48 </SECTION>
  49
  50 <SECTION>
  51 <FILE>glk-types</FILE>
  52 <TITLE>Basic Types</TITLE>
  53 glui32
  54 glsi32
  55 </SECTION>
  56
  57 <SECTION>
  58 <FILE>glk-opaque-objects</FILE>
  59 <TITLE>Opaque Objects</TITLE>
  60 winid_t
  61 strid_t
  62 frefid_t
  63 schanid_t
  64 </SECTION>
  65
  66 <SECTION>
  67 <FILE>glk-gestalt</FILE>
  68 <TITLE>The Gestalt System</TITLE>
  69 glk_gestalt_ext
  70 glk_gestalt
  71 <SUBSECTION The Version Number>
  72 gestalt_Version
  73 <SUBSECTION Testing for Unicode Capabilities>
  74 gestalt_Unicode
  75 GLK_MODULE_UNICODE
  76 <SUBSECTION Output>
  77 gestalt_CharOutput
  78 gestalt_CharOutput_CannotPrint
  79 gestalt_CharOutput_ApproxPrint
  80 gestalt_CharOutput_ExactPrint
  81 <SUBSECTION Line Input>
  82 gestalt_LineInput
  83 <SUBSECTION Character Input>
  84 gestalt_CharInput
  85 <SUBSECTION Constants>
  86 gestalt_MouseInput
  87 gestalt_Timer
  88 gestalt_Graphics
  89 gestalt_DrawImage
  90 gestalt_Sound
  91 gestalt_SoundVolume
  92 gestalt_SoundNotify
  93 gestalt_Hyperlinks
  94 gestalt_HyperlinkInput
  95 gestalt_SoundMusic
  96 gestalt_GraphicsTransparency
  97 </SECTION>
  98
  99 <SECTION>
 100 <FILE>glk-character-input</FILE>
 101 <TITLE>Character Input</TITLE>
 102 keycode_Unknown
 103 keycode_Left
 104 keycode_Right
 105 keycode_Up
 106 keycode_Down
 107 keycode_Return
 108 keycode_Delete
 109 keycode_Escape
 110 keycode_Tab
 111 keycode_PageUp
 112 keycode_PageDown
 113 keycode_Home
 114 keycode_End
 115 keycode_Func1
 116 keycode_Func2
 117 keycode_Func3
 118 keycode_Func4
 119 keycode_Func5
 120 keycode_Func6
 121 keycode_Func7
 122 keycode_Func8
 123 keycode_Func9
 124 keycode_Func10
 125 keycode_Func11
 126 keycode_Func12
 127 keycode_MAXVAL
 128 </SECTION>
 129
 130 <SECTION>
 131 <FILE>glk-case</FILE>
 132 <TITLE>Upper and Lower Case</TITLE>
 133 glk_char_to_lower
 134 glk_char_to_upper
 135 glk_buffer_to_lower_case_uni
 136 glk_buffer_to_upper_case_uni
 137 glk_buffer_to_title_case_uni
 138 </SECTION>
 139
 140 <SECTION>
 141 <FILE>glk-window-opening</FILE>
 142 <TITLE>Window Opening, Closing, and Constraints</TITLE>
 143 glk_window_open
 144 winmethod_Left
 145 winmethod_Right
 146 winmethod_Above
 147 winmethod_Below
 148 winmethod_DirMask
 149 winmethod_Fixed
 150 winmethod_Proportional
 151 winmethod_DivisionMask
 152 glk_window_close
 153 </SECTION>
 154
 155 <SECTION>
 156 <FILE>glk-window-constraints</FILE>
 157 <TITLE>Changing Window Constraints</TITLE>
 158 glk_window_get_size
 159 glk_window_set_arrangement
 160 glk_window_get_arrangement
 161 </SECTION>
 162
 163 <SECTION>
 164 <FILE>glk-window-types</FILE>
 165 <TITLE>The Types of Windows</TITLE>
 166 wintype_Blank
 167 wintype_Pair
 168 wintype_TextBuffer
 169 wintype_TextGrid
 170 glk_window_move_cursor
 171 wintype_Graphics
 172 wintype_AllTypes
 173 </SECTION>
 174
 175 <SECTION>
 176 <FILE>glk-echo-streams</FILE>
 177 <TITLE>Echo Streams</TITLE>
 178 glk_window_set_echo_stream
 179 glk_window_get_echo_stream
 180 </SECTION>
 181
 182 <SECTION>
 183 <FILE>glk-window-other</FILE>
 184 <TITLE>Other Window Functions</TITLE>
 185 glk_window_iterate
 186 glk_window_get_rock
 187 glk_window_get_type
 188 glk_window_get_parent
 189 glk_window_get_sibling
 190 glk_window_get_root
 191 glk_window_clear
 192 glk_window_get_stream
 193 glk_set_window
 194 </SECTION>
 195
 196 <SECTION>
 197 <FILE>glk-events</FILE>
 198 <TITLE>Events</TITLE>
 199 glk_select
 200 event_t
 201 glk_select_poll
 202 <SUBSECTION Constants>
 203 evtype_None
 204 evtype_Timer
 205 evtype_CharInput
 206 evtype_LineInput
 207 evtype_MouseInput
 208 evtype_Arrange
 209 evtype_Redraw
 210 evtype_SoundNotify
 211 evtype_Hyperlink
 212 </SECTION>
 213
 214 <SECTION>
 215 <FILE>glk-character-input-events</FILE>
 216 <TITLE>Character Input Events</TITLE>
 217 glk_request_char_event
 218 glk_request_char_event_uni
 219 glk_cancel_char_event
 220 </SECTION>
 221
 222 <SECTION>
 223 <FILE>glk-line-input-events</FILE>
 224 <TITLE>Line Input Events</TITLE>
 225 glk_request_line_event
 226 glk_request_line_event_uni
 227 glk_cancel_line_event
 228 </SECTION>
 229
 230 <SECTION>
 231 <FILE>glk-mouse-events</FILE>
 232 <TITLE>Mouse Input Events</TITLE>
 233 glk_request_mouse_event
 234 glk_cancel_mouse_event
 235 </SECTION>
 236
 237 <SECTION>
 238 <FILE>glk-timer-events</FILE>
 239 <TITLE>Timer Events</TITLE>
 240 glk_request_timer_events
 241 </SECTION>
 242
 243 <SECTION>
 244 <FILE>glk-streams</FILE>
 245 <TITLE>Streams</TITLE>
 246 glk_stream_set_current
 247 glk_stream_get_current
 248 <SUBSECTION Constants>
 249 filemode_Write
 250 filemode_Read
 251 filemode_ReadWrite
 252 filemode_WriteAppend
 253 </SECTION>
 254
 255 <SECTION>
 256 <FILE>glk-print</FILE>
 257 <TITLE>How to Print</TITLE>
 258 glk_put_char
 259 glk_put_string
 260 glk_put_buffer
 261 glk_put_char_stream
 262 glk_put_string_stream
 263 glk_put_buffer_stream
 264 glk_put_char_uni
 265 glk_put_string_uni
 266 glk_put_buffer_uni
 267 glk_put_char_stream_uni
 268 glk_put_string_stream_uni
 269 glk_put_buffer_stream_uni
 270 </SECTION>
 271
 272 <SECTION>
 273 <FILE>glk-read</FILE>
 274 <TITLE>How to Read</TITLE>
 275 glk_get_char_stream
 276 glk_get_buffer_stream
 277 glk_get_line_stream
 278 glk_get_char_stream_uni
 279 glk_get_buffer_stream_uni
 280 glk_get_line_stream_uni
 281 </SECTION>
 282
 283 <SECTION>
 284 <FILE>glk-closing-streams</FILE>
 285 <TITLE>Closing Streams</TITLE>
 286 glk_stream_close
 287 stream_result_t
 288 </SECTION>
 289
 290 <SECTION>
 291 <FILE>glk-stream-positions</FILE>
 292 <TITLE>Stream Positions</TITLE>
 293 glk_stream_set_position
 294 glk_stream_get_position
 295 <SUBSECTION Constants>
 296 seekmode_Start
 297 seekmode_Current
 298 seekmode_End
 299 </SECTION>
 300
 301 <SECTION>
 302 <FILE>glk-styles</FILE>
 303 <TITLE>Styles</TITLE>
 304 glk_set_style
 305 glk_set_style_stream
 306 <SUBSECTION Suggesting the Appearance of Styles>
 307 glk_stylehint_set
 308 glk_stylehint_clear
 309 <SUBSECTION Testing the Appearance of Styles>
 310 glk_style_distinguish
 311 glk_style_measure
 312 <SUBSECTION Constants>
 313 style_Normal
 314 style_Emphasized
 315 style_Preformatted
 316 style_Header
 317 style_Subheader
 318 style_Alert
 319 style_Note
 320 style_BlockQuote
 321 style_Input
 322 style_User1
 323 style_User2
 324 style_NUMSTYLES
 325 stylehint_Indentation
 326 stylehint_ParaIndentation
 327 stylehint_Justification
 328 stylehint_Size
 329 stylehint_Weight
 330 stylehint_Oblique
 331 stylehint_Proportional
 332 stylehint_TextColor
 333 stylehint_BackColor
 334 stylehint_ReverseColor
 335 stylehint_NUMHINTS
 336 stylehint_just_LeftFlush
 337 stylehint_just_LeftRight
 338 stylehint_just_Centered
 339 stylehint_just_RightFlush
 340 </SECTION>
 341
 342 <SECTION>
 343 <FILE>glk-stream-types</FILE>
 344 <TITLE>The Types of Streams</TITLE>
 345 glk_stream_open_memory
 346 glk_stream_open_memory_uni
 347 glk_stream_open_file
 348 glk_stream_open_file_uni
 349 </SECTION>
 350
 351 <SECTION>
 352 <FILE>glk-stream-other</FILE>
 353 <TITLE>Other Stream Functions</TITLE>
 354 glk_stream_iterate
 355 glk_stream_get_rock
 356 </SECTION>
 357
 358 <SECTION>
 359 <FILE>glk-fileref</FILE>
 360 <TITLE>File References</TITLE>
 361 fileusage_Data
 362 fileusage_SavedGame
 363 fileusage_Transcript
 364 fileusage_InputRecord
 365 fileusage_TypeMask
 366 fileusage_TextMode
 367 fileusage_BinaryMode
 368 </SECTION>
 369
 370 <SECTION>
 371 <FILE>glk-fileref-types</FILE>
 372 <TITLE>The Types of File References</TITLE>
 373 glk_fileref_create_temp
 374 glk_fileref_create_by_prompt
 375 glk_fileref_create_by_name
 376 glk_fileref_create_from_fileref
 377 </SECTION>
 378
 379 <SECTION>
 380 <FILE>glk-fileref-other</FILE>
 381 <TITLE>Other File Reference Functions</TITLE>
 382 glk_fileref_destroy
 383 glk_fileref_iterate
 384 glk_fileref_get_rock
 385 glk_fileref_delete_file
 386 glk_fileref_does_file_exist
 387 </SECTION>
 388
 389 <SECTION>
 390 <FILE>glk-image-resources</FILE>
 391 <TITLE>Image Resources</TITLE>
 392 glk_image_get_info
 393 glk_image_draw
 394 glk_image_draw_scaled
 395 </SECTION>
 396
 397 <SECTION>
 398 <FILE>glk-graphics-windows</FILE>
 399 <TITLE>Graphics in Graphics Windows</TITLE>
 400 glk_window_set_background_color
 401 glk_window_fill_rect
 402 glk_window_erase_rect
 403 </SECTION>
 404
 405 <SECTION>
 406 <FILE>glk-graphics-text</FILE>
 407 <TITLE>Graphics in Text Buffer Windows</TITLE>
 408 glk_window_flow_break
 409 <SUBSECTION Constants>
 410 imagealign_InlineUp
 411 imagealign_InlineDown
 412 imagealign_InlineCenter
 413 imagealign_MarginLeft
 414 imagealign_MarginRight
 415 </SECTION>
 416
 417 <SECTION>
 418 <FILE>glk-graphics-testing</FILE>
 419 <TITLE>Testing for Graphics Capabilities</TITLE>
 420 GLK_MODULE_IMAGE
 421 </SECTION>
 422
 423 <SECTION>
 424 <FILE>glk-sound-channels</FILE>
 425 <TITLE>Creating and Destroying Sound Channels</TITLE>
 426 glk_schannel_create
 427 glk_schannel_destroy
 428 </SECTION>
 429
 430 <SECTION>
 431 <FILE>glk-playing-sounds</FILE>
 432 <TITLE>Playing Sounds</TITLE>
 433 glk_schannel_play
 434 glk_schannel_play_ext
 435 glk_schannel_stop
 436 glk_schannel_set_volume
 437 glk_sound_load_hint
 438 </SECTION>
 439
 440 <SECTION>
 441 <FILE>glk-sound-other</FILE>
 442 <TITLE>Other Sound Channel Functions</TITLE>
 443 glk_schannel_iterate
 444 glk_schannel_get_rock
 445 </SECTION>
 446
 447 <SECTION>
 448 <FILE>glk-sound-testing</FILE>
 449 <TITLE>Testing for Sound Capabilities</TITLE>
 450 GLK_MODULE_SOUND
 451 </SECTION>
 452
 453 <SECTION>
 454 <FILE>glk-creating-hyperlinks</FILE>
 455 <TITLE>Creating Hyperlinks</TITLE>
 456 glk_set_hyperlink
 457 glk_set_hyperlink_stream
 458 </SECTION>
 459
 460 <SECTION>
 461 <FILE>glk-accepting-hyperlinks</FILE>
 462 <TITLE>Accepting Hyperlink Events</TITLE>
 463 glk_request_hyperlink_event
 464 glk_cancel_hyperlink_event
 465 </SECTION>
 466
 467 <SECTION>
 468 <FILE>glk-hyperlinks-testing</FILE>
 469 <TITLE>Testing for Hyperlink Capabilities</TITLE>
 470 GLK_MODULE_HYPERLINKS
 471 </SECTION>
 472