topical media & game development

talk show tell print

lib-of-vs-libs-Poco-include-Poco-DOM-ProcessingInstruction.h / h



  //
  // ProcessingInstruction.h
  //
  // Id: //poco/1.3/XML/include/Poco/DOM/ProcessingInstruction.h#1 
  //
  // Library: XML
  // Package: DOM
  // Module:  DOM
  //
  // Definition of the DOM ProcessingInstruction class.
  //
  // 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 DOM_ProcessingInstruction_INCLUDED
  define DOM_ProcessingInstruction_INCLUDED
  
  include "Poco/XML/XML.h"
  include "Poco/DOM/AbstractNode.h"
  include "Poco/XML/XMLString.h"
  
  namespace Poco {
  namespace XML {
  
  class XML_API ProcessingInstruction: public AbstractNode
  
The ProcessingInstruction interface represents a "processing instruction", used in XML as a way to keep processor-specific information in the text of the document. { public: const XMLString& target() const; Returns the target of this processing instruction. XML defines this as being the first token following the markup that begins the processing instruction.

          const XMLString& data() const;
  
Returns the content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the ?>.

          const XMLString& getData() const;
  
Returns the content of this processing instruction. This is from the first non white space character after the target to the character immediately preceding the ?>.

          void setData(const XMLString& data);
  
Sets the content of this processing instruction.

          // Node
          const XMLString& nodeName() const;
          const XMLString& getNodeValue() const;
          void setNodeValue(const XMLString& data);
          unsigned short nodeType() const;
  
  protected:
          ProcessingInstruction(Document* pOwnerDocument, const XMLString& target, const XMLString& data);
          ProcessingInstruction(Document* pOwnerDocument, const ProcessingInstruction& processingInstruction);
          ~ProcessingInstruction();
  
          Node* copyNode(bool deep, Document* pOwnerDocument) const;
  
  private:
          XMLString _target;
          XMLString _data;
          
          friend class Document;
  };
  
  //
  // inlines
  //
  inline const XMLString& ProcessingInstruction::target() const
  {
          return _target;
  }
  
  inline const XMLString& ProcessingInstruction::data() const
  {
          return _data;
  }
  
  inline const XMLString& ProcessingInstruction::getData() const
  {
          return _data;
  }
  
  } } // namespace Poco::XML
  
  endif // DOM_ProcessingInstruction_INCLUDED
  


(C) Æliens 04/09/2009

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.