DOM::Range Class Reference

List of all members.

Detailed Description

Definition at line 70 of file dom2_range.h.


Public Types

 START_TO_START = 0
 START_TO_END = 1
 END_TO_END = 2
 END_TO_START = 3
enum  CompareHow { START_TO_START = 0, START_TO_END = 1, END_TO_END = 2, END_TO_START = 3 }

Public Member Functions

 Range ()
 Range (const Document rootContainer)
 Range (const Range &other)
 Range (const Node startContainer, const long startOffset, const Node endContainer, const long endOffset)
Rangeoperator= (const Range &other)
 ~Range ()
Node startContainer () const
long startOffset () const
Node endContainer () const
long endOffset () const
bool collapsed () const
Node commonAncestorContainer ()
void setStart (const Node &refNode, long offset)
void setEnd (const Node &refNode, long offset)
void setStartBefore (const Node &refNode)
void setStartAfter (const Node &refNode)
void setEndBefore (const Node &refNode)
void setEndAfter (const Node &refNode)
void collapse (bool toStart)
void selectNode (const Node &refNode)
void selectNodeContents (const Node &refNode)
short compareBoundaryPoints (CompareHow how, const Range &sourceRange)
bool boundaryPointsValid ()
void deleteContents ()
DocumentFragment extractContents ()
DocumentFragment cloneContents ()
void insertNode (const Node &newNode)
void surroundContents (const Node &newParent)
Range cloneRange ()
DOMString toString ()
DOMString toHTML ()
DocumentFragment createContextualFragment (const DOMString &html)
void detach ()
bool isDetached () const
RangeImpl * handle () const
bool isNull () const

Protected Member Functions

 Range (RangeImpl *i)

Protected Attributes

RangeImpl * impl

Friends

class DocumentImpl
class Document
class RangeImpl

Member Function Documentation

DocumentFragment Range::cloneContents (  ) 

Duplicates the contents of a range.

Returns:
A DocumentFragment containing contents equivalent to those of this range.
Exceptions:
DOMException HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.

Definition at line 289 of file dom2_range.cpp.

Range Range::cloneRange (  ) 

Produces a new range whose end-points are equal to the end-points of the range.

Returns:
The duplicated range.

Definition at line 320 of file dom2_range.cpp.

void Range::collapse ( bool  toStart  ) 

Collapse a range onto one of its end-points.

Parameters:
toStart If true, collapses the Range onto its start; if false, collapses it onto its end.
Returns:

Definition at line 219 of file dom2_range.cpp.

bool Range::collapsed (  )  const

true if the range is collapsed

Definition at line 136 of file dom2_range.cpp.

Node Range::commonAncestorContainer (  ) 

Gets the common ancestor container of the range's two end-points.

Also sets it.

Definition at line 147 of file dom2_range.cpp.

short Range::compareBoundaryPoints ( CompareHow  how,
const Range sourceRange 
)

Compare the end-points of two ranges in a document.

Parameters:
how 
sourceRange 
Returns:
-1, 0 or 1 depending on whether the corresponding end-point of the Range is before, equal to, or after the corresponding end-point of sourceRange .
Exceptions:
DOMException WRONG_DOCUMENT_ERR: Raised if the two Ranges are not in the same document or document fragment.

Definition at line 249 of file dom2_range.cpp.

void Range::deleteContents (  ) 

Removes the contents of a range from the containing document or document fragment without returning a reference to the removed content.

Returns:
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if any portion of the content of the range is read-only or any of the nodes that contain any of the content of the range are read-only.

Definition at line 268 of file dom2_range.cpp.

void Range::detach (  ) 

Called to indicate that the range is no longer in use and that the implementation may relinquish any resources associated with this range.

Subsequent calls to any methods or attribute getters on this range will result in a DOMException being thrown with an error code of INVALID_STATE_ERR.

Definition at line 365 of file dom2_range.cpp.

Node Range::endContainer (  )  const

Node within which the range ends.

Definition at line 114 of file dom2_range.cpp.

long Range::endOffset (  )  const

Offset within the ending node of the range.

Definition at line 125 of file dom2_range.cpp.

DocumentFragment Range::extractContents (  ) 

Moves the contents of a range from the containing document or document fragment to a new DocumentFragment.

Returns:
A DocumentFragment containing the extracted contents.
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if any portion of the content of the range is read-only or any of the nodes which contain any of the content of the range are read-only.
HIERARCHY_REQUEST_ERR: Raised if a DocumentType node would be extracted into the new DocumentFragment.

Definition at line 278 of file dom2_range.cpp.

