KTextEdit Class Reference

#include <ktextedit.h>

Inheritance diagram for KTextEdit:

Public Slots
void	checkSpelling ()
void	mousePopupMenuImplementation (const QPoint &pos)
void	replace ()
void	setSpellCheckingLanguage (const QString &language)
void	showSpellConfigDialog (const QString &configFileName, const QString &windowIcon=QString())

Signals
void	aboutToShowContextMenu (QMenu *menu)
void	checkSpellingChanged (bool)
void	languageChanged (const QString &language)
void	spellCheckerAutoCorrect (const QString &currentWord, const QString &autoCorrectWord)
void	spellCheckingCanceled ()
void	spellCheckingFinished ()
void	spellCheckStatus (const QString &)

Public Member Functions
	KTextEdit (const QString &text, QWidget *parent=0)
	KTextEdit (QWidget *parent=0)
	~KTextEdit ()
bool	checkSpellingEnabled () const
QString	clickMessage () const
virtual void	createHighlighter ()
void	enableFindReplace (bool enabled)
void	forceSpellChecking ()
Sonnet::Highlighter *	highlighter () const
void	highlightWord (int length, int pos)
QMenu *	mousePopupMenu ()
void	setCheckSpellingEnabled (bool check)
void	setClickMessage (const QString &msg)
void	setHighlighter (Sonnet::Highlighter *_highLighter)
virtual void	setReadOnly (bool readOnly)
void	setSpellCheckingConfigFileName (const QString &fileName)
void	setSpellInterface (KTextEditSpellInterface *spellInterface)
void	showAutoCorrectButton (bool show)
void	showTabAction (bool show)
const QString &	spellCheckingLanguage () const

Protected Slots
void	slotDoFind ()
void	slotDoReplace ()
void	slotFind ()
void	slotFindNext ()
void	slotReplace ()
void	slotReplaceNext ()
void	slotSpeakText ()

Protected Member Functions
bool	checkSpellingEnabledInternal () const
virtual void	contextMenuEvent (QContextMenuEvent *)
virtual void	deleteWordBack ()
virtual void	deleteWordForward ()
virtual bool	event (QEvent *)
virtual void	focusInEvent (QFocusEvent *)
virtual void	focusOutEvent (QFocusEvent *)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	paintEvent (QPaintEvent *)
void	setCheckSpellingEnabledInternal (bool check)
virtual void	wheelEvent (QWheelEvent *)

Properties
bool	checkSpellingEnabled
QString	clickMessage
QString	spellCheckingLanguage

Detailed Description

A KDE'ified QTextEdit.

This is just a little subclass of QTextEdit, implementing some standard KDE features, like cursor auto-hiding, configurable wheelscrolling (fast-scroll or zoom), spell checking and deleting of entire words with Ctrl-Backspace or Ctrl-Delete.

This text edit provides two ways of spell checking: background checking, which will mark incorrectly spelled words red, and a spell check dialog, which lets the user check and correct all incorrectly spelled words.

Basic rule: whenever you want to use QTextEdit, use KTextEdit!

KDE Text Edit Widget

See also

QTextEdit

Author

Carsten Pfeiffer pfeif.nosp@m.fer@.nosp@m.kde.o.nosp@m.rg

Definition at line 90 of file ktextedit.h.

Constructor & Destructor Documentation

KTextEdit::KTextEdit ( const QString &  text, QWidget *  parent = 0  )

explicit

Constructs a KTextEdit object.

See QTextEdit::QTextEdit for details.

Definition at line 317 of file ktextedit.cpp.

KTextEdit::KTextEdit ( QWidget *  parent = 0 )

explicit

Constructs a KTextEdit object.

See QTextEdit::QTextEdit for details.

Definition at line 323 of file ktextedit.cpp.

KTextEdit::~KTextEdit

(

)

Destroys the KTextEdit object.

Definition at line 329 of file ktextedit.cpp.

Member Function Documentation

void KTextEdit::aboutToShowContextMenu ( QMenu *  menu )

signal

Emitted before the context menu is displayed.

The signal allows you to add your own entries into the the context menu that is created on demand.

NOTE: Do not store the pointer to the QMenu provided through since it is created and deleted on demand.

Parameters

p	the context menu about to be displayed

Since

4.5

void KTextEdit::checkSpelling ( )

slot

Show a dialog to check the spelling.

The spellCheckStatus() signal will be emitted when the spell checking dialog is closed.

Definition at line 830 of file ktextedit.cpp.

void KTextEdit::checkSpellingChanged ( bool  )

signal

emit signal when we activate or not autospellchecking

Since

4.1

bool KTextEdit::checkSpellingEnabled

(

)

const

Returns true if background spell checking is enabled for this text edit.

Note that it even returns true if this is a read-only KTextEdit, where spell checking is actually disabled. By default spell checking is disabled.

If a spell interface is set by setSpellInterface(), the call will be delegated to there instead.

See also

setCheckSpellingEnabled()

bool KTextEdit::checkSpellingEnabledInternal ( ) const

protected

Checks whether spellchecking is enabled or disabled.

