view.h

/*  SPDX-License-Identifier: LGPL-2.0-or-later

    Copyright (C) 2001 Christoph Cullmann <[email protected]>
    Copyright (C) 2005 Dominik Haumann ([email protected]) (documentation)

    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_VIEW_H
#define KTEXTEDITOR_VIEW_H

#include <ktexteditor/attribute.h>
#include <ktexteditor/document.h>
#include <ktexteditor/range.h>
#include <ktexteditor_export.h>

// gui merging
#include <KXMLGUIClient>

// widget
#include <QWidget>

class QMenu;

class KConfigGroup;

namespace KTextEditor
{
class Document;
class MainWindow;
class ViewPrivate;

class KTEXTEDITOR_EXPORT View : public QWidget, public KXMLGUIClient
{
    Q_OBJECT

protected:
    View(ViewPrivate *impl, QWidget *parent);

public:
    virtual ~View();

    /*
     * Accessor for the document
     */
public:
    virtual Document *document() const = 0;

    /*
     * General information about this view
     */
public:
    enum InputMode {
        NormalInputMode = 0, 
        ViInputMode = 1      
    };

    enum ViewMode {
        NormalModeInsert = 0,    
        NormalModeOverwrite = 1, 
        ViModeNormal = 10,
        ViModeInsert = 11,
        ViModeVisual = 12,
        ViModeVisualLine = 13,
        ViModeVisualBlock = 14,
        ViModeReplace = 15
    };

    enum LineType {
        RealLine = 0,   
        VisibleLine = 1 
    };
    virtual ViewMode viewMode() const = 0;

    virtual QString viewModeHuman() const = 0;

    void setViewInputMode(InputMode inputMode);

    virtual InputMode viewInputMode() const = 0;

    virtual QString viewInputModeHuman() const = 0;

    virtual KTextEditor::MainWindow *mainWindow() const = 0;

    /*
     * SIGNALS
     * following signals should be emitted by the editor view
     */
Q_SIGNALS:
    void focusIn(KTextEditor::View *view);

    void focusOut(KTextEditor::View *view);

    void viewModeChanged(KTextEditor::View *view, KTextEditor::View::ViewMode mode);

    void viewInputModeChanged(KTextEditor::View *view, KTextEditor::View::InputMode mode);

    void textInserted(KTextEditor::View *view, const KTextEditor::Cursor &position, const QString &text);

    /*
     * Context menu handling
     */
public:
    virtual void setContextMenu(QMenu *menu) = 0;

    virtual QMenu *contextMenu() const = 0;

    virtual QMenu *defaultContextMenu(QMenu *menu = nullptr) const = 0;

Q_SIGNALS:
    void contextMenuAboutToShow(KTextEditor::View *view, QMenu *menu);

    /*
     * Cursor handling
     */
public:
    virtual bool setCursorPosition(Cursor position) = 0;

    virtual Cursor cursorPosition() const = 0;

    virtual Cursor cursorPositionVirtual() const = 0;

    virtual QPoint cursorToCoordinate(const KTextEditor::Cursor &cursor) const = 0;

    virtual QPoint cursorPositionCoordinates() const = 0;

    virtual KTextEditor::Cursor coordinatesToCursor(const QPoint &coord) const = 0;

    /*
     * SIGNALS
     * following signals should be emitted by the editor view
     * if the cursor position changes
     */
Q_SIGNALS:
    void cursorPositionChanged(KTextEditor::View *view, const KTextEditor::Cursor &newPosition);

    void verticalScrollPositionChanged(KTextEditor::View *view, const KTextEditor::Cursor &newPos);

    void horizontalScrollPositionChanged(KTextEditor::View *view);
    /*
     * Mouse position
     */
public:
    virtual bool mouseTrackingEnabled() const = 0;

    virtual bool setMouseTrackingEnabled(bool enable) = 0;

Q_SIGNALS:
    void mousePositionChanged(KTextEditor::View *view, const KTextEditor::Cursor &newPosition);

    /*
     * Selection methods.
     * This deals with text selection and copy&paste
     */
public:
    virtual bool setSelection(const Range &range) = 0;

    virtual bool selection() const = 0;

    virtual Range selectionRange() const = 0;

    virtual QString selectionText() const = 0;

    virtual bool removeSelection() = 0;

    virtual bool removeSelectionText() = 0;

    /*
     * Blockselection stuff
     */
public:
    virtual bool setBlockSelection(bool on) = 0;

    virtual bool blockSelection() const = 0;

    /*
     * SIGNALS
     * following signals should be emitted by the editor view for selection
     * handling.
     */
Q_SIGNALS:
    void selectionChanged(KTextEditor::View *view);

public:
    virtual bool insertText(const QString &text);

    bool insertTemplate(const KTextEditor::Cursor &insertPosition, const QString &templateString, const QString &script = QString());

    void setScrollPosition(KTextEditor::Cursor &cursor);

    void setHorizontalScrollPosition(int x);

    KTextEditor::Cursor maxScrollPosition() const;

    int firstDisplayedLine(LineType lineType = RealLine) const;

    int lastDisplayedLine(LineType lineType = RealLine) const;

    QRect textAreaRect() const;

public:
    virtual bool print() = 0;

    virtual void printPreview() = 0;

    bool isStatusBarEnabled() const;

    void setStatusBarEnabled(bool enable);

Q_SIGNALS:
    void statusBarEnabledChanged(KTextEditor::View *view, bool enabled);

public:
    virtual void readSessionConfig(const KConfigGroup &config, const QSet<QString> &flags = QSet<QString>()) = 0;

    virtual void writeSessionConfig(KConfigGroup &config, const QSet<QString> &flags = QSet<QString>()) = 0;

public:
    virtual KTextEditor::Attribute::Ptr defaultStyleAttribute(KTextEditor::DefaultStyle defaultStyle) const = 0;

    virtual QList<KTextEditor::AttributeBlock> lineAttributes(int line) = 0;

private:
    ViewPrivate *const d;
};

}

#endif