topical media & game development

talk show tell print

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



  //
  // MutationEvent.h
  //
  // Id: //poco/1.3/XML/include/Poco/DOM/MutationEvent.h#1 
  //
  // Library: XML
  // Package: DOM
  // Module:  DOMEvents
  //
  // Definition of the DOM MutationEvent 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_MutationEvent_INCLUDED
  define DOM_MutationEvent_INCLUDED
  
  include "Poco/XML/XML.h"
  include "Poco/DOM/Event.h"
  
  namespace Poco {
  namespace XML {
  
  class Node;
  
  class XML_API MutationEvent: public Event
  
The MutationEvent interface provides specific contextual information associated with Mutation events. { public: enum AttrChangeType { MODIFICATION = 1,

The Attr was modified in place.


ADDITION = 2,

The Attr was just added.


REMOVAL = 3

The Attr was just removed.


};

          Node* relatedNode() const;
  
relatedNode is used to identify a secondary node related to a mutation event. For example, if a mutation event is dispatched to a node indicating that its parent has changed, the relatedNode is the changed parent. If an event is instead dispatched to a subtree indicating a node was changed within it, the relatedNode is the changed node. In the case of the DOMAttrModified event it indicates the Attr node which was modified, added, or removed.

          const XMLString& prevValue() const;
  
prevValue indicates the previous value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharDataModified events.

          const XMLString& newValue() const;
  
newValue indicates the new value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharDataModified events.

          const XMLString& attrName() const;
  
attrName indicates the name of the changed Attr node in a DOMAttrModified event.

          AttrChangeType attrChange() const;
  
attrChange indicates the type of change which triggered the DOMAttrModified event. The values can be MODIFICATION, ADDITION, or REMOVAL.

          void initMutationEvent(const XMLString& type, bool canBubble, bool cancelable, Node* relatedNode, 
                                 const XMLString& prevValue, const XMLString& newValue, const XMLString& attrName, AttrChangeType change);
  
The initMutationEvent method is used to initialize the value of a MutationEvent created through the DocumentEvent interface. This method may only be called before the MutationEvent has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.

          // Event Types
          static const XMLString DOMSubtreeModified;
          static const XMLString DOMNodeInserted;
          static const XMLString DOMNodeRemoved;
          static const XMLString DOMNodeRemovedFromDocument;
          static const XMLString DOMNodeInsertedIntoDocument;
          static const XMLString DOMAttrModified;
          static const XMLString DOMCharacterDataModified;
  
  protected:
          MutationEvent(Document* pOwnerDocument, const XMLString& type);
          MutationEvent(Document* pOwnerDocument, const XMLString& type, EventTarget* pTarget, bool canBubble, bool cancelable, Node* relatedNode);
          MutationEvent(Document* pOwnerDocument, const XMLString& type, EventTarget* pTarget, bool canBubble, bool cancelable, Node* relatedNode, 
                                    const XMLString& prevValue, const XMLString& newValue, const XMLString& attrName, AttrChangeType change);
          ~MutationEvent();
  
  private:
          XMLString      _prevValue;
          XMLString      _newValue;
          XMLString      _attrName;
          AttrChangeType _change;
          Node*          _pRelatedNode;
  
          friend class AbstractNode;
          friend class Document;
  };
  
  //
  // inlines
  //
  inline Node* MutationEvent::relatedNode() const
  {
          return _pRelatedNode;
  }
  
  inline const XMLString& MutationEvent::prevValue() const
  {
          return _prevValue;
  }
  
  inline const XMLString& MutationEvent::newValue() const
  {
          return _newValue;
  }
  
  inline const XMLString& MutationEvent::attrName() const
  {
          return _attrName;
  }
  
  inline MutationEvent::AttrChangeType MutationEvent::attrChange() const
  {
          return _change;
  }
  
  } } // namespace Poco::XML
  
  endif // DOM_MutationEvent_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.