topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

lib-of-vs-libs-Poco-include-Poco-SAX-Attributes.h / h


  //
  // Attributes.h
  //
  //  $Id: //poco/1.3/XML/include/Poco/SAX/Attributes.h#2$ 
  //
  // Library: XML
  // Package: SAX
  // Module:  SAX
  //
  // SAX2 Attributes Interface.
  //
  // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
  // and Contributors.
  //
  // Permission is hereby granted, free of charge, to any person or organization
  // obtaining a copy of the software and accompanying documentation covered by
  // this license (the "Software") to use, reproduce, display, distribute,
  // execute, and transmit the Software, and to prepare derivative works of the
  // Software, and to permit third-parties to whom the Software is furnished to
  // do so, all subject to the following:
  // 
  // The copyright notices in the Software and this entire statement, including
  // the above license grant, this restriction and the following disclaimer,
  // must be included in all copies of the Software, in whole or in part, and
  // all derivative works of the Software, unless such copies or derivative
  // works are solely in the form of machine-executable object code generated by
  // a source language processor.
  // 
  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  // DEALINGS IN THE SOFTWARE.
  //
  
  ifndef SAX_Attributes_INCLUDED
  define SAX_Attributes_INCLUDED
  
  include "Poco/XML/XML.h"
  include "Poco/XML/XMLString.h"
  
  namespace Poco {
  namespace XML {
  
  class XML_API Attributes

Interface for a list of XML attributes. This interface allows access to a list of attributes in three different ways: 1.by attribute index; 2.by Namespace-qualified name; or 3.by qualified (prefixed) name. The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes

feature is set to true (it is false by default).

If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if the http://xml.org/sax/features/namespaces feature is false, access by Namespace-qualified names may not be available. This interface replaces the now-deprecated SAX1 AttributeList interface, which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below). The order of attributes in the list is unspecified, and will vary from implementation to implementation. { public: virtual int getIndex(const XMLString& name) const = 0; Look up the index of an attribute by a qualified name.


          virtual int getIndex(const XMLString& namespaceURI, const XMLString& localName) const = 0;

Look up the index of an attribute by a namspace name.


          virtual int getLength() const = 0;

Return the number of attributes in the list. Once you know the number of attributes, you can iterate through the list. virtual const XMLString& getLocalName(int i) const = 0; Look up a local attribute name by index.


          virtual const XMLString& getQName(int i) const = 0;

Look up a qualified attribute name by index.


          virtual const XMLString& getType(int i) const = 0;

Look up an attribute type by index. The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case). If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization"). For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".


          virtual const XMLString& getType(const XMLString& qname) const = 0;

Look up an attribute type by a qualified name. See getType(int) for a description of the possible types.


          virtual const XMLString& getType(const XMLString& namespaceURI, const XMLString& localName) const = 0;

Look up an attribute type by a namespace name. See getType(int) for a description of the possible types.


          virtual const XMLString& getValue(int i) const = 0;

Look up an attribute value by index. If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.


          virtual const XMLString& getValue(const XMLString& qname) const = 0;

Look up an attribute value by a qualified name. See getValue(int) for a description of the possible values.


          virtual const XMLString& getValue(const XMLString& uri, const XMLString& localName) const = 0;

Look up an attribute value by a namespace name. See getValue(int) for a description of the possible values.


          virtual const XMLString& getURI(int i) const = 0;

Look up a namespace URI by index.


  protected:
          virtual ~Attributes();
  };
  
  } } // namespace Poco::XML
  
  endif // SAX_Attributes_INCLUDED

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.