ktexteditor.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2000 Simon Hausmann <hausmann@kde.org>
   Copyright (C) 2002 Joseph Wenninger <jowenn@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., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#ifndef __ktexteditor_h__
#define __ktexteditor_h__

#include <qwidget.h>
#include <qlist.h>

namespace KTextEditor
{

class Document;

class View : public QWidget
{
  Q_OBJECT
                
public:
  View( Document *doc, QWidget *parent, const char *name = 0 );
  virtual ~View();

  virtual Document *document() const; // XXX fix when renaming KXMLGUIClient::document

  virtual void setCursorPosition( int line, int col, bool mark = false ) = 0;
  virtual void getCursorPosition( int *line, int *col ) = 0;

  virtual void insertText( const QString &text, bool mark = false );

  virtual bool isOverwriteMode() const = 0;

  virtual void setInternalContextMenuEnabled( bool b );
  virtual bool internalContextMenuEnabled() const;

public slots:
  virtual void setOverwriteMode( bool b ) = 0;

signals:
  void contextPopupMenu( const QPoint &p );

  void scrollValueChanged( int value );
  
private:
  class ViewPrivate;
  ViewPrivate *d;
};

class Document : public QObject
{
  Q_OBJECT
public:
  Document( QObject *parent = 0, const char *name = 0 );
  virtual ~Document();

  virtual View *createView( QWidget *parent, const char *name = 0 ) = 0;

  /*
   * Accessor to the list of views.
   */
  virtual QList<View> views() const;

  virtual QString textLine( int line ) const = 0;

  virtual void setSelection( int row_from, int col_from, int row_to, int col_t ) = 0;
  virtual bool hasSelection() const = 0;
  virtual QString selection() const = 0;

  virtual int numLines() const = 0;

  virtual void insertLine( const QString &s, int line = -1 ) = 0;

  virtual void insertAt( const QString &s, int line, int col, bool mark = FALSE ) = 0;

  virtual void removeLine( int line ) = 0;

  virtual QString text() const = 0;

  virtual int length() const = 0;

public slots:
  virtual void setText( const QString &t ) = 0;

signals:

  void textChanged();

  void deleted( int startLine, int endLine );
  
  void inserted( int startLine, int endLine );

protected:
  virtual void addView( View *view );

  virtual void removeView( View *view );

  QList<View> m_views;

private slots:
                
  void slotViewDestroyed();

private:
  class DocumentPrivate;
  DocumentPrivate *d;
};

};

#endif

---