• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

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:
KTextEditor::SmartCursor KTextEditor::Cursor

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 47 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 31 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 58 of file katesmartcursor.cpp.

KateSmartCursor::~KateSmartCursor (  )  [virtual]

Definition at line 78 of file katesmartcursor.cpp.


Member Function Documentation

bool KateSmartCursor::atEndOfLine (  )  const [virtual]

Reimplemented from KTextEditor::SmartCursor.

Definition at line 112 of file katesmartcursor.cpp.

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

Definition at line 117 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 312 of file katesmartcursor.cpp.

void KateSmartCursor::deleteNotifier (  )  [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 225 of file katesmartcursor.cpp.

bool KateSmartCursor::feedbackEnabled (  )  const [inline]

Definition at line 85 of file katesmartcursor.h.

bool KateSmartCursor::hasNotifier (  )  const [virtual]

Implements KTextEditor::SmartCursor.

Definition at line 423 of file katesmartcursor.cpp.

bool KateSmartCursor::isInternal (  )  const [inline]

Definition at line 59 of file katesmartcursor.h.

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

Definition at line 107 of file katesmartcursor.cpp.

bool KateSmartCursor::isValid (  )  const [virtual]

Reimplemented from KTextEditor::SmartCursor.

Definition at line 102 of file katesmartcursor.cpp.

KateDocument * KateSmartCursor::kateDocument (  )  const

Definition at line 97 of file katesmartcursor.cpp.

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

Definition at line 109 of file katesmartcursor.h.

int KateSmartCursor::line (  )  const [virtual]

Reimplemented from KTextEditor::Cursor.

Definition at line 129 of file katesmartcursor.cpp.

void KateSmartCursor::migrate ( KateSmartGroup *  newGroup  ) 

Definition at line 400 of file katesmartcursor.cpp.

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

Implements KTextEditor::SmartCursor.

Definition at line 216 of file katesmartcursor.cpp.

KateSmartCursor::operator QString (  ) 

Debug: output the position.

Definition at line 92 of file katesmartcursor.cpp.

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

Definition at line 68 of file katesmartcursor.h.

void KateSmartCursor::resetLastPosition (  ) 

Definition at line 418 of file katesmartcursor.cpp.

void KateSmartCursor::setInternal (  ) 

Definition at line 438 of file katesmartcursor.cpp.

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

Reimplemented from KTextEditor::Cursor.

Definition at line 134 of file katesmartcursor.cpp.

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

Definition at line 319 of file katesmartcursor.cpp.

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

Definition at line 407 of file katesmartcursor.cpp.

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

Definition at line 139 of file katesmartcursor.cpp.

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

Implements KTextEditor::SmartCursor.

Definition at line 232 of file katesmartcursor.cpp.

void KateSmartCursor::shifted (  ) 

Definition at line 386 of file katesmartcursor.cpp.

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

Definition at line 87 of file katesmartcursor.h.

bool KateSmartCursor::translate ( const KateEditInfo &  edit  ) 

Definition at line 238 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 324 of file katesmartcursor.cpp.

void KateSmartCursor::unbindFromRange (  ) 

Definition at line 433 of file katesmartcursor.cpp.

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

Implements KTextEditor::SmartCursor.

Definition at line 428 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

kdelibs

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