← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/tclsci/help/en_US/TCL_GetVar.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/tclsci/help/en_US/TCL_GetVar.xml
11
11
 *
12
12
 -->
13
13
<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" version="5.0-subset Scilab" xml:lang="en" xml:id="TCL_GetVar">
14
 
  <refnamediv>
15
 
    <refname>TCL_GetVar</refname>
16
 
    <refpurpose>Get a tcl/tk variable
17
 
      value
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>value=TCL_GetVar(Varname [,interp])</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>varname</term>
29
 
        <listitem>
30
 
          <para>character string. Contains the name of the tcl/tk
31
 
            variable.
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>interp</term>
37
 
        <listitem>
38
 
          <para>optional character string parameter. Name of the slave tcl
39
 
            interpreter in which the operation has to be performed. If not
40
 
            provided, it defaults to the main tcl interpreter created by
41
 
            Scilab.
42
 
          </para>
43
 
        </listitem>
44
 
      </varlistentry>
45
 
      <varlistentry>
46
 
        <term>value</term>
47
 
        <listitem>
48
 
          <para>may be a character string or a strings matrix. Contains the
49
 
            value of the tcl/tk variable <literal>varname</literal> in the interpreter
50
 
            <literal>interp</literal>.
51
 
          </para>
52
 
        </listitem>
53
 
      </varlistentry>
54
 
    </variablelist>
55
 
  </refsection>
56
 
  <refsection>
57
 
    <title>Description</title>
58
 
    <para>When tcl/tk support is enabled in Scilab, this routine can be used to
59
 
      retreive the value of a tcl/tk variable.
60
 
    </para>
61
 
    <para>
62
 
      More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink>
63
 
    </para>
64
 
  </refsection>
65
 
  <refsection>
66
 
    <title>Examples</title>
67
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>TCL_GetVar</refname>
 
16
        <refpurpose>Get a tcl/tk variable
 
17
            value
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>value=TCL_GetVar(Varname [,interp])</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>varname</term>
 
29
                <listitem>
 
30
                    <para>character string. Contains the name of the tcl/tk
 
31
                        variable.
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>interp</term>
 
37
                <listitem>
 
38
                    <para>optional character string parameter. Name of the slave tcl
 
39
                        interpreter in which the operation has to be performed. If not
 
40
                        provided, it defaults to the main tcl interpreter created by
 
41
                        Scilab.
 
42
                    </para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>value</term>
 
47
                <listitem>
 
48
                    <para>may be a character string or a strings matrix. Contains the
 
49
                        value of the tcl/tk variable <literal>varname</literal> in the interpreter
 
50
                        <literal>interp</literal>.
 
51
                    </para>
 
52
                </listitem>
 
53
            </varlistentry>
 
54
        </variablelist>
 
55
    </refsection>
 
56
    <refsection>
 
57
        <title>Description</title>
 
58
        <para>When tcl/tk support is enabled in Scilab, this routine can be used to
 
59
            retreive the value of a tcl/tk variable.
 
60
        </para>
 
61
        <para>
 
62
            More information about Tcl/Tk: <ulink url="http://www.tcl.tk/doc/">http://www.tcl.tk/doc/</ulink>
 
63
        </para>
 
64
    </refsection>
 
65
    <refsection>
 
66
        <title>Examples</title>
 
67
        <programlisting role="example"><![CDATA[ 
68
68
TCL_EvalStr("toplevel .tst1");
69
69
 
70
70
// creates a toplevel TK window. 
130
130
ScalarFromTCL_slave=TCL_GetVar("ScalarTCL_slave",'SlaveInterp3')
131
131
TCL_DeleteInterp('SlaveInterp3')
132
132
 ]]></programlisting>
133
 
  </refsection>
134
 
  <refsection role="see also">
135
 
    <title>See Also</title>
136
 
    <simplelist type="inline">
137
 
      <member>
138
 
        <link linkend="ScilabEval">ScilabEval</link>
139
 
      </member>
140
 
      <member>
141
 
        <link linkend="TCL_EvalFile">TCL_EvalFile</link>
142
 
      </member>
143
 
      <member>
144
 
        <link linkend="TCL_EvalStr">TCL_EvalStr</link>
145
 
      </member>
146
 
      <member>
147
 
        <link linkend="TCL_SetVar">TCL_SetVar</link>
148
 
      </member>
149
 
      <member>
150
 
        <link linkend="TCL_ExistVar">TCL_ExistVar</link>
151
 
      </member>
152
 
      <member>
153
 
        <link linkend="TCL_UnsetVar">TCL_UnsetVar</link>
154
 
      </member>
155
 
      <member>
156
 
        <link linkend="TCL_UpVar">TCL_UpVar</link>
157
 
      </member>
158
 
      <member>
159
 
        <link linkend="TCL_CreateSlave">TCL_CreateSlave</link>
160
 
      </member>
161
 
      <member>
162
 
        <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link>
163
 
      </member>
164
 
    </simplelist>
165
 
  </refsection>
 
133
    </refsection>
 
134
    <refsection role="see also">
 
135
        <title>See Also</title>
 
136
        <simplelist type="inline">
 
137
            <member>
 
138
                <link linkend="ScilabEval">ScilabEval</link>
 
139
            </member>
 
140
            <member>
 
141
                <link linkend="TCL_EvalFile">TCL_EvalFile</link>
 
142
            </member>
 
143
            <member>
 
144
                <link linkend="TCL_EvalStr">TCL_EvalStr</link>
 
145
            </member>
 
146
            <member>
 
147
                <link linkend="TCL_SetVar">TCL_SetVar</link>
 
148
            </member>
 
149
            <member>
 
150
                <link linkend="TCL_ExistVar">TCL_ExistVar</link>
 
151
            </member>
 
152
            <member>
 
153
                <link linkend="TCL_UnsetVar">TCL_UnsetVar</link>
 
154
            </member>
 
155
            <member>
 
156
                <link linkend="TCL_UpVar">TCL_UpVar</link>
 
157
            </member>
 
158
            <member>
 
159
                <link linkend="TCL_CreateSlave">TCL_CreateSlave</link>
 
160
            </member>
 
161
            <member>
 
162
                <link linkend="TCL_DeleteInterp">TCL_DeleteInterp</link>
 
163
            </member>
 
164
        </simplelist>
 
165
    </refsection>
166
166
</refentry>