This is what checkSpellingEnabled calls if there is no spell interface.

Since

4.2

Definition at line 793 of file ktextedit.cpp.

QString KTextEdit::clickMessage

(

)

const

Returns

the message set with setClickMessage

Since

4.4

void KTextEdit::contextMenuEvent ( QContextMenuEvent *  event )

protectedvirtual

Reimplemented from QTextEdit to add spelling related items when appropriate.

Definition at line 608 of file ktextedit.cpp.

void KTextEdit::createHighlighter ( )

virtual

Allows to create a specific highlighter if reimplemented.

By default, it creates a normal highlighter, based on the config file given to setSpellCheckingConfigFileName().

This highlighter is set each time spell checking is toggled on by calling setCheckSpellingEnabled(), but can later be overridden by calling setHighlighter().

See also

setHighlighter()

highlighter()

setSpellCheckingConfigFileName()

Definition at line 727 of file ktextedit.cpp.

void KTextEdit::deleteWordBack ( )

protectedvirtual

Deletes a word backwards from the current cursor position, if available.

Definition at line 502 of file ktextedit.cpp.

void KTextEdit::deleteWordForward ( )

protectedvirtual

Deletes a word forwards from the current cursor position, if available.

Definition at line 507 of file ktextedit.cpp.

void KTextEdit::enableFindReplace

(

bool

enabled

)

Enable find replace action.

Since

4.1

Definition at line 1030 of file ktextedit.cpp.

bool KTextEdit::event ( QEvent *  ev )

protectedvirtual

Reimplemented to catch "delete word" shortcut events.

Definition at line 371 of file ktextedit.cpp.

void KTextEdit::focusInEvent ( QFocusEvent *  event )

protectedvirtual

Reimplemented to instantiate a KDictSpellingHighlighter, if spellchecking is enabled.

Definition at line 777 of file ktextedit.cpp.

void KTextEdit::focusOutEvent ( QFocusEvent *  ev )

protectedvirtual

Definition at line 1149 of file ktextedit.cpp.

void KTextEdit::forceSpellChecking

(

)

Since

4.10 create a modal spellcheck dialogbox and spellCheckingFinished signal we sent when we finish spell checking or spellCheckingCanceled signal when we cancel spell checking

Definition at line 835 of file ktextedit.cpp.

Sonnet::Highlighter * KTextEdit::highlighter

(

)

const

Returns the current highlighter, which is 0 if spell checking is disabled.

The default highlighter is the one created by createHighlighter(), but might be overridden by setHighlighter().

See also

setHighlighter()

createHighlighter()

Definition at line 732 of file ktextedit.cpp.

void KTextEdit::highlightWord	(	int	length,
		int	pos
	)

Selects the characters at the specified position.

Any previous selection will be lost. The cursor is moved to the first character of the new selection.

Parameters

length	The length of the selection, in number of characters
pos	The position of the first character of the selection

Definition at line 840 of file ktextedit.cpp.

void KTextEdit::keyPressEvent ( QKeyEvent *  event )

protectedvirtual

Reimplemented for internal reasons.

Reimplemented in KRichTextEdit.

Definition at line 1098 of file ktextedit.cpp.

void KTextEdit::languageChanged ( const QString &  language )

signal

Emitted when the user changes the language in the spellcheck dialog shown by checkSpelling() or when calling setSpellCheckingLanguage().

Parameters

language

the new language the user selected

Since

4.1

QMenu * KTextEdit::mousePopupMenu

(

)

Return standard KTextEdit popupMenu.

Since

4.1

Definition at line 512 of file ktextedit.cpp.

void KTextEdit::mousePopupMenuImplementation ( const QPoint &  pos )

slot

Since

4.10 Because of binary compatibility constraints, mousePopupMenu() is not virtual. Therefore it must dynamically detect and call this slot.

Definition at line 1159 of file ktextedit.cpp.

void KTextEdit::paintEvent ( QPaintEvent *  ev )

protectedvirtual

Reimplemented to paint clickMessage.

Definition at line 1129 of file ktextedit.cpp.

void KTextEdit::replace ( )

slot

Create replace dialogbox.

Since

4.1

Definition at line 849 of file ktextedit.cpp.

void KTextEdit::setCheckSpellingEnabled

(

bool

check

)

Turns background spell checking for this text edit on or off.

Note that spell checking is only available in read-writable KTextEdits.

Enabling spell checking will set back the current highlighter to the one returned by createHighlighter().

If a spell interface is set by setSpellInterface(), the call will be delegated to there instead.

See also

checkSpellingEnabled()

isReadOnly()

setReadOnly()

Definition at line 743 of file ktextedit.cpp.

void KTextEdit::setCheckSpellingEnabledInternal ( bool  check )

protected

Enable or disable the spellchecking.

This is what setCheckSpellingEnabled() calls if there is no spell interface.

Since

4.2

Definition at line 751 of file ktextedit.cpp.

void KTextEdit::setClickMessage

(

const QString &

msg

)

This makes the text edit display a grayed-out hinting text as long as the user didn't enter any text.

It is often used as indication about the purpose of the text edit.

Since

4.4

