/ 
Mozilla-DOM-0.15
River stage two • 3 direct dependents • 10 total dependents
/ Mozilla::DOM::Range

NAME

Mozilla::DOM::Range

Mozilla::DOM::Range is a wrapper around an instance of Mozilla's nsIDOMRange interface. This class inherits from Supports.

* The nsIDOMRange interface is an interface to a DOM range object.
*
* For more information on this interface please see
* http://www.w3.org/TR/DOM-Level-2-Traversal-Range/

The constants START_TO_START, START_TO_END, END_TO_END, and END_TO_START are available for the "how" argument to "CompareBoundaryPoints". XXX: Currently these are accessed through methods on the object; this will change when I figure out how to export them as constants or class methods. DEPRECATED: a little premature to deprecate, not having an alternative (aside from using the numbers directly), but I really don't like how they're currently implemented.

CLASS METHODS

$iid = Mozilla::DOM::Range->GetIID()

Pass this to QueryInterface.

METHODS

$documentfragment = $range->CloneContents()

$range->CloneRange($range)

$range->Collapse($bool)

    • $toStart (boolean)

$num = $range->CompareBoundaryPoints($how, $sourceRange)

    • $how (integer (short))

    • $sourceRange (Mozilla::DOM::Range)

$range->DeleteContents()

$range->Detach()

$documentfragment = $range->ExtractContents()

$bool = $range->GetCollapsed()

$node = $range->GetCommonAncestorContainer()

$node = $range->GetEndContainer()

$offset = $range->GetEndOffset()

$node = $range->GetStartContainer()

$offset = $range->GetStartOffset()

$range->InsertNode($node)

    • $newNode (Mozilla::DOM::Node)

$range->SelectNode($node)

    • $refNode (Mozilla::DOM::Node)

$range->SelectNodeContents($node)

    • $refNode (Mozilla::DOM::Node)

$range->SetEnd($node, $offset)

    • $refNode (Mozilla::DOM::Node)

    • $offset (integer (long))

$range->SetEndAfter($node)

    • $refNode (Mozilla::DOM::Node)

$range->SetEndBefore($node)

    • $refNode (Mozilla::DOM::Node)

$range->SetStart($node, $offset)

    • $refNode (Mozilla::DOM::Node)

    • $offset (integer (long))

$range->SetStartAfter($node)

    • $refNode (Mozilla::DOM::Node)

$range->SetStartBefore($node)

    • $refNode (Mozilla::DOM::Node)

$range->SurroundContents($newParentNode)

    • $newParent (Mozilla::DOM::Node)

$str = $range->ToString()

SEE ALSO

Mozilla::DOM

COPYRIGHT

Copyright (C) 2005, Scott Lanning

This software is licensed under the LGPL. See Mozilla::DOM for a full notice.