KDEUI
KTextEditSpellInterface Class Reference
This interface is a workaround to keep binary compatibility in KDE4, because adding the virtual keyword to functions is not BC. More...
#include <ktextedit.h>
Public Member Functions | |
virtual bool | isSpellCheckingEnabled () const =0 |
virtual void | setSpellCheckingEnabled (bool enable)=0 |
virtual bool | shouldBlockBeSpellChecked (const QString &block) const =0 |
virtual | ~KTextEditSpellInterface () |
Detailed Description
This interface is a workaround to keep binary compatibility in KDE4, because adding the virtual keyword to functions is not BC.
Call KTextEdit::setSpellInterface() to set this interface to a KTextEdit, and some functions of KTextEdit will delegate their calls to this interface instead, which provides a way for derived classes to modifiy the behavior or those functions.
- Since:
- 4.2
TODO: Get rid of this class in KDE5 and add the methods to KTextEdit instead, by making them virtual there.
Definition at line 41 of file ktextedit.h.
Constructor & Destructor Documentation
virtual KTextEditSpellInterface::~KTextEditSpellInterface | ( | ) | [inline, virtual] |
Definition at line 64 of file ktextedit.h.
Member Function Documentation
virtual bool KTextEditSpellInterface::isSpellCheckingEnabled | ( | ) | const [pure virtual] |
- Returns:
- true if spellchecking for the text edit is enabled.
virtual void KTextEditSpellInterface::setSpellCheckingEnabled | ( | bool | enable | ) | [pure virtual] |
Sets whether to enable spellchecking for the KTextEdit.
- Parameters:
-
enable true if spellchecking should be enabled, false otherwise
virtual bool KTextEditSpellInterface::shouldBlockBeSpellChecked | ( | const QString & | block | ) | const [pure virtual] |
Returns true if the given paragraph or block should be spellcheck.
For example, a mail client does not want to check quoted text, and would return false here (by checking whether the block starts with a quote sign).
The documentation for this class was generated from the following file: