← 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/uiEqualsTree.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/uiEqualsTree.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="uiEqualsTree">
3
 
  <refnamediv>
4
 
    <refname>uiEqualsTree</refname>
5
 
    <refpurpose> Comparing two trees </refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>isEqual = uiEqualsTree(tree1, tree2)
10
 
    </synopsis>
11
 
  </refsynopsisdiv>
12
 
  <refsection>
13
 
    <title>Input parameters</title>
14
 
    <variablelist>
15
 
      <varlistentry>
16
 
        <term>tree1, tree2</term>
17
 
        <listitem>
18
 
          <para>are of type Tree</para>
19
 
        </listitem>
20
 
      </varlistentry>
21
 
    </variablelist>
22
 
  </refsection>
23
 
  <refsection>
24
 
    <title>Output parameters</title>
25
 
    <variablelist>
26
 
      <varlistentry>
27
 
        <term>isEqual</term>
28
 
        <listitem>
29
 
          <para>a Boolean, which indicate if those trees are equal or not</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
    </variablelist>
33
 
  </refsection>
34
 
  <refsection>
35
 
    <title>Description</title>
36
 
    <para>
37
 
      Compare two trees structures.
38
 
    </para>
39
 
  </refsection>
40
 
  <refsection>
41
 
    <title>Examples</title>
42
 
    <programlisting role="example"><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>uiEqualsTree</refname>
 
5
        <refpurpose> Comparing two trees </refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>isEqual = uiEqualsTree(tree1, tree2)
 
10
        </synopsis>
 
11
    </refsynopsisdiv>
 
12
    <refsection>
 
13
        <title>Input parameters</title>
 
14
        <variablelist>
 
15
            <varlistentry>
 
16
                <term>tree1, tree2</term>
 
17
                <listitem>
 
18
                    <para>are of type Tree</para>
 
19
                </listitem>
 
20
            </varlistentry>
 
21
        </variablelist>
 
22
    </refsection>
 
23
    <refsection>
 
24
        <title>Output parameters</title>
 
25
        <variablelist>
 
26
            <varlistentry>
 
27
                <term>isEqual</term>
 
28
                <listitem>
 
29
                    <para>a Boolean, which indicate if those trees are equal or not</para>
 
30
                </listitem>
 
31
            </varlistentry>
 
32
        </variablelist>
 
33
    </refsection>
 
34
    <refsection>
 
35
        <title>Description</title>
 
36
        <para>
 
37
            Compare two trees structures.
 
38
        </para>
 
39
    </refsection>
 
40
    <refsection>
 
41
        <title>Examples</title>
 
42
        <programlisting role="example"><![CDATA[ 
43
43
// Creation of trees
44
44
root = uiCreateNode('Root', 'path\rootImage.jpg', 'rootCallback')
45
45
node1 = uiCreateNode('Node 1', 'default', 'node1Callback')
52
52
 
53
53
// will return 'isEqual = T'
54
54
 ]]></programlisting>
55
 
  </refsection>
56
 
  <refsection role="see also">
57
 
    <title>See Also</title>
58
 
    <simplelist type="inline">
59
 
      <member>
60
 
        <link linkend="uiCreateNode">uiCreateNode</link>
61
 
      </member>
62
 
      <member>
63
 
        <link linkend="uiCreateTree">uiCreateTree</link>
64
 
      </member>
65
 
      <member>
66
 
        <link linkend="uiDisplayTree">uiDisplayTree</link>
67
 
      </member>
68
 
      <member>
69
 
        <link linkend="uiDumpTree">uiDumpTree</link>
70
 
      </member>
71
 
      <member>
72
 
        <link linkend="uiInsertNode">uiInsertNode</link>
73
 
      </member>
74
 
      <member>
75
 
        <link linkend="uiDeleteNode">uiDeleteNode</link>
76
 
      </member>
77
 
      <member>
78
 
        <link linkend="uiConcatTree">uiConcatTree</link>
79
 
      </member>
80
 
      <member>
81
 
        <link linkend="uiFindNode">uiFindNode</link>
82
 
      </member>
83
 
      <member>
84
 
        <link linkend="uiGetParentNode">uiGetParentNode</link>
85
 
      </member>
86
 
      <member>
87
 
        <link linkend="uiGetChildrenNode">uiGetChildrenNode</link>
88
 
      </member>
89
 
      <member>
90
 
        <link linkend="uiGetNodePosition">uiGetNodePosition</link>
91
 
      </member>
92
 
    </simplelist>
93
 
  </refsection>
 
55
    </refsection>
 
56
    <refsection role="see also">
 
57
        <title>See Also</title>
 
58
        <simplelist type="inline">
 
59
            <member>
 
60
                <link linkend="uiCreateNode">uiCreateNode</link>
 
61
            </member>
 
62
            <member>
 
63
                <link linkend="uiCreateTree">uiCreateTree</link>
 
64
            </member>
 
65
            <member>
 
66
                <link linkend="uiDisplayTree">uiDisplayTree</link>
 
67
            </member>
 
68
            <member>
 
69
                <link linkend="uiDumpTree">uiDumpTree</link>
 
70
            </member>
 
71
            <member>
 
72
                <link linkend="uiInsertNode">uiInsertNode</link>
 
73
            </member>
 
74
            <member>
 
75
                <link linkend="uiDeleteNode">uiDeleteNode</link>
 
76
            </member>
 
77
            <member>
 
78
                <link linkend="uiConcatTree">uiConcatTree</link>
 
79
            </member>
 
80
            <member>
 
81
                <link linkend="uiFindNode">uiFindNode</link>
 
82
            </member>
 
83
            <member>
 
84
                <link linkend="uiGetParentNode">uiGetParentNode</link>
 
85
            </member>
 
86
            <member>
 
87
                <link linkend="uiGetChildrenNode">uiGetChildrenNode</link>
 
88
            </member>
 
89
            <member>
 
90
                <link linkend="uiGetNodePosition">uiGetNodePosition</link>
 
91
            </member>
 
92
        </simplelist>
 
93
    </refsection>
94
94
</refentry>