diff options
author | Shashank | 2017-05-29 12:40:26 +0530 |
---|---|---|
committer | Shashank | 2017-05-29 12:40:26 +0530 |
commit | 0345245e860375a32c9a437c4a9d9cae807134e9 (patch) | |
tree | ad51ecbfa7bcd3cc5f09834f1bb8c08feaa526a4 /modules/tclsci/help | |
download | scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.gz scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.tar.bz2 scilab_for_xcos_on_cloud-0345245e860375a32c9a437c4a9d9cae807134e9.zip |
CMSCOPE changed
Diffstat (limited to 'modules/tclsci/help')
19 files changed, 1585 insertions, 0 deletions
diff --git a/modules/tclsci/help/en_US/ScilabEval.xml b/modules/tclsci/help/en_US/ScilabEval.xml new file mode 100755 index 000000000..62e52eecc --- /dev/null +++ b/modules/tclsci/help/en_US/ScilabEval.xml @@ -0,0 +1,192 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) Bertrand Guiheneuf + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="ScilabEval"> + <refnamediv> + <refname>ScilabEval</refname> + <refpurpose>tcl instruction : Evaluate a string + with scilab interpreter + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>ScilabEval instruction + ScilabEval instruction "seq" + ScilabEval instruction "sync" + ScilabEval instruction "sync" "seq" + ScilabEval "flush" + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>instruction</term> + <listitem> + <para>tcl string character contains a Scilab instruction to evaluate + with the current Scilab interpreter. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This function must be called in a tcl/tk script executed from Scilab. + It allows to associate Scilab actions to tcl/tk widgets (graphic objects) + or to use Scilab to perform some computations within a tcl script. + </para> + <para/> + <variablelist> + <varlistentry> + <term>ScilabEval instruction</term> + <listitem> + <para> + If the <literal>ScilabEval instruction </literal> syntax is used, the + <literal>instruction</literal> is first stored in a FIFO queue, + <literal>ScilabEval</literal> returns immediately. Scilab executes the + queued <literal>instructions</literal> when possible (it should be at the + prompt but also at the end of each instructions of the currently + running function) in the order they were submitted. This syntax can be + used to associate Scilab actions to tcl/tk widgets but not into a tcl + script executed by <link linkend="TCL_EvalFile">TCL_EvalFile</link> or <link linkend="TCL_EvalStr">TCL_EvalStr</link> + because in this situation the Scilab interpreter is blocked up to the + end of the script. Note that with the + <literal>ScilabEval instruction</literal> syntax, if there are many + <literal>ScilabEval</literal> + commands stored in the queue the execution of the second one can be + started in the middle of the execution of the first one (in particular + if the first one contains more than a simple expression). + </para> + <para> + If the <literal>"seq"</literal> option is added, the associated + instruction evaluation should be finished (or paused) before the next + queued instruction evaluation can be started. The next callback stored + in the command queue will only be taken into account when the current + one will be finished or paused. + </para> + <para/> + </listitem> + </varlistentry> + <varlistentry> + <term>ScilabEval instruction "sync"</term> + <listitem> + <para> + If the <literal>ScilabEval instruction "sync"</literal> syntax is used, + the instruction is executed immediately (not queued) and the + <literal>ScilabEval</literal>returns when the <literal>instruction</literal> + evaluation is finished. The scilab <literal>instruction</literal> + evaluation may be interrupted by new or queued commands. + </para> + <para> + If the <literal>"seq"</literal> option is added, the associated + instruction evaluation should be finished (or paused) before any + queued instruction evaluation can be started. The scilab + <literal>instruction</literal> evaluation may not be interrupted by new or + queued commands (except if it is paused). + </para> + <para/> + </listitem> + </varlistentry> + <varlistentry> + <term>ScilabEval "flush"</term> + <listitem> + <para> + If the <literal>ScilabEval "flush"</literal> syntax is used, all the + previously queued <literal>instructions</literal> are executed immediately + and the ScilabEval returns when the execution is finished. Each + <literal>instruction</literal> is executed with the option used at the time + of queuing up (i.e. <literal>seq</literal> or no option). + </para> + </listitem> + </varlistentry> + </variablelist> + <para>The evaluation context of all these cases is the current Scilab context + when the<literal>instruction</literal> evaluation starts. + </para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//Callbacks and "seq" option usage + +//create tcl instructions +tcl_script=['toplevel .w1' + 'button .w1.b -text ""Click here to execute without seq option"" -command WithoutSeq' + 'button .w1.b1 -text ""Click here to execute with seq option"" -command WithSeq' + 'pack .w1.b .w1.b1' + 'proc WithoutSeq {} { '; + ' ScilabEval ""cont=%f;;cont=%t;"" ' + ' ScilabEval ""if cont then disp(''ok''),else disp(''wrong'');end;cont=%f;"" ' + '}' + 'proc WithSeq {} { '; + ' ScilabEval ""cont=%f;;cont=%t;"" ""seq""' + ' ScilabEval ""if cont then disp(''ok''),else disp(''wrong'');end;cont=%f;"" ' + '}']; +mputl(tcl_script,TMPDIR+'/test.tcl') //write them to a file + +// Execute the tcl script +cont=%f; +TCL_EvalFile(TMPDIR+'/test.tcl');; + +//scripts and "sync" option usage + +//----------------without "sync"---------------- +tcl_script=[' set t ""0""' + ' while {$t != ""10""} {' + ' ScilabEval ""a=$t;mprintf(''%d '',a);""' + ' incr t' + ' }']; + +mputl(tcl_script,TMPDIR+'/test.tcl') //write them to a file + +// Execute the tcl script +TCL_EvalFile(TMPDIR+'/test.tcl');mprintf('TCL_EvalFile finished\n'); + +// The ScilabEval are executed after the and of TCL_EvalFile + +//----------------with "sync"---------------- +tcl_script=[' set t ""0""' + ' while {$t != ""10""} {' + ' ScilabEval ""a=$t;mprintf(''%d '',a);"" ""sync""' + ' incr t' + ' }']; + +mputl(tcl_script,TMPDIR+'/test.tcl') //write them to a file + +// Execute the tcl script +TCL_EvalFile(TMPDIR+'/test.tcl');mprintf('TCL_EvalFile finished\n'); + +// The ScilabEval are executed synchronously with TCL_EvalFile + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_CreateSlave.xml b/modules/tclsci/help/en_US/TCL_CreateSlave.xml new file mode 100755 index 000000000..f97c1de71 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_CreateSlave.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_CreateSlave"> + <refnamediv> + <refname>TCL_CreateSlave</refname> + <refpurpose>Create a TCL slave + interpreter + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>TCL_CreateSlave(slaveName[, isSafe])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>slaveName</term> + <listitem> + <para>String: Name of the TCL slave interpreter to create.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>isSafe</term> + <listitem> + <para> + Boolean: <literal>%T</literal> to create a safe slave interpreter, <literal>%F</literal> otherwise. The default value is <literal>%F</literal>. A safe slave is not allowed to perform some operations, see the TCL documentation for more information. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to create a TCL slave interpreter.</para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_CreateSlave("TCLinterp") +TCL_SetVar("a","r","TCLinterp") +TCL_ExistVar("a","TCLinterp") +TCL_ExistVar("a") +TCL_DeleteInterp("TCLinterp") + +TCL_CreateSlave("TCLinterp", %T) +TCL_SetVar("a","r","TCLinterp") +TCL_ExistVar("a","TCLinterp") +TCL_ExistVar("a") +TCL_DeleteInterp("TCLinterp") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_DeleteInterp.xml b/modules/tclsci/help/en_US/TCL_DeleteInterp.xml new file mode 100755 index 000000000..8819f015e --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_DeleteInterp.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_DeleteInterp"> + <refnamediv> + <refname>TCL_DeleteInterp</refname> + <refpurpose>delete TCL interpreter</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>TCL_DeleteInterp(interp) + TCL_DeleteInterp() + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>interp</term> + <listitem> + <para>character string parameter. Name of the slave tcl + interpreter to delete. If not provided, it defaults to the main tcl interpreter created by Scilab. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to delete a TCL slave interpreter or the main scilab TCL interpreter.</para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_SetVar("Scilab","OK") +TCL_ExistVar("Scilab") +TCL_DeleteInterp() +TCL_ExistVar("Scilab") +TCL_CreateSlave('BisInterp') +TCL_ExistInterp('BisInterp') +TCL_SetVar("Scilab","OK",'BisInterp') +TCL_ExistVar("Scilab",'BisInterp') +TCL_DeleteInterp('BisInterp') +TCL_ExistInterp('BisInterp') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + <member> + <link linkend="TCL_ExistInterp">TCL_ExistInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_EvalFile.xml b/modules/tclsci/help/en_US/TCL_EvalFile.xml new file mode 100755 index 000000000..b769869f6 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_EvalFile.xml @@ -0,0 +1,128 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_EvalFile"> + <refnamediv> + <refname>TCL_EvalFile</refname> + <refpurpose>Reads and evaluate a tcl/tk + file + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>TCL_EvalFile(filename [,interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>filename</term> + <listitem> + <para>character string. Contains the name of the file to read and + evaluate. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>With this routine, one can read and evaluate the content of a file + containing tcl/tk scripts. This allows to create powerful tk + interfaces. + </para> + <para>The filename might be relative or absolute.</para> + </refsection> + <refsection> + <title>Advantages and drawbacks of this functionality</title> + <para>This routines allows to use directly tcl/tk scripts. This thus allows, + for instance to use Interface Builders such as SpecTcl to design the + interface. The interfaces built directly with tcl/tk scripts are much + faster than the ones built with the Scilab Graphic Object library provided + with tksci (see uicontrol for example). Indeed, those Objects are warpings + around tk graphic widgets. Nevertheless, this way of creating graphic user + interface should only be used when one aims at addressing directly + specific tk/tcl features. There are two main reasons for this. First of + all, there is no simple way to manipulate Scilab objects from within a + tcl/tk script. Thus, the interface designer has to write two sets of + callbacks routines. One to describe the changes occuring in the interface + when the user acts on the widgets. The second set of call routines will + perform the (pure) Scilab reactions to the user actions. + </para> + <para>Here is an example: Suppose you design a scrollbar corresponding to a + spline tension value. You want the spline to be displayed in a graphic + windows and updated each time the user moves the scrollbar. At the same + time, you want the value of this tension parameter to be displayed within + the Interface. You will have to write a first tcl/tk (callback) function + which will be automatically called by the tk scrollbar ("-command" + option). This callback function will update the displayed value of the + parameter in the interface and will then call the scilab routine + ("ScilabEval" command) to update the graph. + </para> + </refsection> + <refsection> + <title>Remarks on the tcl/tk script style</title> + <para>Because Scilab manages the tcl/tk events, it creates the root window + ".", this window should not be destroyed nor directly used by your tcl/tk + scripts. You should thus always create your own toplevel windows. + Moreover, since this module was written at a time when namespaces didn't + exist, some variables defined by scilab tcl/tk scripts could collide your + code. Running your scripts in a slave interpreter may help in such a + case. + </para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_EvalFile(SCI+"/modules/tclsci/demos/tk/puzzle"); + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_EvalStr.xml b/modules/tclsci/help/en_US/TCL_EvalStr.xml new file mode 100755 index 000000000..4fc436a8d --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_EvalStr.xml @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_EvalStr"> + <refnamediv> + <refname>TCL_EvalStr</refname> + <refpurpose>Evaluate a string whithin the Tcl/Tk interpreter</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>TCL_EvalStr(str [,interp]) + res = TCL_EvalStr(str [,interp]) + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>str</term> + <listitem> + <para>string or matrix of strings, contains a Tcl/Tk script in each + element. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave Tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main Tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>res</term> + <listitem> + <para>result of the evaluation, if it is successful. This is a + character string matrix giving the evaluation result for each + element of the input argument str + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to evaluate Tcl/Tk instructions with the Tcl/Tk + interpreter launched with Scilab (when the <literal>interp</literal> parameter + is not given), or in a slave interpreter. + </para> + <para>When Tcl/Tk support is enabled in Scilab, you can evaluate Tcl/Tk + expression from Scilab interpreter. In fact, Scilab launches a main Tcl/Tk + interpreter. The Scilab instruction <literal>TCL_EvalStr</literal> can be used + to evaluate expressions without having to write Tcl/Tk instructions in a + separated file (this capability is provided by + <literal>TCL_EvalFile</literal>). + </para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +//with one call +TCL_EvalStr(["toplevel .foo1" + "label .foo1.l -text ""TK married Scilab !!!""" + "pack .foo1.l" + "button .foo1.b -text close -command {destroy .foo1}" + "pack .foo1.b"]) + +//step by step (debugging) +TCL_EvalStr("toplevel .foo2"); + +// creates a toplevel TK window. +TCL_EvalStr("label .foo2.l -text ""TK married Scilab !!!"""); + +// create a static label +TCL_EvalStr("pack .foo2.l"); + +// pack the label widget. It appears on the screen. +text="button .foo2.b -text close -command {destroy .foo2}"; +TCL_EvalStr(text); +TCL_EvalStr("pack .foo2.b"); + +//kill the windows by program +TCL_EvalStr("destroy .foo1"); +TCL_EvalStr("destroy .foo2"); + +//with one call, and in a slave interpreter +TCL_CreateSlave('TCLSlave'); +TCL_EvalStr('set test ""in Slave TCL Interp""','TCLSlave'); +TCL_GetVar('test','TCLSlave') + +TCL_DeleteInterp('TCLSlave') + +// return a result +res = TCL_EvalStr("expr 1+1") +res = TCL_EvalStr("tk_messageBox -message Hello -type okcancel") +res = TCL_EvalStr(["expr 4+5" "lsearch -all {a b c a b c} c" ; "list [list a b c] [list d e f] [list g h i]" "llength {a b c d e}"]) + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_ExistArray.xml b/modules/tclsci/help/en_US/TCL_ExistArray.xml new file mode 100755 index 000000000..3114a85e2 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_ExistArray.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_ExistArray"> + <refnamediv> + <refname>TCL_ExistArray</refname> + <refpurpose>Return %T if a tcl array + exists + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>OK=TCL_ExistArray(arrayname [,interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>arrayname</term> + <listitem> + <para>character string. Contains the name of the tcl/tk + array. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ok</term> + <listitem> + <para>boolean. %T if arrayname exists.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to test if a tcl array exists.</para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_ExistVar("A") +a=["A","B","C";"D","E","F"]; +TCL_SetVar("A",a) +TCL_ExistVar("A") +TCL_ExistArray("A") + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_ExistInterp.xml b/modules/tclsci/help/en_US/TCL_ExistInterp.xml new file mode 100755 index 000000000..00bc15baa --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_ExistInterp.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_ExistInterp"> + <refnamediv> + <refname>TCL_ExistInterp</refname> + <refpurpose>Return %T if a tcl slave interperter + exists + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>OK=TCL_ExistInterp(interp)</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>interp</term> + <listitem> + <para>character string parameter. Name of the slave tcl + interpreter. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ok</term> + <listitem> + <para>boolean. %T if TCL interpreter exists.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to test if TCL interpreter exists.</para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_ExistInterp('SlaveInterp') +TCL_CreateSlave('SlaveInterp') +TCL_ExistInterp('SlaveInterp') +TCL_DeleteInterp('SlaveInterp') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + <member> + <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_ExistVar.xml b/modules/tclsci/help/en_US/TCL_ExistVar.xml new file mode 100755 index 000000000..a9a95e7e2 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_ExistVar.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_ExistVar"> + <refnamediv> + <refname>TCL_ExistVar</refname> + <refpurpose>Return %T if a tcl variable + exists + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>OK=TCL_ExistVar(varname [,interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>varname</term> + <listitem> + <para>character string. Contains the name of the tcl/tk + variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ok</term> + <listitem> + <para>boolean. %T if varname exists.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to test if a tcl variable exists.</para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_SetVar("Scilab","OK") +TCL_GetVar("Scilab") +TCL_UnsetVar("Scilab") +TCL_ExistVar("Scilab") + +TCL_SetVar("aa",1) +TCL_CreateSlave('SlaveInterp'); +TCL_SetVar("aa",2,'SlaveInterp') +TCL_ExistVar("aa") +TCL_GetVar("aa") +TCL_UnsetVar("aa") +TCL_GetVar("aa",'SlaveInterp') +TCL_UnsetVar("aa",'SlaveInterp') +TCL_ExistVar("aa",'SlaveInterp') +TCL_DeleteInterp('SlaveInterp') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_GetVar.xml b/modules/tclsci/help/en_US/TCL_GetVar.xml new file mode 100755 index 000000000..c471269f6 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_GetVar.xml @@ -0,0 +1,166 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_GetVar"> + <refnamediv> + <refname>TCL_GetVar</refname> + <refpurpose>Get a tcl/tk variable + value + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>value=TCL_GetVar(Varname [,interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>varname</term> + <listitem> + <para>character string. Contains the name of the tcl/tk + variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem> + <para>may be a character string or a strings matrix. Contains the + value of the tcl/tk variable <literal>varname</literal> in the interpreter + <literal>interp</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>When tcl/tk support is enabled in Scilab, this routine can be used to + retreive the value of a tcl/tk variable. + </para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_EvalStr("toplevel .tst1"); + +// creates a toplevel TK window. +TCL_EvalStr("entry .tst1.e -textvariable tvar"); + +// create an editable entry +TCL_EvalStr("set tvar foobar"); + +// set the entry value +TCL_EvalStr("pack .tst1.e"); + +// pack the entry widget. It appears on the screen. +text=TCL_GetVar("tvar") + +// retrieve the variable value +// change the entry text and repeat the last command ... +//delete the toplevel TK window. +TCL_EvalStr("destroy .tst1") + +//---------------------------------------------------- +a=["A","B","C";"D","E","F"]; +TCL_SetVar("A",a) +AfromTCL=TCL_GetVar("A") + +//---------------------------------------------------- +b=[6,4,1;2,3,5]; +TCL_SetVar("B",b) +BfromTCL=TCL_GetVar("B") + +//---------------------------------------------------- +TCL_SetVar("StringTCL","string") +StringFromTCL=TCL_GetVar("StringTCL") + +//---------------------------------------------------- +TCL_SetVar("ScalarTCL",1.22) +ScalarFromTCL=TCL_GetVar("ScalarTCL") + +//---------------------------------------------------- +// Examples with a slave interpreter +//---------------------------------------------------- +a=['AA','BB','CC';'DD','EE','FF']; +TCL_CreateSlave('SlaveInterp') +TCL_SetVar("A_slave",a,'SlaveInterp') +AfromTCL_slave=TCL_GetVar('A_slave','SlaveInterp') +TCL_DeleteInterp('SlaveInterp') + +//---------------------------------------------------- +b=[66,44,11;22,33,55]; +TCL_CreateSlave('SlaveInterp1') +TCL_SetVar("B_slave",b,'SlaveInterp1') +BfromTCL_slave=TCL_GetVar('B_slave','SlaveInterp1') +TCL_DeleteInterp('SlaveInterp1') + +//---------------------------------------------------- +TCL_CreateSlave('SlaveInterp2') +TCL_SetVar("StringTCL_slave","string in slave interpreter",'SlaveInterp2') +StringFromTCL_slave=TCL_GetVar("StringTCL_slave",'SlaveInterp2') +TCL_DeleteInterp('SlaveInterp2') + +//---------------------------------------------------- +TCL_CreateSlave('SlaveInterp3') +TCL_SetVar("ScalarTCL_slave",1.22,'SlaveInterp3') +ScalarFromTCL_slave=TCL_GetVar("ScalarTCL_slave",'SlaveInterp3') +TCL_DeleteInterp('SlaveInterp3') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + <member> + <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_GetVersion.xml b/modules/tclsci/help/en_US/TCL_GetVersion.xml new file mode 100755 index 000000000..47b3c0088 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_GetVersion.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_GetVersion"> + <refnamediv> + <refname>TCL_GetVersion</refname> + <refpurpose>get the version of the TCL/TK + library at runtime. + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>TCL_GetVersion() + ret=TCL_GetVersion('numbers') + </synopsis> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para>get the version of the TCL/TK library at runtime.</para> + <para>ret=TCL_GetVersion('numbers') returns a matrix with the version of the + TCL/TK library at runtime. + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_GetVersion() +TCL_GetVersion("numbers") + ]]></programlisting> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_SetVar.xml b/modules/tclsci/help/en_US/TCL_SetVar.xml new file mode 100755 index 000000000..b803e5376 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_SetVar.xml @@ -0,0 +1,168 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_SetVar"> + <refnamediv> + <refname>TCL_SetVar</refname> + <refpurpose>Set a tcl/tk variable + value + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>TCL_SetVar(varname, value [,interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>varname</term> + <listitem> + <para>character string. Contains the name of the tcl/tk variable to + set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem> + <para>may be a character string, a scalar, a real or string matrix + (m x n). Contains the value to give to the tcl/tk variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to set a variable within a tcl/tk interpreter. When + tcl/tk support is enabled in scilab, this routine can be used to set up + the value of a tcl/tk variable. This can be useful to change some value in + the tcl/tk interpreter without having to build a tcl/tk instruction (and + use <literal>TCL_EvalStr</literal>). + </para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_EvalStr("toplevel .tst1"); + +// creates a toplevel TK window. +TCL_EvalStr("entry .tst1.e -textvariable tvar"); + +// create an editable entry +TCL_EvalStr("set tvar foobar"); + +// set the entry value +TCL_EvalStr("pack .tst1.e"); + +// pack the entry widget. It appears on the screen. +text=TCL_GetVar("tvar") + +// retrieve the variable value +// change the entry text and repeat the last command ... +//delete the toplevel TK window. +TCL_EvalStr("destroy .tst1") + +//---------------------------------------------------- +a=["A","B","C";"D","E","F"]; +TCL_SetVar("A",a) +AfromTCL=TCL_GetVar("A") + +//---------------------------------------------------- +b=[6,4,1;2,3,5]; +TCL_SetVar("B",b) +BfromTCL=TCL_GetVar("B") + +//---------------------------------------------------- +TCL_SetVar("StringTCL","string") +StringFromTCL=TCL_GetVar("StringTCL") + +//---------------------------------------------------- +TCL_SetVar("ScalarTCL",1.22) +ScalarFromTCL=TCL_GetVar("ScalarTCL") + +//---------------------------------------------------- +// Examples with a slave interpreter +//---------------------------------------------------- +TCL_CreateSlave('TCLSlave') +a=['AA','BB','CC';'DD','EE','FF']; +TCL_SetVar("A_slave",a,'TCLSlave') +AfromTCL_slave=TCL_GetVar('A_slave','TCLSlave') +TCL_DeleteInterp('TCLSlave') + +//---------------------------------------------------- +TCL_CreateSlave('TCLSlave') +b=[66,44,11;22,33,55]; +TCL_SetVar("B_slave",b,'TCLSlave') +BfromTCL_slave=TCL_GetVar('B_slave','TCLSlave') +TCL_DeleteInterp('TCLSlave') + +//---------------------------------------------------- +TCL_CreateSlave('TCLSlave') +TCL_SetVar("StringTCL_slave","string in slave interpreter",'TCLSlave') +StringFromTCL_slave=TCL_GetVar("StringTCL_slave",'TCLSlave') +TCL_DeleteInterp('TCLSlave') + +//---------------------------------------------------- +TCL_CreateSlave('TCLSlave') +TCL_SetVar("ScalarTCL_slave",1.22,'TCLSlave') +ScalarFromTCL_slave=TCL_GetVar("ScalarTCL_slave",'TCLSlave') +TCL_DeleteInterp('TCLSlave') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + <member> + <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_UnsetVar.xml b/modules/tclsci/help/en_US/TCL_UnsetVar.xml new file mode 100755 index 000000000..13bec2f61 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_UnsetVar.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_UnsetVar"> + <refnamediv> + <refname>TCL_UnsetVar</refname> + <refpurpose>Remove a tcl + variable + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>OK=TCL_UnsetVar(varname [,interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>varname</term> + <listitem> + <para>character string. Contains the name of the tcl/tk variable to + unset. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ok</term> + <listitem> + <para>boolean. %T if varname was deleted.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>This routine allows to unset a tcl variable.</para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_SetVar("Scilab","OK") +TCL_GetVar("Scilab") +TCL_UnsetVar("Scilab") +TCL_ExistVar("Scilab") + +TCL_CreateSlave('InterpSlave'); +TCL_SetVar("Scilab","Good",'InterpSlave') +TCL_GetVar("Scilab",'InterpSlave') +TCL_UnsetVar("Scilab",'InterpSlave') +TCL_ExistVar("Scilab",'InterpSlave') +TCL_DeleteInterp('InterpSlave') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_UpVar">TCL_UpVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + <member> + <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/TCL_UpVar.xml b/modules/tclsci/help/en_US/TCL_UpVar.xml new file mode 100755 index 000000000..ba4f2f114 --- /dev/null +++ b/modules/tclsci/help/en_US/TCL_UpVar.xml @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) 2006 - INRIA - Allan CORNET + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="TCL_UpVar"> + <refnamediv> + <refname>TCL_UpVar</refname> + <refpurpose>Make a link from a tcl source variable + to a tcl destination variable + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>OK=TCL_UpVar(varname1,varname2,[interp])</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>varname1</term> + <listitem> + <para>character string. Contains the name of the tcl source + variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>varname2</term> + <listitem> + <para>character string. Contains the name of the tcl destination + variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>interp</term> + <listitem> + <para>optional character string parameter. Name of the slave tcl + interpreter in which the operation has to be performed. If not + provided, it defaults to the main tcl interpreter created by + Scilab. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ok</term> + <listitem> + <para>boolean. %T if it is ok.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para>Make a link from a tcl source variable to a tcl destination + variable. + </para> + <para> + More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink> + </para> + </refsection> + <refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +TCL_SetVar("Scilab","OK") +TCL_UpVar("Scilab","ScilabBis") +TCL_GetVar("ScilabBis") +TCL_SetVar("Scilab","NOK") +TCL_GetVar("ScilabBis") +TCL_SetVar("ScilabBis","modified") +TCL_GetVar("ScilabBis") +TCL_GetVar("Scilab") + +TCL_CreateSlave('InterpBis') +TCL_SetVar("Scilab","Good",'InterpBis') +TCL_UpVar("Scilab","ScilabBis",'InterpBis') +TCL_GetVar("ScilabBis",'InterpBis') +TCL_SetVar("Scilab","Not good",'InterpBis') +TCL_GetVar("ScilabBis",'InterpBis') +TCL_SetVar("ScilabBis","modified again",'InterpBis') +TCL_GetVar("ScilabBis",'InterpBis') +TCL_GetVar("Scilab",'InterpBis') +TCL_DeleteInterp('InterpBis') + ]]></programlisting> + </refsection> + <refsection role="see also"> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="ScilabEval">ScilabEval</link> + </member> + <member> + <link linkend="TCL_EvalFile">TCL_EvalFile</link> + </member> + <member> + <link linkend="TCL_EvalStr">TCL_EvalStr</link> + </member> + <member> + <link linkend="TCL_GetVar">TCL_GetVar</link> + </member> + <member> + <link linkend="TCL_SetVar">TCL_SetVar</link> + </member> + <member> + <link linkend="TCL_ExistVar">TCL_ExistVar</link> + </member> + <member> + <link linkend="TCL_UnsetVar">TCL_UnsetVar</link> + </member> + <member> + <link linkend="TCL_CreateSlave">TCL_CreateSlave</link> + </member> + <member> + <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link> + </member> + </simplelist> + </refsection> +</refentry> diff --git a/modules/tclsci/help/en_US/addchapter.sce b/modules/tclsci/help/en_US/addchapter.sce new file mode 100755 index 000000000..d25418e4c --- /dev/null +++ b/modules/tclsci/help/en_US/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Tcl/Tk Interface",SCI+"/modules/tclsci/help/en_US",%T); + diff --git a/modules/tclsci/help/en_US/winlist.xml b/modules/tclsci/help/en_US/winlist.xml new file mode 100755 index 000000000..f0531afea --- /dev/null +++ b/modules/tclsci/help/en_US/winlist.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) Jaime Urzua + * + * This file must be used under the terms of the CeCILL. + * This source file is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at + * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + * + --> +<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="winlist"> + <refnamediv> + <refname>winlist</refname> + <refpurpose>Return the winId of current window created by sciGUI</refpurpose> + </refnamediv> + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>winIds=winlist()</synopsis> + </refsynopsisdiv> + <refsection> + <title>Arguments</title> + <variablelist> + <varlistentry> + <term>winIds</term> + <listitem> + <para>matrix of integer greater than 0, window identificator.</para> + </listitem> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Description</title> + <para> + <literal>winlist()</literal> Return the winId of current window created by sciGUI. + </para> + </refsection> +</refentry> diff --git a/modules/tclsci/help/fr_FR/addchapter.sce b/modules/tclsci/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..8e8b928f5 --- /dev/null +++ b/modules/tclsci/help/fr_FR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Interface avec Tcl/Tk",SCI+"/modules/tclsci/help/fr_FR",%T); + diff --git a/modules/tclsci/help/ja_JP/addchapter.sce b/modules/tclsci/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..f4a8dae04 --- /dev/null +++ b/modules/tclsci/help/ja_JP/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Tcl/Tk Interface",SCI+"/modules/tclsci/help/ja_JP",%T); + diff --git a/modules/tclsci/help/pt_BR/addchapter.sce b/modules/tclsci/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..4ef135958 --- /dev/null +++ b/modules/tclsci/help/pt_BR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Interfaces com Tcl/Tk",SCI+"/modules/tclsci/help/pt_BR",%T); + diff --git a/modules/tclsci/help/ru_RU/addchapter.sce b/modules/tclsci/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..b341e72b5 --- /dev/null +++ b/modules/tclsci/help/ru_RU/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Tcl/Tk Interface",SCI+"/modules/tclsci/help/ru_RU",%T); + |