void Range::insertNode ( const Node newNode  ) 

Inserts a node into the document or document fragment at the start of the range.

Parameters:
newNode The node to insert at the start of the range
Returns:
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of the start of the range is read-only.
WRONG_DOCUMENT_ERR: Raised if newNode and the container of the start of the Range were not created from the same document.

HIERARCHY_REQUEST_ERR: Raised if the container of the start of the Range is of a type that does not allow children of the type of newNode or if newNode is an ancestor of the container .

Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if node is an Attr, Entity, Notation, DocumentFragment, or Document node.

Definition at line 300 of file dom2_range.cpp.

bool Range::isDetached (  )  const

not part of the DOM true if the range is detached

Definition at line 375 of file dom2_range.cpp.

void Range::selectNode ( const Node refNode  ) 

Select a node and its contents.

Parameters:
refNode The node to select.
Returns:
Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Attr, Entity, Notation or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.

Definition at line 229 of file dom2_range.cpp.

void Range::selectNodeContents ( const Node refNode  ) 

Select the contents within a node.

Parameters:
refNode Node to select from
Returns:
Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Attr, Entity, Notation or DocumentType node.

Definition at line 239 of file dom2_range.cpp.

void Range::setEnd ( const Node refNode,
long  offset 
)

Sets the attributes describing the end of a range.

Parameters:
refNode The refNode value. This parameter must be different from null .
offset The endOffset value.
Returns:
Exceptions:
RangeException NULL_NODE_ERR: Raised if refNode is null .
INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Attr, Entity, Notation, or DocumentType node.

Definition at line 168 of file dom2_range.cpp.

void Range::setEndAfter ( const Node refNode  ) 

Sets the end of a range to be after a node.

Parameters:
refNode Range ends after refNode .
Returns:
Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Attr, Entity, Notation or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.

Definition at line 209 of file dom2_range.cpp.

void Range::setEndBefore ( const Node refNode  ) 

Sets the end position to be before a node.

Parameters:
refNode Range ends before refNode
Returns:
Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Attr, Entity, Notation, or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.

Definition at line 199 of file dom2_range.cpp.

void Range::setStart ( const Node refNode,
long  offset 
)

Sets the attributes describing the start of the range.

Parameters:
refNode The refNode value. This parameter must be different from null .
offset The startOffset value.
Returns:
Exceptions:
RangeException NULL_NODE_ERR: Raised if refNode is null .
INVALID_NODE_TYPE_ERR: Raised if refNode or an ancestor of refNode is an Attr, Entity, Notation, or DocumentType node.

If an offset is out-of-bounds, should it just be fixed up or should an exception be raised.

Definition at line 158 of file dom2_range.cpp.

void Range::setStartAfter ( const Node refNode  ) 

Sets the start position to be after a node.

Parameters:
refNode Range starts after refNode
Returns:
Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Attr, Entity, Notation, or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.

Definition at line 189 of file dom2_range.cpp.

void Range::setStartBefore ( const Node refNode  ) 

Sets the start position to be before a node.

Parameters:
refNode Range starts before refNode
Returns:
Exceptions:
RangeException INVALID_NODE_TYPE_ERR: Raised if an ancestor of refNode is an Attr, Entity, Notation, or DocumentType node or if refNode is a Document, DocumentFragment, Attr, Entity, or Notation node.

Definition at line 178 of file dom2_range.cpp.

Node Range::startContainer (  )  const

Node within which the range begins.

Definition at line 91 of file dom2_range.cpp.

long Range::startOffset (  )  const

Offset within the starting node of the range.

Definition at line 102 of file dom2_range.cpp.

void Range::surroundContents ( const Node newParent  ) 

Reparents the contents of the range to the given node and inserts the node at the position of the start of the range.

Parameters:
newParent The node to surround the contents with.
Returns:
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of either end-point of the range is read-only.
WRONG_DOCUMENT_ERR: Raised if newParent and the container of the start of the Range were not created from the same document.

HIERARCHY_REQUEST_ERR: Raised if the container of the start of the Range is of a type that does not allow children of the type of newParent or if newParent is an ancestor of the container or if node would end up with a child node of a type not allowed by the type of node .

Exceptions:
RangeException BAD_ENDPOINTS_ERR: Raised if the range partially selects a non-text node.
INVALID_NODE_TYPE_ERR: Raised if node is an Attr, Entity, DocumentType, Notation, Document, or DocumentFragment node.

Definition at line 310 of file dom2_range.cpp.

DOMString Range::toString (  ) 

Returns the contents of a range as a string.

Returns:
The contents of the range.

Definition at line 331 of file dom2_range.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys