doc/classes/HostSystem.html in ripxplore-0.0.1 vs doc/classes/HostSystem.html in ripxplore-0.0.2

- old
+ new

@@ -84,16 +84,28 @@ <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000026">all_host_systems</a>&nbsp;&nbsp; - <a href="#M000029">hex_dump</a>&nbsp;&nbsp; - <a href="#M000025">possible_file_systems</a>&nbsp;&nbsp; - <a href="#M000028">s_to_ascii</a>&nbsp;&nbsp; - <a href="#M000030">start_track</a>&nbsp;&nbsp; - <a href="#M000027">to_ascii</a>&nbsp;&nbsp; + <a href="#M000060">all_host_systems</a>&nbsp;&nbsp; + <a href="#M000073">default_background_colour</a>&nbsp;&nbsp; + <a href="#M000072">default_foreground_colour</a>&nbsp;&nbsp; + <a href="#M000067">default_screen_width</a>&nbsp;&nbsp; + <a href="#M000065">font_data</a>&nbsp;&nbsp; + <a href="#M000070">font_height</a>&nbsp;&nbsp; + <a href="#M000069">font_width</a>&nbsp;&nbsp; + <a href="#M000058">full_name</a>&nbsp;&nbsp; + <a href="#M000063">hex_dump</a>&nbsp;&nbsp; + <a href="#M000075">line_break_chars</a>&nbsp;&nbsp; + <a href="#M000068">max_screen_width</a>&nbsp;&nbsp; + <a href="#M000071">pixels_between_characters</a>&nbsp;&nbsp; + <a href="#M000059">possible_file_systems</a>&nbsp;&nbsp; + <a href="#M000062">s_to_ascii</a>&nbsp;&nbsp; + <a href="#M000066">screen_rows</a>&nbsp;&nbsp; + <a href="#M000064">start_track</a>&nbsp;&nbsp; + <a href="#M000061">to_ascii</a>&nbsp;&nbsp; + <a href="#M000074">to_screendump</a>&nbsp;&nbsp; </div> </div> </div> @@ -101,40 +113,170 @@ <!-- if includes --> <div id="section"> + <div id="constants-list"> + <h3 class="section-bar">Constants</h3> + <div class="name-list"> + <table summary="Constants"> + <tr class="top-aligned-row context-row"> + <td class="context-item-name">MAX_SCREENDUMP_LINES</td> + <td>=</td> + <td class="context-item-value">200</td> + </tr> + </table> + </div> + </div> + <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> - <div id="method-M000026" class="method-detail"> - <a name="M000026"></a> + <div id="method-M000060" class="method-detail"> + <a name="M000060"></a> <div class="method-heading"> - <a href="HostSystem.src/M000026.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000026.html');return false;"> + <a href="HostSystem.src/M000060.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000060.html');return false;"> <span class="method-name">all_host_systems</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> - <div id="method-M000029" class="method-detail"> - <a name="M000029"></a> + <div id="method-M000073" class="method-detail"> + <a name="M000073"></a> <div class="method-heading"> - <a href="HostSystem.src/M000029.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000029.html');return false;"> + <a href="HostSystem.src/M000073.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000073.html');return false;"> + <span class="method-name">default_background_colour</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000072" class="method-detail"> + <a name="M000072"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000072.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000072.html');return false;"> + <span class="method-name">default_foreground_colour</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000067" class="method-detail"> + <a name="M000067"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000067.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000067.html');return false;"> + <span class="method-name">default_screen_width</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000065" class="method-detail"> + <a name="M000065"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000065.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000065.html');return false;"> + <span class="method-name">font_data</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000070" class="method-detail"> + <a name="M000070"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000070.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000070.html');return false;"> + <span class="method-name">font_height</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000069" class="method-detail"> + <a name="M000069"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000069.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000069.html');return false;"> + <span class="method-name">font_width</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000058" class="method-detail"> + <a name="M000058"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000058.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000058.html');return false;"> + <span class="method-name">full_name</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +each subclass should override this method with a 2-5 word description of +this host system +</p> + </div> + </div> + + <div id="method-M000063" class="method-detail"> + <a name="M000063"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000063.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000063.html');return false;"> <span class="method-name">hex_dump</span><span class="method-args">(buffer)</span> </a> </div> <div class="method-description"> @@ -143,44 +285,106 @@ includes chars converted to ASCII </p> </div> </div> - <div id="method-M000025" class="method-detail"> - <a name="M000025"></a> + <div id="method-M000075" class="method-detail"> + <a name="M000075"></a> <div class="method-heading"> - <a href="HostSystem.src/M000025.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000025.html');return false;"> + <a href="HostSystem.src/M000075.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000075.html');return false;"> + <span class="method-name">line_break_chars</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000068" class="method-detail"> + <a name="M000068"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000068.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000068.html');return false;"> + <span class="method-name">max_screen_width</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + </div> + </div> + + <div id="method-M000071" class="method-detail"> + <a name="M000071"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000071.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000071.html');return false;"> + <span class="method-name">pixels_between_characters</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000059" class="method-detail"> + <a name="M000059"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000059.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000059.html');return false;"> <span class="method-name">possible_file_systems</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> - <div id="method-M000028" class="method-detail"> - <a name="M000028"></a> + <div id="method-M000062" class="method-detail"> + <a name="M000062"></a> <div class="method-heading"> - <a href="HostSystem.src/M000028.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000028.html');return false;"> + <a href="HostSystem.src/M000062.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000062.html');return false;"> <span class="method-name">s_to_ascii</span><span class="method-args">(s)</span> </a> </div> <div class="method-description"> </div> </div> - <div id="method-M000030" class="method-detail"> - <a name="M000030"></a> + <div id="method-M000066" class="method-detail"> + <a name="M000066"></a> <div class="method-heading"> - <a href="HostSystem.src/M000030.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000030.html');return false;"> + <a href="HostSystem.src/M000066.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000066.html');return false;"> + <span class="method-name">screen_rows</span><span class="method-args">()</span> + </a> + </div> + + <div class="method-description"> + <p> +default - should be overridden by each host system +</p> + </div> + </div> + + <div id="method-M000064" class="method-detail"> + <a name="M000064"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000064.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000064.html');return false;"> <span class="method-name">start_track</span><span class="method-args">()</span> </a> </div> <div class="method-description"> @@ -189,25 +393,39 @@ href="C64.html">C64</a>)? </p> </div> </div> - <div id="method-M000027" class="method-detail"> - <a name="M000027"></a> + <div id="method-M000061" class="method-detail"> + <a name="M000061"></a> <div class="method-heading"> - <a href="HostSystem.src/M000027.html" target="Code" class="method-signature" - onclick="popupCode('HostSystem.src/M000027.html');return false;"> + <a href="HostSystem.src/M000061.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000061.html');return false;"> <span class="method-name">to_ascii</span><span class="method-args">(byte)</span> </a> </div> <div class="method-description"> <p> each subclass should override <a -href="HostSystem.html#M000027">to_ascii</a> with a function that converts a +href="HostSystem.html#M000061">to_ascii</a> with a function that converts a character in the native format to an ASCII equivalent </p> + </div> + </div> + + <div id="method-M000074" class="method-detail"> + <a name="M000074"></a> + + <div class="method-heading"> + <a href="HostSystem.src/M000074.html" target="Code" class="method-signature" + onclick="popupCode('HostSystem.src/M000074.html');return false;"> + <span class="method-name">to_screendump</span><span class="method-args">(text,screen_width)</span> + </a> + </div> + + <div class="method-description"> </div> </div> </div> \ No newline at end of file