qt-creator/src/plugins/texteditor/indenter.h

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef INDENTER_H
#define INDENTER_H

#include "texteditor_global.h"

#include <QtCore/QChar>
#include <QtGui/QTextBlock>

QT_BEGIN_NAMESPACE
class QTextDocument;
class QTextCursor;
QT_END_NAMESPACE

namespace TextEditor {

class BaseTextEditor;

class TEXTEDITOR_EXPORT Indenter
{
public:
    Indenter();
    virtual ~Indenter();

    // Returns true if key triggers an indent.
    bool isElectricCharacter(const QChar &ch) const;
    // Indent a text block based on previous line. Default does nothing
    void indentBlock(QTextDocument *doc,
                     const QTextBlock &block,
                     const QChar &typedChar,
                     BaseTextEditor *editor);
    // Indent at cursor. Calls indentBlock for selection or current line.
    void indent(QTextDocument *doc,
                const QTextCursor &cursor,
                const QChar &typedChar,
                BaseTextEditor *editor);
    // Reindent at cursor. Selection will be adjusted according to the indentation
    // change of the first block.
    void reindent(QTextDocument *doc, const QTextCursor &cursor, BaseTextEditor *editor);

private:
    virtual bool doIsElectricalCharacter(const QChar &ch) const;
    virtual void doIndentBlock(QTextDocument *doc,
                               const QTextBlock &block,
                               const QChar &typedChar,
                               BaseTextEditor *editor);
    virtual void doIndent(QTextDocument *doc,
                          const QTextCursor &cursor,
                          const QChar &typedChar,
                          BaseTextEditor *editor);
    virtual void doReindent(QTextDocument *doc, const QTextCursor &cursor, BaseTextEditor *editor);
};

} // namespace TextEditor

#endif // INDENTER_H