smartcursor.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2003-2005 Hamish Rodda <rodda@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 KDELIBS_KTEXTEDITOR_SMARTCURSOR_H
#define KDELIBS_KTEXTEDITOR_SMARTCURSOR_H

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

namespace KTextEditor
{
class SmartRange;

class SmartCursorWatcher;
class SmartCursorNotifier;

class KTEXTEDITOR_EXPORT SmartCursor : public Cursor
{
  friend class SmartRange;

  public:
    virtual ~SmartCursor();

    virtual bool isSmartCursor() const;

    virtual SmartCursor* toSmartCursor() const;

    SmartRange* smartRange() const;

    //BEGIN Functionality present from having this cursor associated with a Document
    Document* document() const;

    virtual bool atEndOfLine() const;

    virtual bool atEndOfDocument() const;

    virtual bool isValid() const;

    QChar character() const;

    virtual bool insertText(const QStringList &text, bool block = false);

    enum AdvanceMode {
      ByCharacter,
      ByCursorPosition
    };

    virtual bool advance(int distance, AdvanceMode mode = ByCharacter);
    //END

    //BEGIN Behavior methods
    enum InsertBehavior {
      StayOnInsert = 0,
      MoveOnInsert
    };
    InsertBehavior insertBehavior() const;

    void setInsertBehavior(InsertBehavior insertBehavior);
    //END

    //BEGIN Notification methods
    virtual bool hasNotifier() const = 0;

    virtual SmartCursorNotifier* notifier() = 0;

    virtual void deleteNotifier() = 0;

    virtual SmartCursorWatcher* watcher() const = 0;

    virtual void setWatcher(SmartCursorWatcher* watcher = 0L) = 0;
    //END

    inline SmartCursor& operator=(const SmartCursor& cursor)
      { setPosition(cursor); return *this; }

  protected:
    SmartCursor(const Cursor& position, Document* doc, InsertBehavior insertBehavior);

  private:
    SmartCursor(const SmartCursor&);

    Document* m_doc;

    bool m_moveOnInsert : 1;
};

}

#endif

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