foldinginterface.h

Go to the documentation of this file.

/*  This file is part of the Kate project.
 *
 *  Copyright (C) 2013 Christoph Cullmann <cullmann@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 KTEXTEDITOR_FOLDINGINTERFACE_H
#define KTEXTEDITOR_FOLDINGINTERFACE_H

// #include "ktexteditor_export.h"

#include <QFlags>

namespace KTextEditor {

class Range;

class KTEXTEDITOR_EXPORT FoldingInterface
{
  public:
    FoldingInterface ();

    virtual ~FoldingInterface ();

    enum FoldingRangeFlag {
      Persistent = 0x1,

      Folded = 0x2
    };
    Q_DECLARE_FLAGS(FoldingRangeFlags, FoldingRangeFlag);

    qint64 newFoldingRange (const KTextEditor::Range &range, FoldingRangeFlags flags = FoldingRangeFlags());

    virtual bool foldRange (qint64 id) = 0;

    virtual bool unfoldRange (qint64 id, bool remove = false) = 0;

    virtual QVector<QPair<qint64, FoldingRangeFlags> > foldingRangesStartingOnLine (int line) const = 0;

    virtual bool lineContainsStartFoldingRanges (int line) const = 0;

    virtual qint64 foldLine (int line) const = 0;

    virtual bool unfoldLine (int line) const = 0;

    virtual bool isLineVisible (int line, qint64 *foldedRangeId = 0) const = 0;

    virtual void ensureLineIsVisible (int line) = 0;

    virtual int visibleLines () const = 0;

    virtual int lineToVisibleLine (int line) const = 0;

    virtual int visibleLineToLine (int visibleLine) const = 0;

  public Q_SLOTS:
    void clear ();

  Q_SIGNALS:
    void foldingRangesChanged ();
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(KTextEditor::FoldingInterface::FoldingRangeFlags)

#endif