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 Suggesting the Appearance of Styles>
 309 glk_stylehint_set
 310 glk_stylehint_clear
 311 <SUBSECTION Testing the Appearance of Styles>
 312 glk_style_distinguish
 313 glk_style_measure
 314 <SUBSECTION Constants>
 315 style_Normal
 316 style_Emphasized
 317 style_Preformatted
 318 style_Header
 319 style_Subheader
 320 style_Alert
 321 style_Note
 322 style_BlockQuote
 323 style_Input
 324 style_User1
 325 style_User2
 326 style_NUMSTYLES
 327 stylehint_Indentation
 328 stylehint_ParaIndentation
 329 stylehint_Justification
 330 stylehint_Size
 331 stylehint_Weight
 332 stylehint_Oblique
 333 stylehint_Proportional
 334 stylehint_TextColor
 335 stylehint_BackColor
 336 stylehint_ReverseColor
 337 stylehint_NUMHINTS
 338 stylehint_just_LeftFlush
 339 stylehint_just_LeftRight
 340 stylehint_just_Centered
 341 stylehint_just_RightFlush
 342 </SECTION>
 343
 344 <SECTION>
 345 <FILE>glk-stream-types</FILE>
 346 <TITLE>The Types of Streams</TITLE>
 347 glk_stream_open_memory
 348 glk_stream_open_memory_uni
 349 glk_stream_open_file
 350 glk_stream_open_file_uni
 351 </SECTION>
 352
 353 <SECTION>
 354 <FILE>glk-stream-other</FILE>
 355 <TITLE>Other Stream Functions</TITLE>
 356 glk_stream_iterate
 357 glk_stream_get_rock
 358 </SECTION>
 359
 360 <SECTION>
 361 <FILE>glk-fileref</FILE>
 362 <TITLE>File References</TITLE>
 363 fileusage_Data
 364 fileusage_SavedGame
 365 fileusage_Transcript
 366 fileusage_InputRecord
 367 fileusage_TypeMask
 368 fileusage_TextMode
 369 fileusage_BinaryMode
 370 </SECTION>
 371
 372 <SECTION>
 373 <FILE>glk-fileref-types</FILE>
 374 <TITLE>The Types of File References</TITLE>
 375 glk_fileref_create_temp
 376 glk_fileref_create_by_prompt
 377 glk_fileref_create_by_name
 378 glk_fileref_create_from_fileref
 379 </SECTION>
 380
 381 <SECTION>
 382 <FILE>glk-fileref-other</FILE>
 383 <TITLE>Other File Reference Functions</TITLE>
 384 glk_fileref_destroy
 385 glk_fileref_iterate
 386 glk_fileref_get_rock
 387 glk_fileref_delete_file
 388 glk_fileref_does_file_exist
 389 </SECTION>
 390
 391 <SECTION>
 392 <FILE>glk-image-resources</FILE>
 393 <TITLE>Image Resources</TITLE>
 394 glk_image_get_info
 395 glk_image_draw
 396 glk_image_draw_scaled
 397 </SECTION>
 398
 399 <SECTION>
 400 <FILE>glk-graphics-windows</FILE>
 401 <TITLE>Graphics in Graphics Windows</TITLE>
 402 glk_window_set_background_color
 403 glk_window_fill_rect
 404 glk_window_erase_rect
 405 </SECTION>
 406
 407 <SECTION>
 408 <FILE>glk-graphics-text</FILE>
 409 <TITLE>Graphics in Text Buffer Windows</TITLE>
 410 glk_window_flow_break
 411 <SUBSECTION Constants>
 412 imagealign_InlineUp
 413 imagealign_InlineDown
 414 imagealign_InlineCenter
 415 imagealign_MarginLeft
 416 imagealign_MarginRight
 417 </SECTION>
 418
 419 <SECTION>
 420 <FILE>glk-graphics-testing</FILE>
 421 <TITLE>Testing for Graphics Capabilities</TITLE>
 422 GLK_MODULE_IMAGE
 423 </SECTION>
 424
 425 <SECTION>
 426 <FILE>glk-sound-channels</FILE>
 427 <TITLE>Creating and Destroying Sound Channels</TITLE>
 428 glk_schannel_create
 429 glk_schannel_destroy
 430 </SECTION>
 431
 432 <SECTION>
 433 <FILE>glk-playing-sounds</FILE>
 434 <TITLE>Playing Sounds</TITLE>
 435 glk_schannel_play
 436 glk_schannel_play_ext
 437 glk_schannel_stop
 438 glk_schannel_set_volume
 439 glk_sound_load_hint
 440 </SECTION>
 441
 442 <SECTION>
 443 <FILE>glk-sound-other</FILE>
 444 <TITLE>Other Sound Channel Functions</TITLE>
 445 glk_schannel_iterate
 446 glk_schannel_get_rock
 447 </SECTION>
 448
 449 <SECTION>
 450 <FILE>glk-sound-testing</FILE>
 451 <TITLE>Testing for Sound Capabilities</TITLE>
 452 GLK_MODULE_SOUND
 453 </SECTION>
 454
 455 <SECTION>
 456 <FILE>glk-creating-hyperlinks</FILE>
 457 <TITLE>Creating Hyperlinks</TITLE>
 458 glk_set_hyperlink
 459 glk_set_hyperlink_stream
 460 </SECTION>
 461
 462 <SECTION>
 463 <FILE>glk-accepting-hyperlinks</FILE>
 464 <TITLE>Accepting Hyperlink Events</TITLE>
 465 glk_request_hyperlink_event
 466 glk_cancel_hyperlink_event
 467 </SECTION>
 468
 469 <SECTION>
 470 <FILE>glk-hyperlinks-testing</FILE>
 471 <TITLE>Testing for Hyperlink Capabilities</TITLE>
 472 GLK_MODULE_HYPERLINKS
 473 </SECTION>
 474