← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/handle/relocate_handle.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/graphics/help/en_US/handle/relocate_handle.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" xmlns:scilab="http://www.scilab.org" version="5.0-subset Scilab" xml:lang="en" xml:id="relocate_handle">
14
 
  <refnamediv>
15
 
    <refname>relocate_handle</refname>
16
 
    <refpurpose>Move handles inside the graphic
17
 
      hierarchy.
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>relocate_handle( movedHandles, parent )</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>movedHandles</term>
29
 
        <listitem>
30
 
          <para>Vector of relocated handles.</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>parent</term>
35
 
        <listitem>
36
 
          <para>New parent of the handles.</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
    </variablelist>
40
 
  </refsection>
41
 
  <refsection>
42
 
    <title>Description</title>
43
 
    <para>The relocate_handle function allows to move handles from their current
44
 
      locations in the graphical hierarchy to another. All the moved entities
45
 
      are relocated under the same parent handle specified with the
46
 
      <emphasis role="bold">parent</emphasis> parameter.
47
 
    </para>
48
 
    <para>Since not every handles are compatible with each others, some
49
 
      restrictions exist when relocationg handles. For examples, it is not
50
 
      allowed to move an axes handle under a polyline. More information about
51
 
      compatibility can be found in the <link linkend="graphics_entities">graphics_entities</link> page.
52
 
    </para>
53
 
    <para>This routine is particularly useful to move an object from an axes
54
 
      entity to an other or to move axes from figures handles.
55
 
    </para>
56
 
  </refsection>
57
 
  <refsection>
58
 
    <title>Examples</title>
59
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>relocate_handle</refname>
 
16
        <refpurpose>Move handles inside the graphic
 
17
            hierarchy.
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>relocate_handle( movedHandles, parent )</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>movedHandles</term>
 
29
                <listitem>
 
30
                    <para>Vector of relocated handles.</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>parent</term>
 
35
                <listitem>
 
36
                    <para>New parent of the handles.</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
        </variablelist>
 
40
    </refsection>
 
41
    <refsection>
 
42
        <title>Description</title>
 
43
        <para>The relocate_handle function allows to move handles from their current
 
44
            locations in the graphical hierarchy to another. All the moved entities
 
45
            are relocated under the same parent handle specified with the
 
46
            <emphasis role="bold">parent</emphasis> parameter.
 
47
        </para>
 
48
        <para>Since not every handles are compatible with each others, some
 
49
            restrictions exist when relocationg handles. For examples, it is not
 
50
            allowed to move an axes handle under a polyline. More information about
 
51
            compatibility can be found in the <link linkend="graphics_entities">graphics_entities</link> page.
 
52
        </para>
 
53
        <para>This routine is particularly useful to move an object from an axes
 
54
            entity to an other or to move axes from figures handles.
 
55
        </para>
 
56
    </refsection>
 
57
    <refsection>
 
58
        <title>Examples</title>
 
59
        <programlisting role="example"><![CDATA[ 
60
60
x = 0:10 ;
61
61
 
62
62
// plot a first polyline
74
74
// put both polyline in the same window
75
75
relocate_handle( poly2bis, axes1 ) ;
76
76
 ]]></programlisting>
77
 
  </refsection>
78
 
  <refsection role="see also">
79
 
    <title>See Also</title>
80
 
    <simplelist type="inline">
81
 
      <member>
82
 
        <link linkend="graphics_entities">graphics_entities</link>
83
 
      </member>
84
 
      <member>
85
 
        <link linkend="copy">copy</link>
86
 
      </member>
87
 
      <member>
88
 
        <link linkend="delete">delete</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="swap_handles">swap_handles</link>
92
 
      </member>
93
 
    </simplelist>
94
 
  </refsection>
 
77
    </refsection>
 
78
    <refsection role="see also">
 
79
        <title>See Also</title>
 
80
        <simplelist type="inline">
 
81
            <member>
 
82
                <link linkend="graphics_entities">graphics_entities</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="copy">copy</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="delete">delete</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="swap_handles">swap_handles</link>
 
92
            </member>
 
93
        </simplelist>
 
94
    </refsection>
95
95
</refentry>