|
|
|
@ -22,7 +22,7 @@ ul { list-style: none; padding: 0; margin: 0; }
|
|
|
|
|
<h2 id='section_introduction'>§1 Introduction</h2>
|
|
|
|
|
<div>
|
|
|
|
|
<p>
|
|
|
|
|
This is the documentation for alpha 4.0.10 super! The documentation is still under construction so some of the links are linking to sections that have not been written yet. What is here should be correct and I suspect useful even without some of the other sections. </p>
|
|
|
|
|
This is the documentation for alpha 4.0.9 super! The documentation is still under construction so some of the links are linking to sections that have not been written yet. What is here should be correct and I suspect useful even without some of the other sections. </p>
|
|
|
|
|
<p>
|
|
|
|
|
If you have questions or discover errors please contact <span style='font-family: "Courier New", Courier, monospace; text-align: left;'>editor@4coder.net</span> or to get help from community members you can post on the 4coder forums hosted on handmade.network at <span style='font-family: "Courier New", Courier, monospace; text-align: left;'>4coder.handmade.network</span></p>
|
|
|
|
|
</div>
|
|
|
|
@ -44,6 +44,7 @@ Coming Soon</i><div>
|
|
|
|
|
<li><a href='#buffer_boundary_seek_doc'>buffer_boundary_seek</a></li>
|
|
|
|
|
<li><a href='#buffer_read_range_doc'>buffer_read_range</a></li>
|
|
|
|
|
<li><a href='#buffer_replace_range_doc'>buffer_replace_range</a></li>
|
|
|
|
|
<li><a href='#buffer_batch_edit_doc'>buffer_batch_edit</a></li>
|
|
|
|
|
<li><a href='#buffer_set_setting_doc'>buffer_set_setting</a></li>
|
|
|
|
|
<li><a href='#buffer_auto_indent_doc'>buffer_auto_indent</a></li>
|
|
|
|
|
<li><a href='#create_buffer_doc'>create_buffer</a></li>
|
|
|
|
@ -93,6 +94,7 @@ Coming Soon</i><div>
|
|
|
|
|
<li><a href='#Command_ID_doc'>Command_ID</a></li>
|
|
|
|
|
<li><a href='#User_Input_Type_ID_doc'>User_Input_Type_ID</a></li>
|
|
|
|
|
<li><a href='#Event_Message_Type_ID_doc'>Event_Message_Type_ID</a></li>
|
|
|
|
|
<li><a href='#Buffer_Batch_Edit_Type_doc'>Buffer_Batch_Edit_Type</a></li>
|
|
|
|
|
<li><a href='#Buffer_Setting_ID_doc'>Buffer_Setting_ID</a></li>
|
|
|
|
|
<li><a href='#View_Setting_ID_doc'>View_Setting_ID</a></li>
|
|
|
|
|
<li><a href='#Mouse_Cursor_Show_Type_doc'>Mouse_Cursor_Show_Type</a></li>
|
|
|
|
@ -117,6 +119,7 @@ Coming Soon</i><div>
|
|
|
|
|
<li><a href='#GUI_Scroll_Vars_doc'>GUI_Scroll_Vars</a></li>
|
|
|
|
|
<li><a href='#Full_Cursor_doc'>Full_Cursor</a></li>
|
|
|
|
|
<li><a href='#Buffer_Seek_doc'>Buffer_Seek</a></li>
|
|
|
|
|
<li><a href='#Buffer_Edit_doc'>Buffer_Edit</a></li>
|
|
|
|
|
<li><a href='#Buffer_Summary_doc'>Buffer_Summary</a></li>
|
|
|
|
|
<li><a href='#View_Summary_doc'>View_Summary</a></li>
|
|
|
|
|
<li><a href='#User_Input_doc'>User_Input</a></li>
|
|
|
|
@ -378,8 +381,34 @@ from start to end.
|
|
|
|
|
|
|
|
|
|
This call fails if the buffer does not exist, or if the replace
|
|
|
|
|
range is not within the bounds of the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
|
|
|
|
|
<div id='buffer_batch_edit_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.13: buffer_batch_edit</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_batch_edit(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>char *str,<br>int32_t str_len,<br>Buffer_Edit *edits,<br>int32_t edit_count,<br>Buffer_Batch_Edit_Type type<br></div>)
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Parameters</i></b></div><div>
|
|
|
|
|
<div style='font-weight: 600;'>str</div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides all of the source string for the edits in the batch.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-weight: 600;'>str_len</div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the length of the str string.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-weight: 600;'>edits</div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter provides about the source string and destination range of each edit as an array.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-weight: 600;'>edit_count</div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This parameter specifies the number of Buffer_Edit structs in edits.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-weight: 600;'>type</div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>This prameter specifies what type of batch edit to execute.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if the batch edit succeeds.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Edit_doc'>Buffer_Edit</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Batch_Edit_Type_doc'>Buffer_Batch_Edit_Type</a></div></div><hr>
|
|
|
|
|
<div id='buffer_set_setting_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.13: buffer_set_setting</h4>
|
|
|
|
|
<h4>§3.3.14: buffer_set_setting</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_set_setting(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>Buffer_Setting_ID setting,<br>int32_t value<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -397,7 +426,7 @@ range is not within the bounds of the buffer.</div><div style='margin-top: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Setting_ID_doc'>Buffer_Setting_ID</a></div></div><hr>
|
|
|
|
|
<div id='buffer_auto_indent_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.14: buffer_auto_indent</h4>
|
|
|
|
|
<h4>§3.3.15: buffer_auto_indent</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->buffer_auto_indent(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>int32_t start,<br>int32_t end,<br>int32_t tab_width,<br>Auto_Indent_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -426,7 +455,7 @@ start to end by inserting spaces or tabs at the beginning of the lines.
|
|
|
|
|
If the buffer does not have lexing enabled or the lexing job has not
|
|
|
|
|
completed this function will fail.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Auto_Indent_Flag_doc'>Auto_Indent_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
|
|
|
|
|
<div id='create_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.15: create_buffer</h4>
|
|
|
|
|
<h4>§3.3.16: create_buffer</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Buffer_Summary app->create_buffer(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int32_t filename_len,<br>Buffer_Create_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -448,7 +477,7 @@ If the buffer does not exist a new buffer is created and named after the given f
|
|
|
|
|
the filename corresponds to a file on the disk that file is loaded and put into buffer, if
|
|
|
|
|
the filename does not correspond to a file on disk the buffer is created empty.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Create_Flag_doc'>Buffer_Create_Flag</a></div></div><hr>
|
|
|
|
|
<div id='save_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.16: save_buffer</h4>
|
|
|
|
|
<h4>§3.3.17: save_buffer</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->save_buffer(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Summary *buffer,<br>char *filename,<br>int32_t filename_len,<br>uint32_t flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -470,7 +499,7 @@ the filename does not correspond to a file on disk the buffer is created empty.<
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
|
|
|
|
|
<div id='kill_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.17: kill_buffer</h4>
|
|
|
|
|
<h4>§3.3.18: kill_buffer</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->kill_buffer(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Buffer_Identifier buffer,<br>View_ID view_id,<br>Buffer_Kill_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -490,7 +519,7 @@ the filename does not correspond to a file on disk the buffer is created empty.<
|
|
|
|
|
dialogue needs to be displayed the provided view is used to show the dialogue.
|
|
|
|
|
If the view is not open the kill fails.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Kill_Flag_doc'>Buffer_Kill_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Identifier_doc'>Buffer_Identifier</a></div></div><hr>
|
|
|
|
|
<div id='get_view_first_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.18: get_view_first</h4>
|
|
|
|
|
<h4>§3.3.19: get_view_first</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>View_Summary app->get_view_first(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -503,7 +532,7 @@ If the view is not open the kill fails.</div><div style='margin-top: 3mm; margin
|
|
|
|
|
If the View_Summary returned is a null summary, the loop is finished.
|
|
|
|
|
Views should not be closed or opened durring a view loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_view_next_doc'>get_view_next</a></div></div><hr>
|
|
|
|
|
<div id='get_view_next_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.19: get_view_next</h4>
|
|
|
|
|
<h4>§3.3.20: get_view_next</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->get_view_next(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -520,7 +549,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
If the view outputted does not exist, the loop is finished.
|
|
|
|
|
Views should not be closed or opened durring a view loop.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_view_first_doc'>get_view_first</a></div></div><hr>
|
|
|
|
|
<div id='get_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.20: get_view</h4>
|
|
|
|
|
<h4>§3.3.21: get_view</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>View_Summary app->get_view(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_ID view_id,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -534,7 +563,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a summary that describes the indicated view if it is open and accessible.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
|
|
|
|
|
<div id='get_active_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.21: get_active_view</h4>
|
|
|
|
|
<h4>§3.3.22: get_active_view</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>View_Summary app->get_active_view(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Access_Flag access<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -544,7 +573,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns a summary that describes the active view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#set_active_view_doc'>set_active_view</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
|
|
|
|
|
<div id='open_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.22: open_view</h4>
|
|
|
|
|
<h4>§3.3.23: open_view</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>View_Summary app->open_view(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view_location,<br>View_Split_Position position<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -560,7 +589,7 @@ Views should not be closed or opened durring a view loop.</div><div style='margi
|
|
|
|
|
returns a null summary.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>4coder is built with a limit of 16 views. If 16 views are already open when this is called the
|
|
|
|
|
call will fail.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#View_Split_Position_doc'>View_Split_Position</a></div></div><hr>
|
|
|
|
|
<div id='close_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.23: close_view</h4>
|
|
|
|
|
<h4>§3.3.24: close_view</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->close_view(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -573,7 +602,7 @@ If the given view is the active view, the next active view in the global
|
|
|
|
|
order of view will be made active.
|
|
|
|
|
If the given view is the last open view in the system, the call will fail.</div></div><hr>
|
|
|
|
|
<div id='set_active_view_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.24: set_active_view</h4>
|
|
|
|
|
<h4>§3.3.25: set_active_view</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->set_active_view(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -585,7 +614,7 @@ If the given view is the last open view in the system, the call will fail.</div>
|
|
|
|
|
active view, and takes subsequent commands and is returned
|
|
|
|
|
from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#get_active_view_doc'>get_active_view</a></div></div><hr>
|
|
|
|
|
<div id='view_set_setting_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.25: view_set_setting</h4>
|
|
|
|
|
<h4>§3.3.26: view_set_setting</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_setting(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>View_Setting_ID setting,<br>int32_t value<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -603,7 +632,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#View_Setting_ID_doc'>View_Setting_ID</a></div></div><hr>
|
|
|
|
|
<div id='view_set_split_proportion_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.26: view_set_split_proportion</h4>
|
|
|
|
|
<h4>§3.3.27: view_set_split_proportion</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_split_proportion(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>float t<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -617,7 +646,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
|
|
|
|
|
<div id='view_compute_cursor_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.27: view_compute_cursor</h4>
|
|
|
|
|
<h4>§3.3.28: view_compute_cursor</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_compute_cursor(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek,<br>Full_Cursor *cursor_out<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -635,7 +664,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Computes a Full_Cursor for the given seek position with no side effects.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Full_Cursor_doc'>Full_Cursor</a></div></div><hr>
|
|
|
|
|
<div id='view_set_cursor_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.28: view_set_cursor</h4>
|
|
|
|
|
<h4>§3.3.29: view_set_cursor</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_cursor(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek,<br>bool32 set_preferred_x<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -655,7 +684,7 @@ from get_active_view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; colo
|
|
|
|
|
unless the change in cursor position is is a vertical motion that tries to keep the
|
|
|
|
|
cursor in the same column or x position.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div></div><hr>
|
|
|
|
|
<div id='view_set_mark_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.29: view_set_mark</h4>
|
|
|
|
|
<h4>§3.3.30: view_set_mark</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_mark(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_Seek seek<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -669,7 +698,7 @@ cursor in the same column or x position.</div><div style='margin-top: 3mm; margi
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call sets the the view's mark position.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div></div><hr>
|
|
|
|
|
<div id='view_set_highlight_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.30: view_set_highlight</h4>
|
|
|
|
|
<h4>§3.3.31: view_set_highlight</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_highlight(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>int32_t start,<br>int32_t end,<br>bool32 turn_on<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -694,7 +723,7 @@ is set to true the highlight will be shown and the cursor will be hidden. After
|
|
|
|
|
that either setting the with view_set_cursor or calling view_set_highlight and
|
|
|
|
|
the turn_on set to false, will switch back to showing the cursor.</div></div><hr>
|
|
|
|
|
<div id='view_set_buffer_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.31: view_set_buffer</h4>
|
|
|
|
|
<h4>§3.3.32: view_set_buffer</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_set_buffer(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>Buffer_ID buffer_id,<br>Set_Buffer_Flag flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -713,7 +742,7 @@ the turn_on set to false, will switch back to showing the cursor.</div></div><hr
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>On success view_set_buffer sets the specified view's current buffer and
|
|
|
|
|
cancels and dialogue shown in the view and displays the file.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Set_Buffer_Flag_doc'>Set_Buffer_Flag</a></div></div><hr>
|
|
|
|
|
<div id='view_post_fade_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.32: view_post_fade</h4>
|
|
|
|
|
<h4>§3.3.33: view_post_fade</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->view_post_fade(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>View_Summary *view,<br>float seconds,<br>int32_t start,<br>int32_t end,<br>int_color color<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -739,7 +768,7 @@ cancels and dialogue shown in the view and displays the file.</div><div style='m
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#int_color_doc'>int_color</a></div></div><hr>
|
|
|
|
|
<div id='get_user_input_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.33: get_user_input</h4>
|
|
|
|
|
<h4>§3.3.34: get_user_input</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>User_Input app->get_user_input(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Input_Type_Flag get_type,<br>Input_Type_Flag abort_type<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -757,19 +786,19 @@ command is executed an abort signal is returned. If an abort signal is ever ret
|
|
|
|
|
command should finish execution without any more calls that preempt the command.
|
|
|
|
|
If a get condition is met the user input is returned.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Input_Type_Flag_doc'>Input_Type_Flag</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#User_Input_doc'>User_Input</a></div></div><hr>
|
|
|
|
|
<div id='get_command_input_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.34: get_command_input</h4>
|
|
|
|
|
<h4>§3.3.35: get_command_input</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>User_Input app->get_command_input(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app<br></div>)
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the input that triggered the currently executing command.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#User_Input_doc'>User_Input</a></div></div><hr>
|
|
|
|
|
<div id='get_mouse_state_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.35: get_mouse_state</h4>
|
|
|
|
|
<h4>§3.3.36: get_mouse_state</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>Mouse_State app->get_mouse_state(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app<br></div>)
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns the current mouse state as of the beginning of the frame.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Mouse_State_doc'>Mouse_State</a></div></div><hr>
|
|
|
|
|
<div id='start_query_bar_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.36: start_query_bar</h4>
|
|
|
|
|
<h4>§3.3.37: start_query_bar</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->start_query_bar(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -789,7 +818,7 @@ can be changed after the call to start_query_bar and the query bar shown by 4cod
|
|
|
|
|
will reflect the change. Since the bar stops showing when the command exits the
|
|
|
|
|
only use for this call is in an interactive command that makes calls to get_user_input.</div></div><hr>
|
|
|
|
|
<div id='end_query_bar_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.37: end_query_bar</h4>
|
|
|
|
|
<h4>§3.3.38: end_query_bar</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->end_query_bar(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Query_Bar *bar,<br>uint32_t flags<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -803,7 +832,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Stops showing the particular query bar specified by the bar parameter.</div></div><hr>
|
|
|
|
|
<div id='print_message_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.38: print_message</h4>
|
|
|
|
|
<h4>§3.3.39: print_message</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->print_message(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *str,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -817,7 +846,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call posts a string to the *messages* buffer.</div></div><hr>
|
|
|
|
|
<div id='change_theme_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.39: change_theme</h4>
|
|
|
|
|
<h4>§3.3.40: change_theme</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->change_theme(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -831,7 +860,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call changes 4coder's theme to one of the built in themes.</div></div><hr>
|
|
|
|
|
<div id='change_font_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.40: change_font</h4>
|
|
|
|
|
<h4>§3.3.41: change_font</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->change_font(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *name,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -845,7 +874,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call changes 4coder's font to one of the built in fonts.</div></div><hr>
|
|
|
|
|
<div id='set_theme_colors_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.41: set_theme_colors</h4>
|
|
|
|
|
<h4>§3.3.42: set_theme_colors</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->set_theme_colors(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -861,7 +890,7 @@ only use for this call is in an interactive command that makes calls to get_user
|
|
|
|
|
struct's tag is set to the color code in the struct. If the tag value is invalid
|
|
|
|
|
no change is made to the color pallet.</div></div><hr>
|
|
|
|
|
<div id='get_theme_colors_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.42: get_theme_colors</h4>
|
|
|
|
|
<h4>§3.3.43: get_theme_colors</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->get_theme_colors(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Theme_Color *colors,<br>int32_t count<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -877,7 +906,7 @@ no change is made to the color pallet.</div></div><hr>
|
|
|
|
|
color from the slot in the main color pallet specified by the tag. If the tag
|
|
|
|
|
value is invalid the color is filled with black.</div></div><hr>
|
|
|
|
|
<div id='directory_get_hot_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.43: directory_get_hot</h4>
|
|
|
|
|
<h4>§3.3.44: directory_get_hot</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>int32_t app->directory_get_hot(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *out,<br>int32_t capacity<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -895,7 +924,7 @@ accessed in the GUI. Whenever the GUI is opened it shows the hot directory.
|
|
|
|
|
In the future this will be deprecated and eliminated in favor of more flexible
|
|
|
|
|
directories controlled on the custom side.</div></div><hr>
|
|
|
|
|
<div id='get_file_list_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.44: get_file_list</h4>
|
|
|
|
|
<h4>§3.3.45: get_file_list</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>File_List app->get_file_list(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int32_t len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -911,7 +940,7 @@ directories controlled on the custom side.</div></div><hr>
|
|
|
|
|
the specified directory. The File_List returned should be passed to free_file_list
|
|
|
|
|
when it is no longer in use.</div></div><hr>
|
|
|
|
|
<div id='free_file_list_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.45: free_file_list</h4>
|
|
|
|
|
<h4>§3.3.46: free_file_list</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->free_file_list(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>File_List list<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -921,7 +950,7 @@ when it is no longer in use.</div></div><hr>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>After this call the file list passed in should not be read or written to.</div></div><hr>
|
|
|
|
|
<div id='file_exists_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.46: file_exists</h4>
|
|
|
|
|
<h4>§3.3.47: file_exists</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->file_exists(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *filename,<br>int len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -935,7 +964,7 @@ when it is no longer in use.</div></div><hr>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero if and only if the file exists.</div></div><hr>
|
|
|
|
|
<div id='directory_cd_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.47: directory_cd</h4>
|
|
|
|
|
<h4>§3.3.48: directory_cd</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->directory_cd(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *dir,<br>int *len,<br>int capacity,<br>char *rel_path,<br>int rel_len<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -968,7 +997,7 @@ will contain "C:/Users/MySelf/Documents" and len will contain the length of that
|
|
|
|
|
string. This call can also be used with rel set to ".." to traverse to parent
|
|
|
|
|
folders.</div></div><hr>
|
|
|
|
|
<div id='get_4ed_path_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.48: get_4ed_path</h4>
|
|
|
|
|
<h4>§3.3.49: get_4ed_path</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>bool32 app->get_4ed_path(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>char *out,<br>int32_t capacity<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -982,7 +1011,7 @@ folders.</div></div><hr>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Return</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>This call returns non-zero on success.</div></div><hr>
|
|
|
|
|
<div id='show_mouse_cursor_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.3.49: show_mouse_cursor</h4>
|
|
|
|
|
<h4>§3.3.50: show_mouse_cursor</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>void app->show_mouse_cursor(
|
|
|
|
|
<div style='margin-left: 4mm;'>Application_Links *app,<br>Mouse_Cursor_Show_Type show<br></div>)
|
|
|
|
|
</div>
|
|
|
|
@ -1173,8 +1202,20 @@ the range [1,16].</div></div><hr>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>TODO.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Batch_Edit_Type_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.10: Buffer_Batch_Edit_Type</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Buffer_Batch_Edit_Type;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Batch_Edit_Type is a type of batch operation.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BatchEdit_Normal</span></span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BatchEdit_PreserveTokens</span></span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'></div></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Setting_ID_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.10: Buffer_Setting_ID</h4>
|
|
|
|
|
<h4>§3.4.11: Buffer_Setting_ID</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Buffer_Setting_ID;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Setting_ID names a setting in a buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferSetting_Null</span></span></div>
|
|
|
|
@ -1203,7 +1244,7 @@ the range [1,16].</div></div><hr>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='View_Setting_ID_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.11: View_Setting_ID</h4>
|
|
|
|
|
<h4>§3.4.12: View_Setting_ID</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum View_Setting_ID;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A View_Setting_ID names a setting in a view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>ViewSetting_Null</span></span></div>
|
|
|
|
@ -1227,7 +1268,7 @@ the range [1,16].</div></div><hr>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Mouse_Cursor_Show_Type_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.12: Mouse_Cursor_Show_Type</h4>
|
|
|
|
|
<h4>§3.4.13: Mouse_Cursor_Show_Type</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Mouse_Cursor_Show_Type;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Mouse_Cursor_Show_Type value specifes a mode for 4coder to handle the mouse cursor.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>MouseCursorShow_Never</span></span></div>
|
|
|
|
@ -1239,7 +1280,7 @@ the range [1,16].</div></div><hr>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Seek_Type_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.13: Buffer_Seek_Type</h4>
|
|
|
|
|
<h4>§3.4.14: Buffer_Seek_Type</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Buffer_Seek_Type;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>The Buffer_Seek_Type is is used in a Buffer_Seek to identify which
|
|
|
|
|
coordinates are suppose to be used for the seek.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
|
|
|
|
@ -1260,7 +1301,7 @@ coordinates are suppose to be used for the seek.</div><div style='margin-top: 3m
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_doc'>Buffer_Seek</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
|
|
|
|
|
<div id='View_Split_Position_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.14: View_Split_Position</h4>
|
|
|
|
|
<h4>§3.4.15: View_Split_Position</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum View_Split_Position;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A View_Split_Position specifies where a new view should be placed as a result of
|
|
|
|
|
a view split operation.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Values</i></b></div><div>
|
|
|
|
@ -1281,7 +1322,7 @@ a view split operation.</div><div style='margin-top: 3mm; margin-bottom: 3mm; co
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Key_Modifier_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.15: Key_Modifier_Flag</h4>
|
|
|
|
|
<h4>§3.4.16: Key_Modifier_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Key_Modifier_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Key_Modifier_Flag field is used to specify a specific state of modifiers.
|
|
|
|
|
Flags can be combined with bit or to specify a state with multiple modifiers.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
@ -1302,7 +1343,7 @@ Flags can be combined with bit or to specify a state with multiple modifiers.</d
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Create_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.16: Buffer_Create_Flag</h4>
|
|
|
|
|
<h4>§3.4.17: Buffer_Create_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Buffer_Create_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Create_Flag field specifies how a buffer should be created.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferCreate_Background</span> = 0x1</span></div>
|
|
|
|
@ -1315,7 +1356,7 @@ Flags can be combined with bit or to specify a state with multiple modifiers.</d
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Kill_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.17: Buffer_Kill_Flag</h4>
|
|
|
|
|
<h4>§3.4.18: Buffer_Kill_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Buffer_Kill_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Buffer_Kill_Flag field specifies how a buffer should be killed.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>BufferKill_Background</span> = 0x1</span></div>
|
|
|
|
@ -1328,7 +1369,7 @@ Flags can be combined with bit or to specify a state with multiple modifiers.</d
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Access_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.18: Access_Flag</h4>
|
|
|
|
|
<h4>§3.4.19: Access_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Access_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>An Access_Flag field specifies what sort of permission you grant to an
|
|
|
|
|
access call. An access call is usually one the returns a summary struct. If a
|
|
|
|
@ -1358,7 +1399,7 @@ that protection flag, the object is still returned from the access call.</div><d
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Seek_Boundary_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.19: Seek_Boundary_Flag</h4>
|
|
|
|
|
<h4>§3.4.20: Seek_Boundary_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Seek_Boundary_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Seek_Boundary_Flag field specifies a set of "boundary" types used in seeks for the
|
|
|
|
|
beginning or end of different types of words.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
@ -1379,7 +1420,7 @@ beginning or end of different types of words.</div><div style='margin-top: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Command_Line_Input_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.20: Command_Line_Input_Flag</h4>
|
|
|
|
|
<h4>§3.4.21: Command_Line_Input_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Command_Line_Input_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Command_Line_Input_Flag field specifies the behavior of a call to a command line interface.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>CLI_OverlapWithConflict</span> = 0x1</span></div>
|
|
|
|
@ -1400,7 +1441,7 @@ beginning or end of different types of words.</div><div style='margin-top: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Auto_Indent_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.21: Auto_Indent_Flag</h4>
|
|
|
|
|
<h4>§3.4.22: Auto_Indent_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Auto_Indent_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>An Auto_Indent_Flag field specifies the behavior of an auto indentation operation.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>AutoIndent_ClearLine</span> = 0x1</span></div>
|
|
|
|
@ -1416,7 +1457,7 @@ beginning or end of different types of words.</div><div style='margin-top: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Set_Buffer_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.22: Set_Buffer_Flag</h4>
|
|
|
|
|
<h4>§3.4.23: Set_Buffer_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Set_Buffer_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Set_Buffer_Flag field specifies the behavior of an operation that sets the buffer of a view.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>SetBuffer_KeepOriginalGUI</span> = 0x1</span></div>
|
|
|
|
@ -1426,7 +1467,7 @@ beginning or end of different types of words.</div><div style='margin-top: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Input_Type_Flag_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.23: Input_Type_Flag</h4>
|
|
|
|
|
<h4>§3.4.24: Input_Type_Flag</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>enum Input_Type_Flag;</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>A Input_Type_Flag field specifies a set of input event types.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Flags</i></b></div><div>
|
|
|
|
|
<div><span style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>EventOnAnyKey</span> = 0x1</span></div>
|
|
|
|
@ -1466,7 +1507,7 @@ beginning or end of different types of words.</div><div style='margin-top: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Generic_Command_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.24: Generic_Command</h4>
|
|
|
|
|
<h4>§3.4.25: Generic_Command</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>union Generic_Command {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
Command_ID cmdid;<br>
|
|
|
|
@ -1487,7 +1528,7 @@ internal command or a custom command.</div><div style='margin-top: 3mm; margin-b
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Key_Event_Data_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.25: Key_Event_Data</h4>
|
|
|
|
|
<h4>§3.4.26: Key_Event_Data</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Key_Event_Data {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
Key_Code keycode;<br>
|
|
|
|
@ -1521,7 +1562,7 @@ at the time of the event.</div><div style='margin-top: 3mm; margin-bottom: 3mm;
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Mouse_State_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.26: Mouse_State</h4>
|
|
|
|
|
<h4>§3.4.27: Mouse_State</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Mouse_State {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
char l;<br>
|
|
|
|
@ -1581,7 +1622,7 @@ mouse if in the window.</div><div style='margin-top: 3mm; margin-bottom: 3mm; co
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Range_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.27: Range</h4>
|
|
|
|
|
<h4>§3.4.28: Range</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>union Range {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
struct {<br>
|
|
|
|
@ -1621,7 +1662,7 @@ Throughout the API ranges are thought of in the form [min,max</div><div style='m
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='File_Info_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.28: File_Info</h4>
|
|
|
|
|
<h4>§3.4.29: File_Info</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct File_Info {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
char * filename;<br>
|
|
|
|
@ -1644,7 +1685,7 @@ int folder;<br>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#File_List_doc'>File_List</a></div></div><hr>
|
|
|
|
|
<div id='File_List_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.29: File_List</h4>
|
|
|
|
|
<h4>§3.4.30: File_List</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct File_List {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
void * block;<br>
|
|
|
|
@ -1672,7 +1713,7 @@ int block_size;<br>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Identifier_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.30: Buffer_Identifier</h4>
|
|
|
|
|
<h4>§3.4.31: Buffer_Identifier</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Identifier {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
char * name;<br>
|
|
|
|
@ -1697,7 +1738,7 @@ can either be a name or an id. If the</div><div style='margin-top: 3mm; margin-
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='GUI_Scroll_Vars_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.31: GUI_Scroll_Vars</h4>
|
|
|
|
|
<h4>§3.4.32: GUI_Scroll_Vars</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct GUI_Scroll_Vars {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
float scroll_y;<br>
|
|
|
|
@ -1735,7 +1776,7 @@ int32_t prev_target_x;<br>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Full_Cursor_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.32: Full_Cursor</h4>
|
|
|
|
|
<h4>§3.4.33: Full_Cursor</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Full_Cursor {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
int32_t pos;<br>
|
|
|
|
@ -1779,7 +1820,7 @@ coordinate system supported by 4coder.</div><div style='margin-top: 3mm; margin-
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
|
|
|
|
|
<div id='Buffer_Seek_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.33: Buffer_Seek</h4>
|
|
|
|
|
<h4>§3.4.34: Buffer_Seek</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Seek {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
Buffer_Seek_Type type;<br>
|
|
|
|
@ -1843,8 +1884,38 @@ for concisely creating Buffer_Seek structs. They can be found in 4coder_buffer_
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The character number of a line-character type seek.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Buffer_Seek_Type_doc'>Buffer_Seek_Type</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#4coder_Buffer_Positioning_System_doc'>4coder_Buffer_Positioning_System</a></div></div><hr>
|
|
|
|
|
<div id='Buffer_Edit_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.35: Buffer_Edit</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Edit {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
int32_t str_start;<br>
|
|
|
|
|
int32_t len;<br>
|
|
|
|
|
int32_t start;<br>
|
|
|
|
|
int32_t end;<br>
|
|
|
|
|
</div>
|
|
|
|
|
};<br>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Description</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'>Buffer_Edit describes a range of a buffer and string to replace that range.
|
|
|
|
|
A Buffer_Edit has to be paired with a string that contains the actual text that
|
|
|
|
|
will be replaced into the buffer.</div><div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>Fields</i></b></div><div>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>str_start</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The str_start field specifies the first character in the accompanying string that corresponds with this edit.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>len</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The len field specifies the length of the string being written into the buffer.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>start</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The start field specifies the start of the range in the buffer to replace in absolute position.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>end</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>The end field specifies one past the end of the range in the buffer to replace in absolute position.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Buffer_Summary_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.34: Buffer_Summary</h4>
|
|
|
|
|
<h4>§3.4.36: Buffer_Summary</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Buffer_Summary {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
bool32 exists;<br>
|
|
|
|
@ -1852,6 +1923,7 @@ bool32 ready;<br>
|
|
|
|
|
int32_t buffer_id;<br>
|
|
|
|
|
Access_Flag lock_flags;<br>
|
|
|
|
|
int32_t size;<br>
|
|
|
|
|
int32_t line_count;<br>
|
|
|
|
|
char * file_name;<br>
|
|
|
|
|
int32_t file_name_len;<br>
|
|
|
|
|
char * buffer_name;<br>
|
|
|
|
@ -1885,6 +1957,10 @@ bool32 unwrapped_lines;<br>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the size of the text in the buffer.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>line_count</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the number of lines in the buffer.</div></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left;'><span style='font-weight: 600;'>file_name</span></div>
|
|
|
|
|
<div style='margin-bottom: 6mm;'><div style='margin-left: 5mm; margin-right: 5mm;'>If this is not a null summary, this field specifies the file name associated to this buffer.</div></div>
|
|
|
|
|
</div>
|
|
|
|
@ -1914,7 +1990,7 @@ bool32 unwrapped_lines;<br>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
|
|
|
|
|
<div id='View_Summary_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.35: View_Summary</h4>
|
|
|
|
|
<h4>§3.4.37: View_Summary</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct View_Summary {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
bool32 exists;<br>
|
|
|
|
@ -1984,7 +2060,7 @@ GUI_Scroll_Vars scroll_vars;<br>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Access_Flag_doc'>Access_Flag</a></div></div><hr>
|
|
|
|
|
<div id='User_Input_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.36: User_Input</h4>
|
|
|
|
|
<h4>§3.4.38: User_Input</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct User_Input {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
User_Input_Type_ID type;<br>
|
|
|
|
@ -2021,7 +2097,7 @@ Generic_Command command;<br>
|
|
|
|
|
</div>
|
|
|
|
|
<div style='margin-top: 3mm; margin-bottom: 3mm; color: #309030;'><b><i>See Also</i></b></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#User_Input_Type_ID_doc'>User_Input_Type_ID</a></div><div style='margin-left: 5mm; margin-right: 5mm;'><a href='#Generic_Command_doc'>Generic_Command</a></div></div><hr>
|
|
|
|
|
<div id='Query_Bar_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.37: Query_Bar</h4>
|
|
|
|
|
<h4>§3.4.39: Query_Bar</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Query_Bar {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
String prompt;<br>
|
|
|
|
@ -2040,7 +2116,7 @@ that will be displayed as a drop down bar durring an interactive command.</div><
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Event_Message_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.38: Event_Message</h4>
|
|
|
|
|
<h4>§3.4.40: Event_Message</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Event_Message {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
int type;<br>
|
|
|
|
@ -2053,7 +2129,7 @@ int type;<br>
|
|
|
|
|
</div>
|
|
|
|
|
</div><hr>
|
|
|
|
|
<div id='Theme_Color_doc' style='margin-bottom: 1cm;'>
|
|
|
|
|
<h4>§3.4.39: Theme_Color</h4>
|
|
|
|
|
<h4>§3.4.41: Theme_Color</h4>
|
|
|
|
|
<div style='font-family: "Courier New", Courier, monospace; text-align: left; margin-top: 3mm; margin-bottom: 3mm; font-size: .95em; background: #DFDFDF; padding: 0.25em;'>struct Theme_Color {<br>
|
|
|
|
|
<div style='margin-left: 8mm;'>
|
|
|
|
|
Style_Tag tag;<br>
|
|
|
|
|