katetextrange.h

Go to the documentation of this file.

/*  This file is part of the Kate project.
 *
 *  Copyright (C) 2010 Christoph Cullmann <cullmann@kde.org>
 *
 *  Based on code of the SmartCursor/Range by:
 *  Copyright (C) 2003-2005 Hamish Rodda <rodda@kde.org>
 *
 *  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.
 */

#ifndef KATE_TEXTRANGE_H
#define KATE_TEXTRANGE_H

#include <ktexteditor/view.h>
#include <ktexteditor/movingrange.h>
#include <ktexteditor/movingrangefeedback.h>

#include "katepartprivate_export.h"
#include "katetextcursor.h"

namespace Kate {

class TextBuffer;

class KATEPART_TESTS_EXPORT TextRange : public KTextEditor::MovingRange {
  // this is a friend, block changes might invalidate ranges...
  friend class TextBlock;

  public:
    TextRange (TextBuffer &buffer, const KTextEditor::Range &range, InsertBehaviors insertBehavior, EmptyBehavior emptyBehavior = AllowEmpty);

    ~TextRange ();

    void setInsertBehaviors (InsertBehaviors insertBehaviors);

    InsertBehaviors insertBehaviors () const;

    void setEmptyBehavior (EmptyBehavior emptyBehavior);

    EmptyBehavior emptyBehavior () const { return m_invalidateIfEmpty ? InvalidateIfEmpty : AllowEmpty; }

    KTextEditor::Document *document () const;

    void setRange (const KTextEditor::Range &range);

    void setRange (const KTextEditor::Cursor &start, const KTextEditor::Cursor &end) { KTextEditor::MovingRange::setRange (start, end); }

    const KTextEditor::MovingCursor &start () const { return m_start; }

    const TextCursor &startInternal() const { return m_start; }

    const KTextEditor::MovingCursor &end () const { return m_end; }

    const TextCursor &endInternal () const { return m_end; }

    const KTextEditor::Range toRange () const { return KTextEditor::Range (start().toCursor(), end().toCursor()); }

    operator const KTextEditor::Range () const { return KTextEditor::Range (start().toCursor(), end().toCursor()); }

    KTextEditor::View *view () const { return m_view; }

    void setView (KTextEditor::View *view);

    KTextEditor::Attribute::Ptr attribute () const { return m_attribute; }

    bool hasAttribute() const { return !m_attribute.isNull(); }

    void setAttribute (KTextEditor::Attribute::Ptr attribute);

    KTextEditor::MovingRangeFeedback *feedback () const { return m_feedback; }

    void setFeedback (KTextEditor::MovingRangeFeedback *feedback);

    bool attributeOnlyForViews () const { return m_attributeOnlyForViews; }

    void setAttributeOnlyForViews (bool onlyForViews);
    
    qreal zDepth () const { return m_zDepth; }
    
    void setZDepth (qreal zDepth);

  private:
    void checkValidity (int oldStartLine = -1, int oldEndLine = -1, bool notifyAboutChange = true);

    void fixLookup (int oldStartLine, int oldEndLine, int startLine, int endLine);

  private:
    TextBuffer &m_buffer;

    TextCursor m_start;

    TextCursor m_end;

    KTextEditor::View *m_view;

    KTextEditor::Attribute::Ptr m_attribute;

    KTextEditor::MovingRangeFeedback *m_feedback;
    
    qreal m_zDepth;

    bool m_attributeOnlyForViews;

    bool m_invalidateIfEmpty;
};

}

#endif