epoc32/include/xml/dom/xmlengelement.inl
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/xml/dom/xmlengelement.inl	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,113 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:       Inline functions specyfic for element node
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +// -------------------------------------------------------------------------------------
    1.29 +// Default constructor
    1.30 +// -------------------------------------------------------------------------------------
    1.31 +//
    1.32 +inline TXmlEngElement::TXmlEngElement():TXmlEngNode(NULL) {}
    1.33 +
    1.34 +// -------------------------------------------------------------------------------------
    1.35 +// Constructor
    1.36 +// -------------------------------------------------------------------------------------
    1.37 +//
    1.38 +inline TXmlEngElement::TXmlEngElement(void* aInternal): TXmlEngNode(aInternal) {}
    1.39 +
    1.40 +
    1.41 +// -------------------------------------------------------------------------------------
    1.42 +// Creates new attribute node using namespace of its parent element (this element),
    1.43 +// sets attribute's value and links it as the last attribute of the element
    1.44 +//
    1.45 +// @param aName	- Local name of attribute 
    1.46 +// @param aValue - Value to set for new attribute or NULL (sets value to "")
    1.47 +// @return A handler to the newly created attribute node;
    1.48 +//
    1.49 +// For more hints how to use it refer to AddNewAttributeL(const TDesC8&,const TDesC8&)
    1.50 +//		
    1.51 +// @note	
    1.52 +// 	- No checks are made that attribute with such name exists
    1.53 +// 	- if namespace of the parent element is default (i.e. bound prefix is NULL),
    1.54 +// 	  then temporary prefix will be used and bound to the same namespace URI as elements
    1.55 +// 	  (It is due to the fact that default namespaces do not spread on unprefixed attributes,
    1.56 +// 	   see http://w3.org/TR/REC-xml-names/#defaulting)
    1.57 +// -------------------------------------------------------------------------------------
    1.58 +//
    1.59 +inline TXmlEngAttr TXmlEngElement::AddNewAttributeSameNsL(const TDesC8& aName, const TDesC8& aValue)
    1.60 +    {
    1.61 +    return AddNewAttributeL(aName, aValue, NamespaceDeclaration());
    1.62 +    }
    1.63 +
    1.64 +// -------------------------------------------------------------------------------------
    1.65 +// @return Default namespace in the scope of the element
    1.66 +//
    1.67 +// NULL TXmlEngNamespace means that element with no prefix have no namespace associated
    1.68 +// because no default namespace was declared or default namespace was undeclared with <b>xmlns=""</b>
    1.69 +//
    1.70 +// Equivalent to LookupNamespaceByPrefixL() with NULL (or "") prefix provided
    1.71 +// -------------------------------------------------------------------------------------
    1.72 +//
    1.73 +inline TXmlEngNamespace TXmlEngElement::DefaultNamespaceL() const
    1.74 +    {
    1.75 +    return LookupNamespaceByPrefixL(KNullDesC8);
    1.76 +    }
    1.77 +
    1.78 +// -------------------------------------------------------------------------------------
    1.79 +// Specialized version of TXmlEngNode::CopyL()
    1.80 +//
    1.81 +// @return Deep copy of the element.
    1.82 +// -------------------------------------------------------------------------------------
    1.83 +//
    1.84 +inline TXmlEngElement TXmlEngElement::CopyL() const
    1.85 +    {return TXmlEngNode::CopyL().AsElement();}
    1.86 +
    1.87 +// -------------------------------------------------------------------------------------
    1.88 +// Removes all element contents: child nodes, attributes and namespace declarations
    1.89 +//
    1.90 +// @see RemoveChildren(), RemoveAttributes(), RemoveNamespaceDeclarations();
    1.91 +// -------------------------------------------------------------------------------------
    1.92 +//
    1.93 +inline void TXmlEngElement::ClearElement()
    1.94 +    {
    1.95 +    RemoveChildren();
    1.96 +    RemoveAttributes();
    1.97 +    RemoveNamespaceDeclarations();
    1.98 +    }
    1.99 +
   1.100 +// -------------------------------------------------------------------------------------
   1.101 +// -------------------------------------------------------------------------------------
   1.102 +//
   1.103 +
   1.104 +
   1.105 +// -------------------------------------------------------------------------------------
   1.106 +// Returns TRUE if the element holds an attribute with such namespace URI and name.
   1.107 +//
   1.108 +// Same result gives AttributeNodeL(uri,name).NotNull()
   1.109 +// -------------------------------------------------------------------------------------
   1.110 +//
   1.111 +inline TBool TXmlEngElement::HasAttributeL(const TDesC8& aLocalName, const TDesC8& aNamespaceUri) const
   1.112 +	{return AttributeNodeL(aLocalName, aNamespaceUri).NotNull();}
   1.113 +
   1.114 +
   1.115 +
   1.116 +