src/OFXMLElement.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"
#import "OFXMLAttribute.h"

@class OFString;
@class OFArray;
@class OFMutableString;
@class OFMutableArray;
@class OFMutableDictionary;

@interface OFXMLElement: OFObject
{
        OFString *name;
        OFString *ns;
        OFString *defaultNamespace;
        OFMutableArray *attributes;
        OFMutableDictionary *namespaces;
        OFMutableArray *children;
        OFString *characters;
        OFString *cdata;
        OFMutableString *comment;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, copy) OFString *name;
@property (readonly, copy, getter=namespace) OFString *ns;
@property (copy) OFString *defaultNamespace;
@property (readonly, copy) OFArray *attributes;
@property (readonly, copy) OFArray *children;
#endif

+ elementWithName: (OFString*)name;

+ elementWithName: (OFString*)name
      stringValue: (OFString*)stringval;

+ elementWithName: (OFString*)name
        namespace: (OFString*)ns;

+ elementWithName: (OFString*)name
        namespace: (OFString*)ns
      stringValue: (OFString*)stringval;

+ elementWithCharacters: (OFString*)chars;

+ elementWithCDATA: (OFString*)cdata;

+ elementWithComment: (OFString*)comment;

+ elementWithXMLString: (OFString*)str;

- initWithName: (OFString*)name;

- initWithName: (OFString*)name
   stringValue: (OFString*)stringval;

- initWithName: (OFString*)name
     namespace: (OFString*)ns;

- initWithName: (OFString*)name
     namespace: (OFString*)ns
   stringValue: (OFString*)stringval;

- initWithCharacters: (OFString*)chars;

- initWithCDATA: (OFString*)cdata;

- initWithComment: (OFString*)comment;

- initWithXMLString: (OFString*)str;

- (OFString*)name;

- (OFString*)namespace;

- (OFArray*)attributes;

- (void)setChildren: (OFArray*)children;

- (OFArray*)children;

- (void)setStringValue: (OFString*)value;

- (OFString*)stringValue;

- (OFString*)XMLString;

- (void)addAttribute: (OFXMLAttribute*)attr;

- (void)addAttributeWithName: (OFString*)name
                 stringValue: (OFString*)value;

- (void)addAttributeWithName: (OFString*)name
                   namespace: (OFString*)ns
                 stringValue: (OFString*)value;

- (OFXMLAttribute*)attributeForName: (OFString*)attrname;

- (OFXMLAttribute*)attributeForName: (OFString*)attrname
                          namespace: (OFString*)attrns;

- (void)removeAttributeForName: (OFString*)attrname;

- (void)removeAttributeForName: (OFString*)attrname
                     namespace: (OFString*)attrns;

- (void)setPrefix: (OFString*)prefix
     forNamespace: (OFString*)ns;

- (void)bindPrefix: (OFString*)prefix
      forNamespace: (OFString*)ns;

- (void)setDefaultNamespace: (OFString*)ns;

- (void)addChild: (OFXMLElement*)child;

- (OFXMLElement*)elementForName: (OFString*)elemname;

- (OFArray*)elementsForName: (OFString*)elemname;

- (OFXMLElement*)elementForName: (OFString*)elemname
                      namespace: (OFString*)elemns;

- (OFArray*)elementsForName: (OFString*)elemname
                  namespace: (OFString*)elemns;
@end