itexteditor.h 5.4 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33 34 35 36 37 38 39 40 41
#ifndef ITEXTEDITOR_H
#define ITEXTEDITOR_H

#include "texteditor_global.h"

#include <coreplugin/editormanager/ieditor.h>

#include <QtCore/QObject>
#include <QtCore/QList>
42
#include <QtCore/QMap>
43
#include <QtGui/QIcon>
con's avatar
con committed
44 45

QT_BEGIN_NAMESPACE
46
class QIcon;
47 48
class QMenu;
class QPainter;
49
class QPoint;
50 51
class QRect;
class QTextBlock;
con's avatar
con committed
52 53 54 55 56 57
QT_END_NAMESPACE

namespace TextEditor {

class ITextEditor;

Daniel Teske's avatar
Daniel Teske committed
58
class TEXTEDITOR_EXPORT ITextMark
con's avatar
con committed
59 60
{
public:
61
    ITextMark() : m_priority(NormalPriority) {}
Daniel Teske's avatar
Daniel Teske committed
62
    virtual ~ITextMark();
con's avatar
con committed
63

64 65 66 67 68 69 70 71
    // determine order on markers on the same line.
    enum Priority
    {
        LowPriority,
        NormalPriority,
        HighPriority // shown on top.
    };

72 73 74 75 76
    virtual void paint(QPainter *painter, const QRect &rect) const;
    virtual void updateLineNumber(int lineNumber);
    virtual void updateBlock(const QTextBlock &block);
    virtual void removedFromEditor();
    virtual void documentClosing();
77 78 79
    void setIcon(const QIcon &icon);
    Priority priority() const;
    void setPriority(Priority prioriy);
80
    virtual bool visible() const;
81
    virtual double widthFactor() const;
82 83 84 85

private:
    QIcon m_icon;
    Priority m_priority;
con's avatar
con committed
86 87 88 89 90 91 92 93 94 95 96
};

typedef QList<ITextMark *> TextMarks;


class TEXTEDITOR_EXPORT ITextMarkable : public QObject
{
    Q_OBJECT
public:
    ITextMarkable(QObject *parent = 0) : QObject(parent) {}

97
    virtual bool addMark(ITextMark *mark, int line) = 0;
con's avatar
con committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    virtual TextMarks marksAt(int line) const = 0;
    virtual void removeMark(ITextMark *mark) = 0;
    virtual bool hasMark(ITextMark *mark) const = 0;
    virtual void updateMark(ITextMark *mark) = 0;
};

class TEXTEDITOR_EXPORT ITextEditor : public Core::IEditor
{
    Q_OBJECT
public:
    enum PositionOperation {
        Current = 1,
        EndOfLine = 2,
        StartOfLine = 3,
        Anchor = 4,
        EndOfDoc = 5
    };

    ITextEditor() {}

    virtual int find(const QString &string) const = 0;
    virtual int position(PositionOperation posOp = Current, int at = -1) const = 0;
    virtual void convertPosition(int pos, int *line, int *column) const = 0;
    virtual QRect cursorRect(int pos = -1) const = 0;
122 123
    virtual int columnCount() const = 0;
    virtual int rowCount() const = 0;
con's avatar
con committed
124 125 126 127 128 129

    virtual QString contents() const = 0;
    virtual QString selectedText() const = 0;
    virtual QString textAt(int pos, int length) const = 0;
    virtual QChar characterAt(int pos) const = 0;

130 131 132 133 134 135 136 137 138 139 140
    /*! Removes \a length characters to the right of the cursor. */
    virtual void remove(int length) = 0;
    /*! Inserts the given string to the right of the cursor. */
    virtual void insert(const QString &string) = 0;
    /*! Replaces \a length characters to the right of the cursor with the given string. */
    virtual void replace(int length, const QString &string) = 0;
    /*! Sets current cursor position to \a pos. */
    virtual void setCursorPosition(int pos) = 0;
    /*! Selects text between current cursor position and \a toPos. */
    virtual void select(int toPos) = 0;

con's avatar
con committed
141 142 143 144
    virtual ITextMarkable *markableInterface() = 0;

    virtual void setContextHelpId(const QString &) = 0;

145 146 147 148 149 150 151
    enum TextCodecReason {
        TextCodecOtherReason,
        TextCodecFromSystemSetting,
        TextCodecFromProjectSetting
    };

    virtual void setTextCodec(QTextCodec *, TextCodecReason reason = TextCodecOtherReason) = 0;
con's avatar
con committed
152 153
    virtual QTextCodec *textCodec() const = 0;

154
    static QMap<QString, QString> openedTextEditorsContents();
155
    static QMap<QString, QTextCodec *> openedTextEditorsEncodings();
con's avatar
con committed
156

157 158 159 160 161
    enum MarkRequestKind {
        BreakpointRequest,
        BookmarkRequest
    };

con's avatar
con committed
162 163
signals:
    void contentsChanged();
164
    void contentsChangedBecauseOfUndo();
165
    void markRequested(TextEditor::ITextEditor *editor, int line, TextEditor::ITextEditor::MarkRequestKind kind);
166
    void markContextMenuRequested(TextEditor::ITextEditor *editor, int line, QMenu *menu);
167
    void tooltipOverrideRequested(TextEditor::ITextEditor *editor, const QPoint &globalPos, int position, bool *handled);
con's avatar
con committed
168 169 170 171 172 173 174
    void tooltipRequested(TextEditor::ITextEditor *editor, const QPoint &globalPos, int position);
    void contextHelpIdRequested(TextEditor::ITextEditor *editor, int position);
};

} // namespace TextEditor

#endif // ITEXTEDITOR_H