[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Wed Mar 17 00:22:01 CET 2010
SVN commit 1104182 by arwalker:
update online documentation for scripting
M +33 -2 Kst.html
M +6 -1 Legend.html
M +11 -1 String.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Kst.html #1104181:1104182
@@ -17,10 +17,10 @@
<br>
</div>
<br><span class="title">Methods:</span><ul>
-<a class="link" href="#method_loadScript">loadScript</a> ( fileName )<br><a class="link" href="#method_resetInterpreter">resetInterpreter</a> ( )<br><a class="link" href="#method_waitForUpdate">waitForUpdate</a> ( )<br><a class="link" href="#method_purge">purge</a> ( )<br><a class="link" href="#method_advance">advance</a> ( )<br><a class="link" href="#method_back">back</a> ( )<br><a class="link" href="#method_writeHistory">writeHistory</a> ( filename )<br><a class="link" href="#method_clearHistory">clearHistory</a> ( )<br><a class="link" href="#method_addToOutput">addToOutput</a> ( output )<br>
+<a class="link" href="#method_loadScript">loadScript</a> ( fileName )<br><a class="link" href="#method_resetInterpreter">resetInterpreter</a> ( )<br><a class="link" href="#method_waitForUpdate">waitForUpdate</a> ( )<br><a class="link" href="#method_purge">purge</a> ( )<br><a class="link" href="#method_advance">advance</a> ( )<br><a class="link" href="#method_back">back</a> ( )<br><a class="link" href="#method_writeHistory">writeHistory</a> ( filename )<br><a class="link" href="#method_clearHistory">clearHistory</a> ( )<br><a class="link" href="#method_addToOutput">addToOutput</a> ( output )<br><a class="link" href="#method_autoWriteHistory">autoWriteHistory</a> ( filename [, append] )<br><a class="link" href="#method_forceRepaint">forceRepaint</a> ( )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_dataSources">dataSources</a><br><a class="link" href="#property_scalars">scalars</a><br><a class="link" href="#property_strings">strings</a><br><a class="link" href="#property_vectors">vectors</a><br><a class="link" href="#property_matrices">matrices</a><br><a class="link" href="#property_windows">windows</a><br><a class="link" href="#property_objects">objects</a><br><a class="link" href="#property_colors">colors</a><br><a class="link" href="#property_extensions">extensions</a><br><a class="link" href="#property_document">document</a><br><a class="link" href="#property_pluginManager">pluginManager</a><br><a class="link" href="#property_gui">gui</a><br>
+<a class="link" href="#property_dataSources">dataSources</a><br><a class="link" href="#property_scalars">scalars</a><br><a class="link" href="#property_strings">strings</a><br><a class="link" href="#property_vectors">vectors</a><br><a class="link" href="#property_matrices">matrices</a><br><a class="link" href="#property_windows">windows</a><br><a class="link" href="#property_objects">objects</a><br><a class="link" href="#property_colors">colors</a><br><a class="link" href="#property_extensions">extensions</a><br><a class="link" href="#property_document">document</a><br><a class="link" href="#property_pluginManager">pluginManager</a><br><a class="link" href="#property_gui">gui</a><br><a class="link" href="#property_repaintEnabled">repaintEnabled</a><br>
</ul>
<hr>
<br><span class="subTitle"><a name="method_loadScript"></a><b>boolean loadScript ( string fileName )</b></span><br><ul>
@@ -100,6 +100,29 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="method_autoWriteHistory"></a><b>void autoWriteHistory ( string filename [, <a class="link" href="bool.html">bool</a> append] )</b></span><br><ul>
+<div class="parameters">string <b>filename</b> -
+ The name of the file to save commands to automatically.
+ Entering a blank filename will stop the saving of commands.
+
+ <br><a class="link" href="bool.html">bool</a> <b>append</b> -
+ If true and the file already exists then commands will be appended
+ to the existing file.
+
+ [OPTIONAL]<br>
+</div>
+<p>
+ Saves commands automatically to a file.
+
+ </p>
+</ul>
+<br><br><span class="subTitle"><a name="method_forceRepaint"></a><b>void forceRepaint ( )</b></span><br><ul>
+<div class="parameters"></div>
+<p>
+ Forces a repaint regardless of the value of repaintEnabled.
+
+ </p>
+</ul>
<br><br><span class="subTitle"><a name="property_dataSources"></a><b><a class="link" href="DataSourceCollection.html">DataSourceCollection</a> dataSources [Read-Only]</b></span><br><ul><p>
The list of all loaded data sources.
@@ -152,6 +175,14 @@
releases or even while Kst is running.
</p></ul>
+<br><br><span class="subTitle"><a name="property_repaintEnabled"></a><b>boolean repaintEnabled</b></span><br><ul><p>
+ Determines whether or not manipulation of the Kst interface
+ through scripting will trigger a repaint.
+ Setting this to false before issuing a long series of commands
+ (that each triggers a repaint), and then setting it back to
+ true can greatly enhance the response time of Kst.
+
+ </p></ul>
<br><br><br><a class="link" href="classindex.html">[Index]</a><hr>
<h6>Copyright ©
2005-2006 <a class="link" href="http://www.utoronto.ca/">The University of Toronto</a><br>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Legend.html #1104181:1104182
@@ -23,7 +23,7 @@
<a class="link" href="#method_addCurve">addCurve</a> ( curve )<br><a class="link" href="#method_removeCurve">removeCurve</a> ( curve )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_font">font</a><br><a class="link" href="#property_fontSize">fontSize</a><br><a class="link" href="#property_textColor">textColor</a><br><a class="link" href="#property_vertical">vertical</a><br><a class="link" href="#property_curves">curves</a><br><a class="link" href="#property_title">title</a><br>
+<a class="link" href="#property_font">font</a><br><a class="link" href="#property_fontSize">fontSize</a><br><a class="link" href="#property_textColor">textColor</a><br><a class="link" href="#property_vertical">vertical</a><br><a class="link" href="#property_curves">curves</a><br><a class="link" href="#property_title">title</a><br><a class="link" href="#property_scaleLineWidth">scaleLineWidth</a><br>
</ul>
Collection class: <a class="link" href="ViewObjectCollection.html">ViewObjectCollection</a><br><hr>
<br><span class="subTitle"><a name="constructor_1"></a><b>Legend ( <a class="link" href="ViewObject.html">ViewObject</a> parent )</b></span><br><ul>
@@ -107,6 +107,11 @@
The title of the legend.
</p></ul>
+<br><br><span class="subTitle"><a name="property_scaleLineWidth"></a><b>number scaleLineWidth</b></span><br><ul><p>
+ Contains the scale factor for the width of the lines in the legend,
+ relative to the width of the lines in the actual plot.
+
+ </p></ul>
<br><br><br><a class="link" href="classindex.html">[Index]</a><hr>
<h6>Copyright ©
2005-2006 <a class="link" href="http://www.utoronto.ca/">The University of Toronto</a><br>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/String.html #1104181:1104182
@@ -23,7 +23,7 @@
Inherits: <a class="link" href="Object.html">Object</a><br>
</div>
<br><span class="title">Constructors:</span><ul>
-<a class="link" href="#constructor_1">String</a> ( )<br>
+<a class="link" href="#constructor_1">String</a> ( )<br><a class="link" href="#constructor_2">String</a> ( value )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_value">value</a><br>
@@ -36,6 +36,16 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="constructor_2"></a><b>String ( string value )</b></span><br><ul>
+<div class="parameters">string <b>value</b> -
+
+ <br>
+</div>
+<p>
+ Creates a new string with the specified value.
+
+ </p>
+</ul>
<br><br><span class="subTitle"><a name="property_value"></a><b>string value</b></span><br><ul><p>
The value of the String.
More information about the Kst
mailing list