dom2_range.h

Go to the documentation of this file.

/*
 * This file is part of the DOM implementation for KDE.
 *
 * Copyright 1999 Lars Knoll (knoll@kde.org)
 * Copyright 2000 Gunnstein Lye (gunnstein@netcom.no)
 * Copyright 2000 Frederik Holljen (frederik.holljen@hig.no)
 * Copyright 2001 Peter Kelly (pmk@post.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.
 *
 * This file includes excerpts from the Document Object Model (DOM)
 * Level 2 Specification (Candidate Recommendation)
 * http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510/
 * Copyright © 2000 W3C® (MIT, INRIA, Keio), All Rights Reserved.
 *
 */
#ifndef _dom2_range_h_
#define _dom2_range_h_

#include <dom/dom_doc.h>
#include <dom/dom_misc.h>

namespace DOM {

class DocumentFragment;
class Node;
class DOMString;
class DocumentImpl;
class RangeImpl;

class DOMException;

// Introduced in DOM Level 2:
class KHTML_EXPORT RangeException {
public:
    RangeException(unsigned short _code) { code = _code; }
    RangeException(const RangeException &other) { code = other.code; }

    RangeException & operator = (const RangeException &other)
    { code = other.code; return *this; }

    virtual ~RangeException() {}
    enum RangeExceptionCode {
        BAD_BOUNDARYPOINTS_ERR         = 1,
        INVALID_NODE_TYPE_ERR          = 2,
        _EXCEPTION_OFFSET              = 2000,
        _EXCEPTION_MAX                 = 2999
    };
    unsigned short code;

    DOMString codeAsString() const;

    static DOMString codeAsString(int rangeCode);

    static bool isRangeExceptionCode(int exceptioncode);
};


class KHTML_EXPORT Range
{
    friend class DocumentImpl;
    friend class Document;
    friend class RangeImpl;
public:
    Range();
    Range(const Document rootContainer);
    Range(const Range &other);
    Range(const Node startContainer, const long startOffset, const Node endContainer, const long endOffset);

    Range & operator = (const Range &other);

    ~Range();

    Node startContainer() const;

    long startOffset() const;

    Node endContainer() const;

    long endOffset() const;

    bool collapsed() const;

    // ### BIC make const in the next release
    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 );

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

    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 (  );

    /* Mozilla extension - only works for HTML documents. */
    DocumentFragment createContextualFragment (const DOMString &html);

    void detach (  );

    bool isDetached() const;

    RangeImpl *handle() const;
    bool isNull() const;
    Range(RangeImpl *i);
protected:
    RangeImpl *impl;
private:
    void throwException(int exceptioncode) const;
};

} // namespace

#endif