2000-09-15 19:56:39 +00:00
|
|
|
<html><head>
|
2000-09-22 13:45:58 +00:00
|
|
|
<title>GSXMLNode</title>
|
2000-09-15 19:56:39 +00:00
|
|
|
</head>
|
|
|
|
<body>
|
2000-09-22 13:45:58 +00:00
|
|
|
<a href ="GSXMLNamespace.html">[Previous]</a>
|
|
|
|
<a href ="GSXML.html">[Up]</a>
|
|
|
|
<a href ="GSXMLAttribute.html">[Next]</a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<h1>GSXMLNode</h1>
|
2000-09-22 13:45:58 +00:00
|
|
|
<h3>Authors </h3>
|
|
|
|
<dl>
|
2000-09-15 19:56:39 +00:00
|
|
|
<dt>Michael Pakhantsov
|
|
|
|
<dd>
|
|
|
|
<dt>Richard Frith-Macdonald
|
|
|
|
<dd>
|
|
|
|
</dl>
|
2001-03-03 10:00:31 +00:00
|
|
|
<p>Version: $Revision$</p>
|
|
|
|
<p>Date: $Date$</p>
|
2000-09-22 13:45:58 +00:00
|
|
|
<h2><a name ="cont-0">GSXMLNode</a></h2>
|
|
|
|
<h2><a name ="GSXMLNode">GSXMLNode</a></h2>
|
|
|
|
<p><b>Declared in: </b> GSXML.h</p>
|
|
|
|
<p><b>Inherits from: </b> NSObject</p>
|
2000-09-15 19:56:39 +00:00
|
|
|
<hr>
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
XML Node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<h2>Instance Variables </h2>
|
2000-09-15 19:56:39 +00:00
|
|
|
<ul>
|
|
|
|
</ul>
|
2000-09-22 13:45:58 +00:00
|
|
|
<h2>Methods </h2>
|
2000-09-15 19:56:39 +00:00
|
|
|
<ul>
|
2000-09-22 13:45:58 +00:00
|
|
|
<li><a href ="GSXMLNode.html#method-3">+nodeFrom:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-0">+nodeWithNamespace:name:prefix:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-17">-children</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-7">-content</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-16">-doc</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-4">-initFrom:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-2">-initWithNamespace:name:prefix:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-5">-lib</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-22">-makeChild:name:content:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-24">-makeComment:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-26">-makePI:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-6">-name</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-20">-next</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-8">-ns</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-9">-nsDef</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-19">-parent</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-21">-prev</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-10">-properties</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-12">-propertiesAsDictionary</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-28">-setProp:value:</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-14">-type</a>
|
|
|
|
<li><a href ="GSXMLNode.html#method-15">-typeDescription</a>
|
2000-09-15 19:56:39 +00:00
|
|
|
</ul>
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr><h2>Class Methods </h2>
|
|
|
|
<h3><a name ="method-0">nodeWithNamespace:name:prefix:</a></h3>
|
|
|
|
+ (GSXMLNode*) <b>nodeWithNamespace:</b> (GSXMLNamespace*)ns <b>name:</b> (NSString*)name <b>prefix:</b> (NSString*)prefix;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new Node. This function will refuse to create a Node
|
|
|
|
with a similar prefix than an existing one present on this node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-1">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
|
|
|
|
...
|
|
|
|
GSXMLNamespace *ns1;
|
|
|
|
GSXMLNode *node1, *node2;
|
|
|
|
NSString *prefix = @"mac-os-property";
|
|
|
|
NSString *href = @"http://www.gnustep.org/some/location";
|
|
|
|
|
|
|
|
ns = [GSXMLNamespace namespaceWithNode: nil
|
|
|
|
href: href
|
|
|
|
prefix: prefix];
|
|
|
|
node1 = [GSXMLNode nodeWithNamespace: ns name: @"node1"];
|
|
|
|
node2 = [GSXMLNode nodeWithNamespace: nil name: @"node2"];
|
|
|
|
...
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-3">nodeFrom:</a></h3>
|
|
|
|
+ (GSXMLNode*) <b>nodeFrom:</b> (void*)data;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new Node from libxml data.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<hr><h2>Instances Methods </h2>
|
|
|
|
<h3><a name ="method-2">initWithNamespace:name:prefix:</a></h3>
|
|
|
|
- (id) <b>initWithNamespace:</b> (GSXMLNamespace*)ns <b>name:</b> (NSString*)name <b>prefix:</b> (NSString*)prefix;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new node elemen, ns is optional (nil).
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-4">initFrom:</a></h3>
|
|
|
|
<b>This is the designated initialiser </b><br>
|
2000-09-15 19:56:39 +00:00
|
|
|
- (id) <b>initFrom:</b> (void*)data;<br>
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new Node from libxml data.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-5">lib</a></h3>
|
2000-09-15 19:56:39 +00:00
|
|
|
- (void*) <b>lib</b>;<br>
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return pointer to xmlNode structure.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-6">name</a></h3>
|
|
|
|
- (NSString*) <b>name</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return Node name.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-7">content</a></h3>
|
|
|
|
- (NSString*) <b>content</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return Node content.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-8">ns</a></h3>
|
|
|
|
- (GSXMLNamespace*) <b>ns</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return Node namespace.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-9">nsDef</a></h3>
|
|
|
|
- (GSXMLNamespace*) <b>nsDef</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return namespace definitions of this node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-10">properties</a></h3>
|
|
|
|
- (GSXMLAttribute*) <b>properties</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return pointer to the first attribute on this node.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-11">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
|
|
|
|
GSXMLNode *n1;
|
|
|
|
GSXMLAttribute *a;
|
|
|
|
|
|
|
|
n1 = [GSXMLNode nodeWithNamespace: nil name: nodeName];
|
|
|
|
[n1 setProp: @"prop1" value: @"value1"];
|
|
|
|
[n1 setProp: @"prop2" value: @"value2"];
|
|
|
|
[n1 setProp: @"prop3" value: @"value3"];
|
|
|
|
|
|
|
|
a = [n1 properties];
|
|
|
|
NSLog(@"n1 property name - %@ value - %@", [a name], [a value]);
|
|
|
|
while ((a = [a next]) != nil)
|
|
|
|
{
|
|
|
|
NSLog(@"n1 property name - %@ value - %@", [a name], [a value]);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-12">propertiesAsDictionary</a></h3>
|
|
|
|
- (NSDictionary*) <b>propertiesAsDictionary</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Return attritubes and values as a dictionary.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-13">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
|
|
|
|
GSXMLNode *n1;
|
|
|
|
NSMutableDictionary *prop;
|
|
|
|
NSEnumerator *e;
|
|
|
|
id key;
|
|
|
|
|
|
|
|
prop = [n1 propertiesAsDictionary];
|
|
|
|
e = [prop keyEnumerator];
|
|
|
|
while ((key = [e nextObject]) != nil)
|
|
|
|
{
|
|
|
|
NSLog(@"property name - %@ value - %@", key,
|
|
|
|
[prop objectForKey: key]);
|
|
|
|
}
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-14">type</a></h3>
|
2000-09-15 19:56:39 +00:00
|
|
|
- (GSXMLNodeType) <b>type</b>;<br>
|
|
|
|
|
2000-09-19 20:47:56 +00:00
|
|
|
<p>
|
|
|
|
|
|
|
|
Return type of Node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-15">typeDescription</a></h3>
|
|
|
|
- (NSString*) <b>typeDescription</b>;<br>
|
2000-09-19 20:47:56 +00:00
|
|
|
|
|
|
|
<p>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
2000-09-19 20:47:56 +00:00
|
|
|
Return the name of the type of the Node.
|
2000-09-15 19:56:39 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-16">doc</a></h3>
|
|
|
|
- (GSXMLDocument*) <b>doc</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
Return owner of this node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-17">children</a></h3>
|
|
|
|
- (GSXMLNode*) <b>children</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
Return children of this node.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-18">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
- (GSXMLNode*) nextElement: (GSXMLNode*)node
|
|
|
|
{
|
|
|
|
while (node != nil)
|
|
|
|
{
|
|
|
|
if ([node type] == XML_ELEMENT_NODE)
|
|
|
|
{
|
|
|
|
return node;
|
|
|
|
}
|
|
|
|
if ([node children] != nil)
|
|
|
|
{
|
|
|
|
node = [self nextElement: [node children]];
|
|
|
|
}
|
|
|
|
else
|
|
|
|
node = [node next];
|
|
|
|
}
|
|
|
|
return node;
|
|
|
|
}
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-19">parent</a></h3>
|
|
|
|
- (GSXMLNode*) <b>parent</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
Return parent of this node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-20">next</a></h3>
|
|
|
|
- (GSXMLNode*) <b>next</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
Return next node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-21">prev</a></h3>
|
|
|
|
- (GSXMLNode*) <b>prev</b>;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
Return previous node.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-22">makeChild:name:content:</a></h3>
|
|
|
|
- (GSXMLNode*) <b>makeChild:</b> (GSXMLNamespace*)ns <b>name:</b> (NSString*)name <b>content:</b> (NSString*)content;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new child element, added at the end of
|
|
|
|
parent children list.
|
|
|
|
ns and content parameters are optional (may be nil).
|
|
|
|
If content is non nil, a child list containing the
|
|
|
|
TEXTs and ENTITY_REFs node will be created.
|
|
|
|
Return previous node.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-23">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
|
|
|
|
GSXMLNode *n1, *n2;
|
|
|
|
GSXMLDocument *d, *d1;
|
|
|
|
|
|
|
|
d = [GSXMLDocument documentWithVersion: @"1.0"];
|
|
|
|
[d setRoot: [d makeNodeWithNamespace: nil
|
|
|
|
name: @"plist"
|
|
|
|
content: nil]];
|
|
|
|
[[d root] setProp: @"version" value: @"0.9"];
|
|
|
|
n1 = [[d root] makeChildWithNamespace: nil
|
|
|
|
name: @"dict"
|
|
|
|
content: nil];
|
|
|
|
[n1 makeChildWithNamespace: nil name: @"key" content: @"Year Of Birth"];
|
|
|
|
[n1 makeChildWithNamespace: nil name: @"integer" content: @"65"];
|
|
|
|
[n1 makeChildWithNamespace: nil name: @"key" content: @"Pets Names"];
|
|
|
|
[n1 makeChildWithNamespace: nil name: @"array" content: nil];
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-24">makeComment:</a></h3>
|
|
|
|
- (GSXMLNode*) <b>makeComment:</b> (NSString*)content;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new comment element, added at the end of
|
|
|
|
parent children list.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-25">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
d = [GSXMLDocument documentWithVersion: @"1.0"];
|
|
|
|
|
|
|
|
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
|
|
|
|
[[d root] setProp: @"version" value: @"0.9"];
|
|
|
|
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
|
|
|
|
[n1 makeComment: @" this is a comment "];
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-26">makePI:</a></h3>
|
|
|
|
- (GSXMLNode*) <b>makePI:</b> (NSString*)content;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
Creation of a new process instruction element,
|
|
|
|
added at the end of parent children list.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-27">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
d = [GSXMLDocument documentWithVersion: @"1.0"];
|
|
|
|
|
|
|
|
[d setRoot: [d makeNodeWithNamespace: nil name: @"plist" content: nil]];
|
|
|
|
[[d root] setProp: @"version" value: @"0.9"];
|
|
|
|
n1 = [[d root] makeChildWithNamespace: nil name: @"dict" content: nil];
|
|
|
|
[n1 makeComment: @" this is a comment "];
|
|
|
|
[n1 makePI: @"pi1" content: @"this is a process instruction"];
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
|
|
|
<h3><a name ="method-28">setProp:value:</a></h3>
|
|
|
|
- (GSXMLAttribute*) <b>setProp:</b> (NSString*)name <b>value:</b> (NSString*)value;<br>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
<p>
|
|
|
|
Set (or reset) an attribute carried by a node.
|
|
|
|
</p>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<a name ="label-29">example </a>
|
2000-09-15 19:56:39 +00:00
|
|
|
<pre>
|
|
|
|
|
|
|
|
id n1 = [GSXMLNode nodeWithNamespace: nil name: nodeName];
|
|
|
|
[n1 setProp: @"prop1" value: @"value1"];
|
|
|
|
[n1 setProp: @"prop2" value: @"value2"];
|
|
|
|
[n1 setProp: @"prop3" value: @"value3"];
|
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</pre>
|
2000-09-15 19:56:39 +00:00
|
|
|
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
<hr>
|
2000-09-15 19:56:39 +00:00
|
|
|
</body>
|
|
|
|
|
2000-09-22 13:45:58 +00:00
|
|
|
</html>
|