• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • applications API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

  • KTextEditor
  • SmartCursorNotifier
Signals | Public Member Functions | List of all members
KTextEditor::SmartCursorNotifier Class Reference
Smart Cursors and Ranges

#include <smartcursornotifier.h>

Inheritance diagram for KTextEditor::SmartCursorNotifier:
Inheritance graph
[legend]

Signals

void characterDeleted (KTextEditor::SmartCursor *cursor, bool deletedBefore)
 
void characterInserted (KTextEditor::SmartCursor *cursor, bool insertedBefore)
 
void deleted (KTextEditor::SmartCursor *cursor)
 
void positionChanged (KTextEditor::SmartCursor *cursor)
 
void positionDeleted (KTextEditor::SmartCursor *cursor)
 

Public Member Functions

 SmartCursorNotifier ()
 
void setWantsDirectChanges (bool wantsDirectChanges)
 
bool wantsDirectChanges () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A class which provides notifications of state changes to a SmartCursor via QObject signals.

This class provides notifications of changes to a SmartCursor such as the position in the document, and deletion or insertion of text immediately before or after the cursor.

If you prefer to receive notifications via virtual inheritance, see SmartCursorWatcher.

See also
SmartCursor, SmartCursorNotifier
Author
Hamish Rodda <rodda.nosp@m.@kde.nosp@m..org>

Definition at line 46 of file smartcursornotifier.h.

Constructor & Destructor Documentation

SmartCursorNotifier::SmartCursorNotifier ( )

Default constructor.

Definition at line 60 of file cursorfeedback.cpp.

Member Function Documentation

void KTextEditor::SmartCursorNotifier::characterDeleted ( KTextEditor::SmartCursor *  cursor,
bool  deletedBefore 
)
signal

One character immediately surrounding the cursor was deleted.

If both characters are simultaneously deleted, positionDeleted() is called instead.

Parameters
cursorpointer to the cursor which generated the notification.
deletedBeforetrue if the character immediately before was deleted, false if the character immediately after was deleted.
void KTextEditor::SmartCursorNotifier::characterInserted ( KTextEditor::SmartCursor *  cursor,
bool  insertedBefore 
)
signal

A character was inserted immediately before or after the cursor, as given by insertedBefore.

Parameters
cursorpointer to the cursor which generated the notification.
insertedBeforetrue if a character was inserted before cursor, false if a character was inserted after
void KTextEditor::SmartCursorNotifier::deleted ( KTextEditor::SmartCursor *  cursor)
signal

The SmartCursor instance specified by cursor is being deleted.

Parameters
cursorpointer to the cursor which is about to be deleted. It is still safe to access information at this point.
void KTextEditor::SmartCursorNotifier::positionChanged ( KTextEditor::SmartCursor *  cursor)
signal

The cursor's position was changed.

Parameters
cursorpointer to the cursor which generated the notification.
void KTextEditor::SmartCursorNotifier::positionDeleted ( KTextEditor::SmartCursor *  cursor)
signal

The cursor's surrounding characters were both deleted simultaneously.

The cursor is automatically placed at the start of the deleted region.

Parameters
cursorpointer to the cursor which generated the notification.
void SmartCursorNotifier::setWantsDirectChanges ( bool  wantsDirectChanges)

Set whether this notifier should notify of changes that happen directly to the cursor, e.g.

by calls to SmartCursor::setPosition(), rather than just when surrounding text changes.

Parameters
wantsDirectChangeswhether this notifier should provide notifications for direct changes.

Definition at line 70 of file cursorfeedback.cpp.

bool SmartCursorNotifier::wantsDirectChanges ( ) const

Returns whether this notifier will notify of changes that happen directly to the cursor, e.g.

by calls to SmartCursor::setPosition(), rather than just when surrounding text changes.

Definition at line 65 of file cursorfeedback.cpp.


The documentation for this class was generated from the following files:
  • smartcursornotifier.h
  • cursorfeedback.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:56:48 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

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

applications API Reference

Skip menu "applications API Reference"
  •   kate
  •       kate
  •   KTextEditor
  •   Kate
  • Konsole

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal