Updated documentation to match API 0.7.2

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

diff --git a/docs/reference/chimara-sections.txt b/docs/reference/chimara-sections.txt
index 3756d5a077245bbfe6e45352744a8184cfd9501f..4a4e2af79c0d15ca2e15a4356ec07a605399a780 100644 (file)
--- a/docs/reference/chimara-sections.txt
+++ b/docs/reference/chimara-sections.txt
@@ -5,6 +5,9 @@ ChimaraGlk
 ChimaraError
 CHIMARA_ERROR
 chimara_error_quark
+ChimaraResourceLoadFunc
+ChimaraResourceType
+ChimaraGlkWindowType
 chimara_glk_new
 chimara_glk_set_interactive
 chimara_glk_get_interactive
@@ -21,6 +24,13 @@ chimara_glk_wait
 chimara_glk_get_running
 chimara_glk_feed_char_input
 chimara_glk_feed_line_input
+chimara_glk_is_char_input_pending
+chimara_glk_is_line_input_pending
+chimara_glk_get_num_tag_names
+chimara_glk_get_tag
+chimara_glk_get_tag_names
+chimara_glk_update_style
+chimara_glk_set_resource_load_callback
 <SUBSECTION Standard>
 CHIMARA_GLK
 CHIMARA_IS_GLK
@@ -95,21 +105,23 @@ 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_UnicodeNorm
+GLK_MODULE_UNICODE_NORM
 gestalt_CharOutput
 gestalt_CharOutput_CannotPrint
 gestalt_CharOutput_ApproxPrint
 gestalt_CharOutput_ExactPrint
-<SUBSECTION Line Input>
 gestalt_LineInput
-<SUBSECTION Character Input>
+gestalt_LineInputEcho
+GLK_MODULE_LINE_ECHO
+gestalt_LineTerminators
+GLK_MODULE_LINE_TERMINATORS
+gestalt_LineTerminatorKey
 gestalt_CharInput
-<SUBSECTION Constants>
 gestalt_MouseInput
 gestalt_Timer
 gestalt_Graphics
@@ -151,6 +163,7 @@ keycode_Func9
 keycode_Func10
 keycode_Func11
 keycode_Func12
+<SUBSECTION Private>
 keycode_MAXVAL
 </SECTION>
 
@@ -164,6 +177,13 @@ glk_buffer_to_upper_case_uni
 glk_buffer_to_title_case_uni
 </SECTION>
 
+<SECTION>
+<FILE>glk-normalize</FILE>
+<TITLE>Unicode String Normalization</TITLE>
+glk_buffer_canon_decompose_uni
+glk_buffer_canon_normalize_uni
+</SECTION>
+
 <SECTION>
 <FILE>glk-window-opening</FILE>
 <TITLE>Window Opening, Closing, and Constraints</TITLE>
@@ -172,11 +192,15 @@ winmethod_Left
 winmethod_Right
 winmethod_Above
 winmethod_Below
-winmethod_DirMask
 winmethod_Fixed
 winmethod_Proportional
-winmethod_DivisionMask
+winmethod_Border
+winmethod_NoBorder
 glk_window_close
+<SUBSECTION Private>
+winmethod_DirMask
+winmethod_DivisionMask
+winmethod_BorderMask
 </SECTION>
 
 <SECTION>
@@ -252,6 +276,8 @@ glk_cancel_char_event
 glk_request_line_event
 glk_request_line_event_uni
 glk_cancel_line_event
+glk_set_echo_line_event
+glk_set_terminators_line_event
 </SECTION>
 
 <SECTION>
@@ -342,6 +368,7 @@ style_BlockQuote
 style_Input
 style_User1
 style_User2
+<SUBSECTION Private>
 style_NUMSTYLES
 </SECTION>
 
@@ -361,11 +388,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>
@@ -398,9 +426,10 @@ fileusage_Data
 fileusage_SavedGame
 fileusage_Transcript
 fileusage_InputRecord
-fileusage_TypeMask
 fileusage_TextMode
 fileusage_BinaryMode
+<SUBSECTION Private>
+fileusage_TypeMask
 </SECTION>
 
 <SECTION>
@@ -506,10 +535,40 @@ glk_cancel_hyperlink_event
 GLK_MODULE_HYPERLINKS
 </SECTION>
 
+<SECTION>
+<FILE>glk-clock</FILE>
+<TITLE>The System Clock</TITLE>
+glktimeval_t
+glk_current_time
+glk_current_simple_time
+</SECTION>
+
+<SECTION>
+<FILE>glk-clock-conversions</FILE>
+<TITLE>Time and Date Conversions</TITLE>
+glkdate_t
+glk_time_to_date_utc
+glk_time_to_date_local
+glk_simple_time_to_date_utc
+glk_simple_time_to_date_local
+glk_date_to_time_utc
+glk_date_to_time_local
+glk_date_to_simple_time_utc
+glk_date_to_simple_time_local
+</SECTION>
+
+<SECTION>
+<FILE>glk-clock-testing</FILE>
+<TITLE>Testing for Clock Capabilities</TITLE>
+gestalt_DateTime
+GLK_MODULE_DATETIME
+</SECTION>
+
 <SECTION>
 <FILE>dispatch-interrogating</FILE>
 <TITLE>Interrogating the Interface</TITLE>
 gidispatch_count_classes
+gidispatch_get_class
 gidispatch_count_intconst
 gidispatch_get_intconst
 gidispatch_intconst_t
@@ -619,5 +678,27 @@ glkunix_set_base_file
 <SECTION>
 <FILE>glkext-garglk</FILE>
 <TITLE>Gargoyle Extensions</TITLE>
-garglk_set_reverse_video
-</SECTION>
\ No newline at end of file
+GARGLK
+<SUBSECTION Functions>
+garglk_fileref_get_name
+garglk_set_program_name
+garglk_set_program_info
+garglk_set_story_name
+garglk_set_line_terminators
+garglk_unput_string
+garglk_unput_string_uni
+garglk_set_zcolors
+garglk_set_zcolors_stream
+garglk_set_reversevideo
+garglk_set_reversevideo_stream
+<SUBSECTION Constants>
+zcolor_Current
+zcolor_Default
+zcolor_Cursor
+zcolor_Transparent
+keycode_Erase
+keycode_MouseWheelUp
+keycode_MouseWheelDown
+<SUBSECTION Private>
+zcolor_NUMCOLORS
+</SECTION>