• Skip to content
  • Skip to link menu
KDE 4.5 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
Note: This is a reduced mirror of the KDE API documentation hosted by Michael Pyne.
 

Kate

KateSmartCursor Class Reference

Possible additional features:
  • Notification when a cursor enters or exits a view
  • suggest something :).
More...

#include <katesmartcursor.h>

Inheritance diagram for KateSmartCursor:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual bool atEndOfLine () const
bool cursorMoved () const
virtual void deleteNotifier ()
bool feedbackEnabled () const
virtual bool hasNotifier () const
bool isInternal () const
virtual bool isValid (const Cursor &position) const
virtual bool isValid () const
KateDocument * kateDocument () const
 KateSmartCursor (KTextEditor::Document *doc, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert)
 KateSmartCursor (const KTextEditor::Cursor &position, KTextEditor::Document *doc, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert)
const KTextEditor::Cursor & lastPosition () const
virtual int line () const
void migrate (KateSmartGroup *newGroup)
virtual
KTextEditor::SmartCursorNotifier * 
notifier ()
 operator QString ()
KateSmartCursor & operator= (const KTextEditor::Cursor &rhs)
void resetLastPosition ()
void setInternal ()
virtual void setLine (int line)
virtual void setPosition (const KTextEditor::Cursor &pos)
virtual void setWatcher (KTextEditor::SmartCursorWatcher *watcher=0L)
void shifted ()
KateSmartGroup * smartGroup () const
bool translate (const KateEditInfo &edit)
void translated (const KateEditInfo &edit)
void unbindFromRange ()
virtual
KTextEditor::SmartCursorWatcher * 
watcher () const
virtual ~KateSmartCursor ()

Protected Member Functions

virtual void checkFeedback ()
void setLineInternal (int newLine, bool internal=true)
void setPositionInternal (const KTextEditor::Cursor &pos, bool internal=true)

Detailed Description

Possible additional features:
  • Notification when a cursor enters or exits a view
  • suggest something :).

Unresolved issues:

  • testing, testing, testing
  • api niceness Internal implementation of KTextEditor::SmartCursor
    Author:
    Hamish Rodda

Definition at line 50 of file katesmartcursor.h.


Constructor & Destructor Documentation

KateSmartCursor::KateSmartCursor ( const KTextEditor::Cursor &  position,
KTextEditor::Document *  doc,
KTextEditor::SmartCursor::InsertBehavior  insertBehavior = KTextEditor::SmartCursor::MoveOnInsert 
)

Definition at line 49 of file katesmartcursor.cpp.

KateSmartCursor::KateSmartCursor ( KTextEditor::Document *  doc,
KTextEditor::SmartCursor::InsertBehavior  insertBehavior = KTextEditor::SmartCursor::MoveOnInsert 
) [explicit]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 76 of file katesmartcursor.cpp.

KateSmartCursor::~KateSmartCursor (  )  [virtual]

Definition at line 96 of file katesmartcursor.cpp.


Member Function Documentation

bool KateSmartCursor::atEndOfLine (  )  const [virtual]

Reimplemented from KTextEditor::SmartCursor.

Definition at line 130 of file katesmartcursor.cpp.

void KateSmartCursor::checkFeedback (  )  [protected, virtual]

Definition at line 135 of file katesmartcursor.cpp.

bool KateSmartCursor::cursorMoved (  )  const

This is a function solely for use by KateSuperRange.

Used to see if a change in position has occurred since it was last called.

Definition at line 330 of file katesmartcursor.cpp.

void KateSmartCursor::deleteNotifier (  )  [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 243 of file katesmartcursor.cpp.

bool KateSmartCursor::feedbackEnabled (  )  const [inline]

Definition at line 88 of file katesmartcursor.h.

bool KateSmartCursor::hasNotifier (  )  const [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 441 of file katesmartcursor.cpp.

bool KateSmartCursor::isInternal (  )  const [inline]

Definition at line 62 of file katesmartcursor.h.

bool KateSmartCursor::isValid ( const Cursor &  position  )  const [virtual]

Definition at line 125 of file katesmartcursor.cpp.

bool KateSmartCursor::isValid (  )  const [virtual]

Reimplemented from KTextEditor::SmartCursor.

Definition at line 120 of file katesmartcursor.cpp.

KateDocument * KateSmartCursor::kateDocument (  )  const

Definition at line 115 of file katesmartcursor.cpp.

const KTextEditor::Cursor& KateSmartCursor::lastPosition (  )  const [inline]

Definition at line 112 of file katesmartcursor.h.

int KateSmartCursor::line (  )  const [virtual]

Reimplemented from KTextEditor::Cursor.

Definition at line 147 of file katesmartcursor.cpp.

void KateSmartCursor::migrate ( KateSmartGroup *  newGroup  ) 

Definition at line 418 of file katesmartcursor.cpp.

KTextEditor::SmartCursorNotifier * KateSmartCursor::notifier (  )  [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 234 of file katesmartcursor.cpp.

KateSmartCursor::operator QString (  ) 

Debug: output the position.

Definition at line 110 of file katesmartcursor.cpp.

KateSmartCursor& KateSmartCursor::operator= ( const KTextEditor::Cursor &  rhs  )  [inline]

Reimplemented from KTextEditor::Cursor.

Definition at line 71 of file katesmartcursor.h.

void KateSmartCursor::resetLastPosition (  ) 

Definition at line 436 of file katesmartcursor.cpp.

void KateSmartCursor::setInternal (  ) 

Definition at line 456 of file katesmartcursor.cpp.

void KateSmartCursor::setLine ( int  line  )  [virtual]

Reimplemented from KTextEditor::Cursor.

Definition at line 152 of file katesmartcursor.cpp.

void KateSmartCursor::setLineInternal ( int  newLine,
bool  internal = true 
) [protected]

Definition at line 337 of file katesmartcursor.cpp.

void KateSmartCursor::setPosition ( const KTextEditor::Cursor &  pos  )  [virtual]

Reimplemented from KTextEditor::Cursor.

Definition at line 425 of file katesmartcursor.cpp.

void KateSmartCursor::setPositionInternal ( const KTextEditor::Cursor &  pos,
bool  internal = true 
) [protected]

Definition at line 157 of file katesmartcursor.cpp.

void KateSmartCursor::setWatcher ( KTextEditor::SmartCursorWatcher *  watcher = 0L  )  [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 250 of file katesmartcursor.cpp.

void KateSmartCursor::shifted (  ) 

Definition at line 404 of file katesmartcursor.cpp.

KateSmartGroup* KateSmartCursor::smartGroup (  )  const [inline]

Definition at line 90 of file katesmartcursor.h.

bool KateSmartCursor::translate ( const KateEditInfo &  edit  ) 

Definition at line 256 of file katesmartcursor.cpp.

void KateSmartCursor::translated ( const KateEditInfo &  edit  ) 

If the cursor is requesting feedback, this is called whenever the cursor's position moves and it's not needing to be adjusted via translateCursor().

Definition at line 342 of file katesmartcursor.cpp.

void KateSmartCursor::unbindFromRange (  ) 

Definition at line 451 of file katesmartcursor.cpp.

KTextEditor::SmartCursorWatcher * KateSmartCursor::watcher (  )  const [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 446 of file katesmartcursor.cpp.


The documentation for this class was generated from the following files:
  • katesmartcursor.h
  • katesmartcursor.cpp

Kate

Skip menu "Kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

Class Picker

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  •     Sodep
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.9
This website is maintained by Michael Pyne, and is a reduced mirror of the KDE API docs. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal