view.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
   Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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 KDELIBS_KTEXTEDITOR_VIEW_H
#define KDELIBS_KTEXTEDITOR_VIEW_H

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

// gui merging
#include <kxmlguiclient.h>

// widget
#include <QtGui/QWidget>

class QMenu;

namespace KTextEditor
{

class Document;

// KDE5: consider deriving from QFrame instead of QWidget, since e.g. the Oxygen style
// http://lxr.kde.org/source/kde/kde-workspace/kstyles/oxygen/oxygenstyle.cpp#614
// checks for a QFrame and then KStyle::pixelMetric returns a better margin (Frame_FrameWidth)
// This is needed because the Oxygen "focus border" paints over the line numbers otherwise.
class KTEXTEDITOR_EXPORT View :  public QWidget, public KXMLGUIClient
{
  Q_OBJECT

  public:
    View ( QWidget *parent );

    virtual ~View ();

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

    bool isActiveView() const;

  /*
   * General information about this view
   */
  public:
    virtual QString viewMode () const = 0;

    enum EditMode {
      EditInsert = 0,    
      EditOverwrite = 1, 
      EditViMode = 2     
    };

    virtual enum EditMode viewEditMode() 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 );

    void viewEditModeChanged ( KTextEditor::View *view,
                               enum KTextEditor::View::EditMode mode );

    void informationMessage ( KTextEditor::View *view, const QString &message );

    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 = 0L) 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;

  /*
   * 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 methodes.
   * This deals with text selection and copy&paste
   */
  public:
    virtual bool setSelection ( const Range &range ) = 0;

    virtual bool setSelection ( const Cursor &position,
                                int length,
                                bool wrap = true );

    virtual bool selection() const = 0;

    virtual const 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);

  private:
    class ViewPrivate* const d;
};

class KTEXTEDITOR_EXPORT CoordinatesToCursorInterface
{
  public:
    virtual ~CoordinatesToCursorInterface();

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

}

Q_DECLARE_INTERFACE(KTextEditor::CoordinatesToCursorInterface, "org.kde.KTextEditor.CoordinatesToCursorInterface")

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;