← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/gui/help/en_US/tree/uiCreateNode.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/gui/help/en_US/tree/uiCreateNode.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<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="uiCreateNode">
3
 
  <refnamediv>
4
 
    <refname>uiCreateNode</refname>
5
 
    <refpurpose> Creation of node (for Scilab Tree) </refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>myNode = uiCreateNode(label[, icon[, callback]])
10
 
    </synopsis>
11
 
  </refsynopsisdiv>
12
 
  <refsection>
13
 
    <title>Input parameters</title>
14
 
    <variablelist>
15
 
      <varlistentry>
16
 
        <term>label</term>
17
 
        <listitem>
18
 
          <para>a string matrix which gives the label of the nodes.</para>
19
 
        </listitem>
20
 
      </varlistentry>
21
 
      <varlistentry>
22
 
        <term>icon (optional)</term>
23
 
        <listitem>
24
 
          <para>a string matrix which gives the icon image of the nodes.</para>
25
 
        </listitem>
26
 
      </varlistentry>
27
 
      <varlistentry>
28
 
        <term>callback (optional)</term>
29
 
        <listitem>
30
 
          <para>a string matrix which gives the callback instruction of the nodes.</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
    </variablelist>
34
 
  </refsection>
35
 
  <refsection>
36
 
    <title>Output parameters</title>
37
 
    <variablelist>
38
 
      <varlistentry>
39
 
        <term>myNode</term>
40
 
        <listitem>
41
 
          <para>a node of type Tree</para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
    </variablelist>
45
 
  </refsection>
46
 
  <refsection>
47
 
    <title>Description</title>
48
 
    <para>Creates a node(a node or a leaf) of type Tree.</para>
49
 
  </refsection>
50
 
  <refsection>
51
 
    <title>Examples</title>
52
 
    <programlisting role="example"><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>uiCreateNode</refname>
 
5
        <refpurpose> Creation of node (for Scilab Tree) </refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>myNode = uiCreateNode(label[, icon[, callback]])
 
10
        </synopsis>
 
11
    </refsynopsisdiv>
 
12
    <refsection>
 
13
        <title>Input parameters</title>
 
14
        <variablelist>
 
15
            <varlistentry>
 
16
                <term>label</term>
 
17
                <listitem>
 
18
                    <para>a string matrix which gives the label of the nodes.</para>
 
19
                </listitem>
 
20
            </varlistentry>
 
21
            <varlistentry>
 
22
                <term>icon (optional)</term>
 
23
                <listitem>
 
24
                    <para>a string matrix which gives the icon image of the nodes.</para>
 
25
                </listitem>
 
26
            </varlistentry>
 
27
            <varlistentry>
 
28
                <term>callback (optional)</term>
 
29
                <listitem>
 
30
                    <para>a string matrix which gives the callback instruction of the nodes.</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
        </variablelist>
 
34
    </refsection>
 
35
    <refsection>
 
36
        <title>Output parameters</title>
 
37
        <variablelist>
 
38
            <varlistentry>
 
39
                <term>myNode</term>
 
40
                <listitem>
 
41
                    <para>a node of type Tree</para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
        </variablelist>
 
45
    </refsection>
 
46
    <refsection>
 
47
        <title>Description</title>
 
48
        <para>Creates a node(a node or a leaf) of type Tree.</para>
 
49
    </refsection>
 
50
    <refsection>
 
51
        <title>Examples</title>
 
52
        <programlisting role="example"><![CDATA[ 
53
53
leaf11 = uiCreateNode('leaf 1.1', 'iconLeaf1.1', 'callbackLeaf1.1')
54
54
leaf12 = uiCreateNode('leaf 1.2', 'iconLeaf1.2', 'callbackLeaf1.2')
55
55
leaf31 = uiCreateNode('leaf 3.1', 'iconLeaf3.1', 'callbackLeaf3.1')
59
59
node3 = uiCreateNode('Node 3', 'iconNode3', 'callbackNode3')
60
60
root = uiCreateNode('Root', 'iconRoot', 'callbackRoot')
61
61
 ]]></programlisting>
62
 
  </refsection>
63
 
  <refsection role="see also">
64
 
    <title>See Also</title>
65
 
    <simplelist type="inline">
66
 
      <member>
67
 
        <link linkend="uiCreateTree">uiCreateTree</link>
68
 
      </member>
69
 
      <member>
70
 
        <link linkend="uiDisplayTree">uiDisplayTree</link>
71
 
      </member>
72
 
      <member>
73
 
        <link linkend="uiDumpTree">uiDumpTree</link>
74
 
      </member>
75
 
      <member>
76
 
        <link linkend="uiInsertNode">uiInsertNode</link>
77
 
      </member>
78
 
      <member>
79
 
        <link linkend="uiDeleteNode">uiDeleteNode</link>
80
 
      </member>
81
 
      <member>
82
 
        <link linkend="uiConcatTree">uiConcatTree</link>
83
 
      </member>
84
 
      <member>
85
 
        <link linkend="uiEqualsTree">uiEqualsTree</link>
86
 
      </member>
87
 
      <member>
88
 
        <link linkend="uiFindNode">uiFindNode</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="uiGetParentNode">uiGetParentNode</link>
92
 
      </member>
93
 
      <member>
94
 
        <link linkend="uiGetChildrenNode">uiGetChildrenNode</link>
95
 
      </member>
96
 
      <member>
97
 
        <link linkend="uiGetNodePosition">uiGetNodePosition</link>
98
 
      </member>
99
 
    </simplelist>
100
 
  </refsection>
 
62
    </refsection>
 
63
    <refsection role="see also">
 
64
        <title>See Also</title>
 
65
        <simplelist type="inline">
 
66
            <member>
 
67
                <link linkend="uiCreateTree">uiCreateTree</link>
 
68
            </member>
 
69
            <member>
 
70
                <link linkend="uiDisplayTree">uiDisplayTree</link>
 
71
            </member>
 
72
            <member>
 
73
                <link linkend="uiDumpTree">uiDumpTree</link>
 
74
            </member>
 
75
            <member>
 
76
                <link linkend="uiInsertNode">uiInsertNode</link>
 
77
            </member>
 
78
            <member>
 
79
                <link linkend="uiDeleteNode">uiDeleteNode</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="uiConcatTree">uiConcatTree</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="uiEqualsTree">uiEqualsTree</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="uiFindNode">uiFindNode</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="uiGetParentNode">uiGetParentNode</link>
 
92
            </member>
 
93
            <member>
 
94
                <link linkend="uiGetChildrenNode">uiGetChildrenNode</link>
 
95
            </member>
 
96
            <member>
 
97
                <link linkend="uiGetNodePosition">uiGetNodePosition</link>
 
98
            </member>
 
99
        </simplelist>
 
100
    </refsection>
101
101
</refentry>