xref: /external/webkit/Source/WebCore/dom/NodeIterator.idl

/*
 * Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
 * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

module traversal {

    // Introduced in DOM Level 2:
    interface [
        CustomMarkFunction
    ] NodeIterator {
        readonly attribute Node root;
        readonly attribute unsigned long whatToShow;
        readonly attribute NodeFilter filter;
        readonly attribute boolean expandEntityReferences;
        readonly attribute Node referenceNode;
        readonly attribute boolean pointerBeforeReferenceNode;

        [CallWith=ScriptState] Node nextNode()
            raises (DOMException);
        [CallWith=ScriptState] Node previousNode()
            raises (DOMException);
        void detach();
    };

}