view.h

/* This file is part of the KDE libraries
   Copyright (C) 2001 Christoph Cullmann <cullmann@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 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 _KATE_VIEW_INCLUDE_
#define _KATE_VIEW_INCLUDE_
 
#include <tdetexteditor/document.h>
#include <tdetexteditor/view.h>
#include <tdetexteditor/clipboardinterface.h>
#include <tdetexteditor/popupmenuinterface.h>
#include <tdetexteditor/markinterface.h>
#include <tdetexteditor/viewcursorinterface.h>
#include <tdetexteditor/codecompletioninterface.h>
#include <tdetexteditor/dynwordwrapinterface.h>
 
class TDEConfig;
 
namespace Kate
{
 
class Document;
 
class KATEPARTINTERFACES_EXPORT View : public KTextEditor::View, public KTextEditor::ClipboardInterface,
              public KTextEditor::PopupMenuInterface, public KTextEditor::ViewCursorInterface,
              public KTextEditor::CodeCompletionInterface, public KTextEditor::DynWordWrapInterface
{
  TQ_OBJECT
 
  public:
    enum saveResult { SAVE_OK, SAVE_CANCEL, SAVE_RETRY, SAVE_ERROR };
    View ( KTextEditor::Document *, TQWidget *, const char *name = 0 );
    virtual ~View ();
    virtual bool isOverwriteMode() const  { return false; }
    virtual void setOverwriteMode( bool ) { }
    virtual TQString currentTextLine() { return 0L; }
    virtual TQString currentWord() { return 0L; }
    virtual TQString word(int , int ) { return 0L; }
    virtual void insertText(const TQString &mark ) { Q_UNUSED(mark); }
    virtual bool canDiscard() { return false; }
 
  public:
    virtual int tabWidth() = 0;
    virtual void setTabWidth(int) = 0;
    virtual void setEncoding (TQString e) = 0;
 
    virtual bool isLastView() = 0;
 
  public slots:
    virtual void flush () { ; };
    virtual saveResult save() { return SAVE_CANCEL; };
    virtual saveResult saveAs() { return SAVE_CANCEL; };
    virtual void indent() { ; };
    virtual void unIndent() { ; };
    virtual void cleanIndent() { ; };
    virtual void comment() { ; };
    virtual void uncomment() { ; };
    virtual void keyReturn () { ; };
    virtual void keyDelete () { ; };
    virtual void backspace () { ; };
    virtual void killLine () { ; };
    virtual void cursorLeft () { ; };
    virtual void shiftCursorLeft () { ; };
    virtual void cursorRight () { ; };
    virtual void shiftCursorRight () { ; };
    virtual void wordLeft () { ; };
    virtual void shiftWordLeft () { ; };
    virtual void wordRight () { ; };
    virtual void shiftWordRight () { ; };
    virtual void home () { ; };
    virtual void shiftHome () { ; };
    virtual void end () { ; };
    virtual void shiftEnd () { ; };
    virtual void up () { ; };
    virtual void shiftUp () { ; };
    virtual void down () { ; };
    virtual void shiftDown () { ; };
    virtual void scrollUp () { ; };
    virtual void scrollDown () { ; };
    virtual void topOfView () { ; };
    virtual void bottomOfView () { ; };
    virtual void pageUp () { ; };
    virtual void shiftPageUp () { ; };
    virtual void pageDown () { ; };
    virtual void shiftPageDown () { ; };
    virtual void top () { ; };
    virtual void shiftTop () { ; };
    virtual void bottom () { ; };
    virtual void shiftBottom () { ; };
    virtual void find() { ; };
    virtual void replace() { ; };
    virtual void gotoLine() { ; };
 
  public:
    virtual void readSessionConfig(TDEConfig *) { ; };
    virtual void writeSessionConfig(TDEConfig *) { ; };
 
  public slots:
    virtual int getEol() { return 0L; }
    virtual void setEol(int) { }
    // Should remove this, it's redundant.
    virtual void setFocus () { TQWidget::setFocus(); }
    virtual void findAgain(bool forward ) { Q_UNUSED(forward); }
    virtual void findAgain () { };
    virtual void findPrev () { }
    virtual void slotEditCommand () { }
 
    virtual void setIconBorder (bool enable ) { Q_UNUSED(enable); }
    virtual void toggleIconBorder () { }
    virtual void setLineNumbersOn (bool enable) { Q_UNUSED(enable); }
    virtual void toggleLineNumbersOn () {}
 
  public:
    virtual bool iconBorder() { return false; }
    virtual bool lineNumbersOn() { return false; }
    virtual Document *getDoc () { return 0L; }
 
  public slots:
    virtual void slotIncFontSizes () { }
    virtual void slotDecFontSizes () { }
 
    virtual void gotoMark (KTextEditor::Mark *mark) = 0;
 
    // TODO: Remove when BIC is allowed
    virtual void toggleBookmark () {}
 
    virtual void gotoLineNumber( int ) = 0;
 
  signals:
    void gotFocus (View *);
//  void newStatus(); // Kate app connects to this signal, should be in the interface
 
  public:
    virtual void setActive (bool b) = 0;
    virtual bool isActive () = 0;
};
 
KATEPARTINTERFACES_EXPORT View *view (KTextEditor::View *view);
 
}
 
#endif