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