Definition at line 1111 of file ktextedit.cpp.

void KTextEdit::setHighlighter

(

Sonnet::Highlighter *

_highLighter

)

Sets a custom backgound spell highlighter for this text edit.

Normally, the highlighter returned by createHighlighter() will be used to detect and highlight incorrectly spelled words, but this function allows to set a custom highlighter.

This has to be called after enabling spell checking with setCheckSpellingEnabled(), otherwise it has no effect.

See also

highlighter()

createHighlighter()

Parameters

highLighter

the new highlighter which will be used now

Definition at line 737 of file ktextedit.cpp.

void KTextEdit::setReadOnly ( bool  readOnly )

virtual

Reimplemented to set a proper "deactivated" background color.

Definition at line 798 of file ktextedit.cpp.

void KTextEdit::setSpellCheckingConfigFileName

(

const QString &

fileName

)

Allows to override the config file where the settings for spell checking, like the current language or encoding, are stored.

By default, the global config file (kdeglobals) is used, to share spell check settings between all applications.

This has to be called before any spell checking is initiated.

Parameters

fileName

the URL of the config file which will be used to read spell settings

Bug:

this has no effect for the spell dialog, only for the background check

Definition at line 334 of file ktextedit.cpp.

void KTextEdit::setSpellCheckingLanguage ( const QString &  language )

slot

Set the spell check language which will be used for highlighting spelling mistakes and for the spellcheck dialog.

The languageChanged() signal will be emitted when the new language is different from the old one.

Since

4.1

Definition at line 344 of file ktextedit.cpp.

void KTextEdit::setSpellInterface

(

KTextEditSpellInterface *

spellInterface

)

Sets the spell interface, which is used to delegate certain function calls to the interface.

This is a workaround for binary compatibility and should be removed in KDE5.

Since

4.2

Definition at line 1040 of file ktextedit.cpp.

void KTextEdit::showAutoCorrectButton

(

bool

show

)

Since

4.10

Definition at line 1154 of file ktextedit.cpp.

void KTextEdit::showSpellConfigDialog ( const QString &  configFileName, const QString &  windowIcon = QString()  )

slot

Opens a Sonnet::ConfigDialog for this text edit.

The config settings the user makes are read from and stored to the given config file. The spellcheck language of the config dialog is set to the current spellcheck language of the textedit. If the user changes the language in that dialog, the languageChanged() signal is emitted.

Parameters

configFileName	The file which is used to store and load the config settings
windowIcon	the icon which is used for the titlebar of the spell dialog window. Can be empty, then no icon is set.

Since

4.2

Definition at line 357 of file ktextedit.cpp.

void KTextEdit::showTabAction

(

bool

show

)

Since

4.10

Definition at line 1035 of file ktextedit.cpp.

void KTextEdit::slotDoFind ( )

protectedslot

Definition at line 940 of file ktextedit.cpp.

void KTextEdit::slotDoReplace ( )

protectedslot

Since

4.1

Definition at line 864 of file ktextedit.cpp.

void KTextEdit::slotFind ( )

protectedslot

Definition at line 1000 of file ktextedit.cpp.

void KTextEdit::slotFindNext ( )

protectedslot

Definition at line 971 of file ktextedit.cpp.

void KTextEdit::slotReplace ( )

protectedslot

Definition at line 1015 of file ktextedit.cpp.

void KTextEdit::slotReplaceNext ( )

protectedslot

Definition at line 898 of file ktextedit.cpp.

void KTextEdit::slotSpeakText ( )

protectedslot

Since

4.3

Definition at line 587 of file ktextedit.cpp.

void KTextEdit::spellCheckerAutoCorrect ( const QString &  currentWord, const QString &  autoCorrectWord  )

signal

Since

4.10

void KTextEdit::spellCheckingCanceled ( )

signal

signal spellCheckingCanceled is sent when we cancel spell checking.

Since

4.10

void KTextEdit::spellCheckingFinished ( )

signal

signal spellCheckingFinished is sent when we finish spell check or we click on "Terminate" button in sonnet dialogbox

Since

4.10

const QString& KTextEdit::spellCheckingLanguage

(

)

const

Returns

the spell checking language which was set by setSpellCheckingLanguage(), the spellcheck dialog or the spellcheck config dialog, or an empty string if that has never been called.

Since

4.2

void KTextEdit::spellCheckStatus ( const QString &  )

signal

Signal sends when spell checking is finished/stopped/completed.

Since

4.1

void KTextEdit::wheelEvent ( QWheelEvent *  event )

protectedvirtual

Reimplemented to allow fast-wheelscrolling with Ctrl-Wheel or zoom.

Definition at line 719 of file ktextedit.cpp.

Property Documentation

bool KTextEdit::checkSpellingEnabled

readwrite

Definition at line 94 of file ktextedit.h.

QString KTextEdit::clickMessage

readwrite

Definition at line 93 of file ktextedit.h.

const QString & KTextEdit::spellCheckingLanguage

readwrite

Definition at line 95 of file ktextedit.h.

---

The documentation for this class was generated from the following files:

• ktextedit.h
• ktextedit.cpp