Interface nsIScriptableContentIteratorType

nsIScriptableContentIterator is designed to testing concrete classes of ContentIteratorBase.

Hierarchy

Properties

currentNode isDone

Methods

AddRef QueryInterface Release first initWithPositions initWithRange initWithRootNode last next positionAt prev

Properties

Readonly currentNode

currentNode: Node

Readonly isDone

isDone: bool

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

first

  • Returns void

initWithPositions

  • Parameters

    • aType: nsIScriptableContentIterator_IteratorType
    • aStartContainer: Node
    • aStartOffset: number
    • aEndContainer: Node
    • aEndOffset: number

    Returns void

initWithRange

  • Parameters

    • aType: nsIScriptableContentIterator_IteratorType
    • aRange: Range

    Returns void

initWithRootNode

  • You need to call initWith*() first. Then, the instance of this interface decides the type of iterator with its aType argument. You can call initWith*() multiple times, but you need to keep setting same type as previous call. If you set different type, these method with throw an exception.

    Parameters

    • aType: nsIScriptableContentIterator_IteratorType
    • aRoot: Node

    Returns void

last

  • Returns void

next

  • Returns void

positionAt

  • Parameters

    • aNode: Node

    Returns void

prev

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc