~ubuntu-branches/ubuntu/wily/afnix/wily

« back to all changes in this revision

Viewing changes to src/mod/xml/doc/appendix-iv.xml

  • Committer: Bazaar Package Importer
  • Author(s): Anibal Monsalve Salazar
  • Date: 2011-03-16 21:31:18 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20110316213118-gk4k3ez3e5d2huna
Tags: 2.0.0-1
* QA upload.
* New upstream release
* Debian source format is 3.0 (quilt)
* Fix debhelper-but-no-misc-depends
* Fix ancient-standards-version
* Fix package-contains-linda-override
* debhelper compatibility is 7
* Fix dh-clean-k-is-deprecated

Show diffs side-by-side

added added

removed removed

Lines of Context:
13
13
<!-- = incidental  or special  damages arising  in any way out of the use = -->
14
14
<!-- = of this software.                                                  = -->
15
15
<!-- ====================================================================== -->
16
 
<!-- = copyright (c)1999-2007 - amaury darsch                            = -->
 
16
<!-- = copyright (c)1999-2011 - amaury darsch                            = -->
17
17
<!-- ====================================================================== -->
18
18
 
19
19
<appendix module="xml" number="iv">
28
28
 
29
29
    <!-- synopsis -->
30
30
    <p>
31
 
    The <code>XsoInfo</code> class is a xml/xsm information node used
32
 
    to carry simple information about a tag. The node is constructed
33
 
    by name, with a set of atributes and eventually a text associated
34
 
    with the node. The text information is generally the one
35
 
    associated between the start tag and the end tag. In the case of
36
 
    complex tree, such text data might be empty.
 
31
      The <code>XsoInfo</code> class is a xml/xsm information node used
 
32
      to carry simple information about a tag. The node is constructed
 
33
      by name, with a set of attributes and eventually a text associated
 
34
      with the node. The text information is generally the one
 
35
      associated between the start tag and the end tag. In the case of
 
36
      complex tree, such text data might be empty.
37
37
    </p>
38
38
 
39
39
    <!-- predicate -->
46
46
 
47
47
    <!-- constructors -->
48
48
    <ctors>
49
 
     <ctor>
50
 
      <name>XsoInfo</name>
51
 
      <args>none</args>
52
 
      <p>
53
 
      The <code>XsoInfo</code> constructor creates a default info
54
 
      object.
55
 
      </p>
56
 
     </ctor>
57
 
 
58
 
     <ctor>
59
 
      <name>XsoInfo</name>
60
 
      <args>String</args>
61
 
      <p>
62
 
      The <code>XsoInfo</code> constructor creates an info object by
63
 
      name. The string argument is the node info name.
64
 
      </p>
65
 
     </ctor>
66
 
 
67
 
     <ctor>
68
 
      <name>XsoInfo</name>
69
 
      <args>String String</args>
70
 
      <p>
71
 
      The <code>XsoInfo</code> constructor creates an info object by
72
 
      name and text. The first argument is the node info name. The
73
 
      second argument is the node text information.
74
 
      </p>
75
 
     </ctor>
 
49
      <ctor>
 
50
        <name>XsoInfo</name>
 
51
        <args>none</args>
 
52
        <p>
 
53
          The <code>XsoInfo</code> constructor creates a default info
 
54
          object.
 
55
        </p>
 
56
      </ctor>
 
57
 
 
58
      <ctor>
 
59
        <name>XsoInfo</name>
 
60
        <args>String</args>
 
61
        <p>
 
62
          The <code>XsoInfo</code> constructor creates an info object by
 
63
          name. The string argument is the node info name.
 
64
        </p>
 
65
      </ctor>
 
66
 
 
67
      <ctor>
 
68
        <name>XsoInfo</name>
 
69
        <args>String String</args>
 
70
        <p>
 
71
          The <code>XsoInfo</code> constructor creates an info object by
 
72
          name and text. The first argument is the node info name. The
 
73
          second argument is the node text information.
 
74
        </p>
 
75
      </ctor>
76
76
    </ctors>
77
77
 
78
78
    <!-- methods -->
79
79
    <methods>
80
 
     <meth>
81
 
      <name>set-name</name>
82
 
      <retn>none</retn>
83
 
      <args>String</args>
84
 
      <p>
85
 
      The <code>set-name</code> method sets the info object name.
86
 
      </p>
87
 
     </meth>
88
 
 
89
 
     <meth>
90
 
      <name>set-attribute</name>
91
 
      <retn>none</retn>
92
 
      <args>String Literal</args>
93
 
      <p>
94
 
      The <code>set-attribute</code> method sets an attribute by name
95
 
      and value. The first argument is the attribute name. The second
96
 
      argument is the attribute value.
97
 
      </p>
98
 
     </meth>
99
 
 
100
 
     <meth>
101
 
      <name>get-attribute-list</name>
102
 
      <retn>Plist</retn>
103
 
      <args>none</args>
104
 
      <p>
105
 
      The <code>get-attribute-list</code> method returns the node
106
 
      attribute list in the form of a property list object.
107
 
      </p>
108
 
     </meth>
109
 
 
110
 
     <meth>
111
 
      <name>get-attribute-value</name>
112
 
      <retn>String</retn>
113
 
      <args>String</args>
114
 
      <p>
115
 
      The <code>get-attribute-value</code> method returns the attribute
116
 
      value by name. The string argument is the attribute name.
117
 
      </p>
118
 
     </meth>
119
 
 
120
 
     <meth>
121
 
      <name>set-text</name>
122
 
      <retn>none</retn>
123
 
      <args>String</args>
124
 
      <p>
125
 
      The <code>set-text</code> method sets the info object text.
126
 
      </p>
127
 
     </meth>
128
 
 
129
 
     <meth>
130
 
      <name>get-text</name>
131
 
      <retn>String</retn>
132
 
      <args>none</args>
133
 
      <p>
134
 
      The <code>get-text</code> method returns the text information.
135
 
      </p>
136
 
    </meth>
137
 
   </methods>
 
80
      <meth>
 
81
        <name>set-name</name>
 
82
        <retn>none</retn>
 
83
        <args>String</args>
 
84
        <p>
 
85
          The <code>set-name</code> method sets the info object name.
 
86
        </p>
 
87
      </meth>
 
88
 
 
89
      <meth>
 
90
        <name>set-attribute</name>
 
91
        <retn>none</retn>
 
92
        <args>String Literal</args>
 
93
        <p>
 
94
          The <code>set-attribute</code> method sets an attribute by name
 
95
          and value. The first argument is the attribute name. The second
 
96
          argument is the attribute value.
 
97
        </p>
 
98
      </meth>
 
99
 
 
100
      <meth>
 
101
        <name>get-attribute-list</name>
 
102
        <retn>Plist</retn>
 
103
        <args>none</args>
 
104
        <p>
 
105
          The <code>get-attribute-list</code> method returns the node
 
106
          attribute list in the form of a property list object.
 
107
        </p>
 
108
      </meth>
 
109
 
 
110
      <meth>
 
111
        <name>get-attribute-value</name>
 
112
        <retn>String</retn>
 
113
        <args>String</args>
 
114
        <p>
 
115
          The <code>get-attribute-value</code> method returns the attribute
 
116
          value by name. The string argument is the attribute name.
 
117
        </p>
 
118
      </meth>
 
119
 
 
120
      <meth>
 
121
        <name>set-text</name>
 
122
        <retn>none</retn>
 
123
        <args>String</args>
 
124
        <p>
 
125
          The <code>set-text</code> method sets the info object text.
 
126
        </p>
 
127
      </meth>
 
128
 
 
129
      <meth>
 
130
        <name>get-text</name>
 
131
        <retn>String</retn>
 
132
        <args>none</args>
 
133
        <p>
 
134
          The <code>get-text</code> method returns the text information.
 
135
        </p>
 
136
      </meth>
 
137
    </methods>
138
138
  </object>
139
139
</appendix>