← 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/compound_properties.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/compound_properties.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="Compound_properties">
14
 
  <refnamediv>
15
 
    <refname>Compound_properties</refname>
16
 
    <refpurpose>description of the Compound
17
 
      entity properties
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsection>
21
 
    <title>Description</title>
22
 
    <para>The Compound entity is a third of the graphics entities hierarchy. This
23
 
      entity defines interdependencies of the various graphics entities and
24
 
      their global visibility property.
25
 
    </para>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>parent: </term>
29
 
        <listitem>
30
 
          <para>This property contains the handle of the parent. The parent of the
31
 
            text entity should be of the type <literal>"Axes"</literal> or
32
 
            <literal>"Compound"</literal>.
33
 
          </para>
34
 
        </listitem>
35
 
      </varlistentry>
36
 
      <varlistentry>
37
 
        <term>children: </term>
38
 
        <listitem>
39
 
          <para>A vector containing the handles of all graphics objects children
40
 
            of the Compound. These graphics objects can be of type
41
 
            <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
42
 
            <literal>"Polyline"</literal>, <literal>"Patch"</literal>, <literal>"Segs"</literal>,
43
 
            <literal>"Arc"</literal>, <literal>"Grayplot"</literal>, ...
44
 
          </para>
45
 
        </listitem>
46
 
      </varlistentry>
47
 
      <varlistentry>
48
 
        <term>visible: </term>
49
 
        <listitem>
50
 
          <para>
51
 
            This field contains the <literal>visible</literal> property value for
52
 
            the entity . It should be <literal>"on" </literal> or <literal>"off"</literal>. By
53
 
            default, value is <literal>"on" </literal> where graphics entities children
54
 
            of the Compound are drawn according to their visibility property. If
55
 
            <literal>"off"</literal> all children of Compound are not displayed on the
56
 
            screen.
57
 
          </para>
58
 
        </listitem>
59
 
      </varlistentry>
60
 
      <varlistentry>
61
 
        <term>user_data: </term>
62
 
        <listitem>
63
 
          <para>This field can be use to store any scilab variable in the figure
64
 
            data structure, and to retreive it.
65
 
          </para>
66
 
        </listitem>
67
 
      </varlistentry>
68
 
    </variablelist>
69
 
  </refsection>
70
 
  <refsection role="see also">
71
 
    <title>See Also</title>
72
 
    <simplelist type="inline">
73
 
      <member>
74
 
        <link linkend="glue">glue</link>
75
 
      </member>
76
 
      <member>
77
 
        <link linkend="unglue">unglue</link>
78
 
      </member>
79
 
      <member>
80
 
        <link linkend="graphics_entities">graphics_entities</link>
81
 
      </member>
82
 
    </simplelist>
83
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>Compound_properties</refname>
 
16
        <refpurpose>description of the Compound
 
17
            entity properties
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsection>
 
21
        <title>Description</title>
 
22
        <para>The Compound entity is a third of the graphics entities hierarchy. This
 
23
            entity defines interdependencies of the various graphics entities and
 
24
            their global visibility property.
 
25
        </para>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>parent: </term>
 
29
                <listitem>
 
30
                    <para>This property contains the handle of the parent. The parent of the
 
31
                        text entity should be of the type <literal>"Axes"</literal> or
 
32
                        <literal>"Compound"</literal>.
 
33
                    </para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
            <varlistentry>
 
37
                <term>children: </term>
 
38
                <listitem>
 
39
                    <para>A vector containing the handles of all graphics objects children
 
40
                        of the Compound. These graphics objects can be of type
 
41
                        <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
 
42
                        <literal>"Polyline"</literal>, <literal>"Patch"</literal>, <literal>"Segs"</literal>,
 
43
                        <literal>"Arc"</literal>, <literal>"Grayplot"</literal>, ...
 
44
                    </para>
 
45
                </listitem>
 
46
            </varlistentry>
 
47
            <varlistentry>
 
48
                <term>visible: </term>
 
49
                <listitem>
 
50
                    <para>
 
51
                        This field contains the <literal>visible</literal> property value for
 
52
                        the entity . It should be <literal>"on" </literal> or <literal>"off"</literal>. By
 
53
                        default, value is <literal>"on" </literal> where graphics entities children
 
54
                        of the Compound are drawn according to their visibility property. If
 
55
                        <literal>"off"</literal> all children of Compound are not displayed on the
 
56
                        screen.
 
57
                    </para>
 
58
                </listitem>
 
59
            </varlistentry>
 
60
            <varlistentry>
 
61
                <term>user_data: </term>
 
62
                <listitem>
 
63
                    <para>This field can be use to store any scilab variable in the figure
 
64
                        data structure, and to retreive it.
 
65
                    </para>
 
66
                </listitem>
 
67
            </varlistentry>
 
68
        </variablelist>
 
69
    </refsection>
 
70
    <refsection role="see also">
 
71
        <title>See Also</title>
 
72
        <simplelist type="inline">
 
73
            <member>
 
74
                <link linkend="glue">glue</link>
 
75
            </member>
 
76
            <member>
 
77
                <link linkend="unglue">unglue</link>
 
78
            </member>
 
79
            <member>
 
80
                <link linkend="graphics_entities">graphics_entities</link>
 
81
            </member>
 
82
        </simplelist>
 
83
    </refsection>
84
84
</refentry>