File: uiInsertNode.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (131 lines) | stat: -rw-r--r-- 4,493 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?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" version="5.0-subset Scilab" xml:lang="en" xml:id="uiInsertNode">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>uiInsertNode</refname>
    <refpurpose> Insertion in a Tree </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>insertTree = uiInsertNode(tree, position, node)</synopsis>
    <synopsis>insertTree = uiInsertNode(tree, parentNode, node)</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Input parameters</title>
    <variablelist>
      <varlistentry>
        <term>tree</term>
        <listitem>
          <para>Tree were we do the insertion</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>position</term>
        <listitem>
          <para>a string, which is the position where we want to insert the node</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>parentNode</term>
        <listitem>
          <para>which is the parent node into we want to insert the node</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>node</term>
        <listitem>
          <para>node we want to insert</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
	<title>Output parameters</title>
	<variablelist>
	  <varlistentry>
        <term>insertTree</term>
        <listitem>
          <para>a Tree with the node inserted</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
    	Insertion of a node (subTree) into a tree.
    	If we have 2 nodes called 'Node1' and 'Node2' each one at position 1.1 and 1.2. Insertion of a new node 'Node3' at position '1.2',  will move the 'Node2' to position 1.3.
    </para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[ 
// We should create nodes(subTrees) before creating trees	
leaf11 = uiCreateNode('leaf 1.1', 'iconLeaf1.1', 'callbackLeaf1.1')
leaf12 = uiCreateNode('leaf 1.2', 'iconLeaf1.2', 'callbackLeaf1.2')
leaf31 = uiCreateNode('leaf 3.1', 'iconLeaf3.1', 'callbackLeaf3.1')
leaf32 = uiCreateNode('leaf 3.2', 'iconLeaf3.2', 'callbackLeaf3.2')
node1 = uiCreateNode('Node 1', 'iconNode1', 'callbackNode1')
node2 = uiCreateNode('Node 2', 'iconNode2', 'callbackNode2')
node3 = uiCreateNode('Node 3', 'iconNode3', 'callbackNode3')
root = uiCreateNode('Root', 'iconRoot', 'callbackRoot')

treeNode1 = uiCreateTree(node1, leaf11, leaf12)
treeNode3 = uiCreateTree(node3, leaf31, leaf32)
treeRoot = uiCreateTree(root, treeNode1, node2, treeNode3)

// Creation of a new nodes to insert
leaf13 = uiCreateNode('leaf 1.3', 'iconLeaf1.3', 'callbackLeaf1.3')
testNode = uiCreateNode('test', 'icon_test', 'callback_test')

// Insertion of 'leaf13' in 'node2'
treeInsert = uiInsertNode(treeRoot, node2, leaf13)
uiDisplayTree(treeInsert)

// Insertion of 'testNode' at position '1.1'
treeInsert = uiInsertNode(treeRoot, '1.1', testNode)
uiDisplayTree(treeInsert)

 ]]></programlisting>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="uiCreateNode">uiCreateNode</link> 
      </member>
      <member>
        <link linkend="uiCreateTree">uiCreateTree</link> 
      </member>
      <member>
        <link linkend="uiDisplayTree">uiDisplayTree</link> 
      </member>
      <member>
        <link linkend="uiDumpTree">uiDumpTree</link> 
      </member>
      <member>
        <link linkend="uiDeleteNode">uiDeleteNode</link> 
      </member>
      <member>
        <link linkend="uiConcatTree">uiConcatTree</link> 
      </member>
      <member>
        <link linkend="uiEqualsTree">uiEqualsTree</link> 
      </member>
      <member>
        <link linkend="uiFindNode">uiFindNode</link> 
      </member>
      <member>
        <link linkend="uiGetParentNode">uiGetParentNode</link> 
      </member>
      <member>
        <link linkend="uiGetChildrenNode">uiGetChildrenNode</link> 
      </member>
      <member>
        <link linkend="uiGetNodePosition">uiGetNodePosition</link> 
      </member>
    </simplelist>
  </refsection>
</refentry>