Documented all planned Glk API functions

[rodin/chimara.git] / docs / reference / chimara-sections.txt

diff --git a/docs/reference/chimara-sections.txt b/docs/reference/chimara-sections.txt
index 2281bfb3d2399d5e3919931608f3ceb403bed988..7f4075dd393fc26208c685c75c36f6eda38ed741 100644 (file)
--- a/docs/reference/chimara-sections.txt
+++ b/docs/reference/chimara-sections.txt
@@ -2,24 +2,26 @@
 <FILE>chimara-glk</FILE>
 <TITLE>ChimaraGlk</TITLE>
 ChimaraGlk
+ChimaraError
+CHIMARA_ERROR
+chimara_error_quark
 chimara_glk_new
 chimara_glk_set_interactive
 chimara_glk_get_interactive
 chimara_glk_set_protect
 chimara_glk_get_protect
-chimara_glk_set_default_font_description
-chimara_glk_set_default_font_string
-chimara_glk_get_default_font_description
-chimara_glk_set_monospace_font_description
-chimara_glk_set_monospace_font_string
-chimara_glk_get_monospace_font_description
 chimara_glk_set_spacing
 chimara_glk_get_spacing
+chimara_glk_set_css_to_default
+chimara_glk_set_css_from_file
+chimara_glk_set_css_from_string
 chimara_glk_run
 chimara_glk_stop
 chimara_glk_wait
+chimara_glk_get_running
+chimara_glk_feed_char_input
+chimara_glk_feed_line_input
 <SUBSECTION Standard>
-ChimaraGlkClass
 CHIMARA_GLK
 CHIMARA_IS_GLK
 CHIMARA_TYPE_GLK
@@ -29,6 +31,29 @@ CHIMARA_IS_GLK_CLASS
 CHIMARA_GLK_GET_CLASS
 </SECTION>
 
+<SECTION>
+<FILE>chimara-if</FILE>
+ChimaraIFFormat
+ChimaraIFInterpreter
+ChimaraIFZmachineVersion
+<TITLE>ChimaraIF</TITLE>
+ChimaraIF
+chimara_if_new
+chimara_if_set_preferred_interpreter
+chimara_if_get_preferred_interpreter
+chimara_if_run_game
+chimara_if_get_format
+chimara_if_get_interpreter
+<SUBSECTION Standard>
+CHIMARA_IF
+CHIMARA_IS_IF
+CHIMARA_TYPE_IF
+chimara_if_get_type
+CHIMARA_IF_CLASS
+CHIMARA_IS_IF_CLASS
+CHIMARA_IF_GET_CLASS
+</SECTION>
+
 <SECTION>
 <FILE>glk-exiting</FILE>
 <TITLE>Exiting Your Program</TITLE>
@@ -70,21 +95,16 @@ schanid_t
 <TITLE>The Gestalt System</TITLE>
 glk_gestalt_ext
 glk_gestalt
-<SUBSECTION The Version Number>
+<SUBSECTION Constants>
 gestalt_Version
-<SUBSECTION Testing for Unicode Capabilities>
 gestalt_Unicode
 GLK_MODULE_UNICODE
-<SUBSECTION Output>
 gestalt_CharOutput
 gestalt_CharOutput_CannotPrint
 gestalt_CharOutput_ApproxPrint
 gestalt_CharOutput_ExactPrint
-<SUBSECTION Line Input>
 gestalt_LineInput
-<SUBSECTION Character Input>
 gestalt_CharInput
-<SUBSECTION Constants>
 gestalt_MouseInput
 gestalt_Timer
 gestalt_Graphics
@@ -126,6 +146,7 @@ keycode_Func9
 keycode_Func10
 keycode_Func11
 keycode_Func12
+<SUBSECTION Private>
 keycode_MAXVAL
 </SECTION>
 
@@ -147,11 +168,12 @@ winmethod_Left
 winmethod_Right
 winmethod_Above
 winmethod_Below
-winmethod_DirMask
 winmethod_Fixed
 winmethod_Proportional
-winmethod_DivisionMask
 glk_window_close
+<SUBSECTION Private>
+winmethod_DirMask
+winmethod_DivisionMask
 </SECTION>
 
 <SECTION>
@@ -317,6 +339,7 @@ style_BlockQuote
 style_Input
 style_User1
 style_User2
+<SUBSECTION Private>
 style_NUMSTYLES
 </SECTION>
 
@@ -336,11 +359,12 @@ stylehint_Proportional
 stylehint_TextColor
 stylehint_BackColor
 stylehint_ReverseColor
-stylehint_NUMHINTS
 stylehint_just_LeftFlush
 stylehint_just_LeftRight
 stylehint_just_Centered
 stylehint_just_RightFlush
+<SUBSECTION Private>
+stylehint_NUMHINTS
 </SECTION>
 
 <SECTION>
@@ -373,9 +397,10 @@ fileusage_Data
 fileusage_SavedGame
 fileusage_Transcript
 fileusage_InputRecord
-fileusage_TypeMask
 fileusage_TextMode
 fileusage_BinaryMode
+<SUBSECTION Private>
+fileusage_TypeMask
 </SECTION>
 
 <SECTION>
@@ -481,6 +506,46 @@ glk_cancel_hyperlink_event
 GLK_MODULE_HYPERLINKS
 </SECTION>
 
+<SECTION>
+<FILE>dispatch-interrogating</FILE>
+<TITLE>Interrogating the Interface</TITLE>
+gidispatch_count_classes
+gidispatch_count_intconst
+gidispatch_get_intconst
+gidispatch_intconst_t
+gidispatch_count_functions
+gidispatch_get_function
+gidispatch_function_t
+gidispatch_get_function_by_id
+<SUBSECTION Constants>
+gidisp_Class_Window
+gidisp_Class_Stream
+gidisp_Class_Fileref
+gidisp_Class_Schannel
+</SECTION>
+
+<SECTION>
+<FILE>dispatch-dispatching</FILE>
+<TITLE>Dispatching</TITLE>
+gidispatch_call
+gluniversal_t
+</SECTION>
+
+<SECTION>
+<FILE>dispatch-prototypes</FILE>
+<TITLE>Getting Argument Prototypes</TITLE>
+gidispatch_prototype
+</SECTION>
+
+<SECTION>
+<FILE>dispatch-library-functions</FILE>
+<TITLE>Functions the Library Must Provide</TITLE>
+gidispatch_set_object_registry
+gidispatch_rock_t
+gidispatch_get_objrock
+gidispatch_set_retained_registry
+</SECTION>
+
 <SECTION>
 <FILE>blorb-program</FILE>
 <TITLE>What the Program Does</TITLE>
@@ -510,6 +575,8 @@ giblorb_ID_Pict
 giblorb_ID_Copyright
 giblorb_ID_AUTH
 giblorb_ID_ANNO
+<SUBSECTION Private>
+giblorb_make_id
 </SECTION>
 
 <SECTION>
@@ -537,6 +604,9 @@ glkunix_arg_ValueFollows
 glkunix_arg_ValueCanFollow
 glkunix_arg_NumberValue
 glkunix_arg_End
+<SUBSECTION Private>
+glkunix_startup_code
+NULL
 </SECTION>
 
 <SECTION>
@@ -545,3 +615,9 @@ glkunix_arg_End
 glkunix_stream_open_pathname
 glkunix_set_base_file
 </SECTION>
+
+<SECTION>
+<FILE>glkext-garglk</FILE>
+<TITLE>Gargoyle Extensions</TITLE>
+garglk_set_reversevideo
+</SECTION>
\ No newline at end of file