KDE 4.6 API Reference KTextEdit Class Reference
A KDE'ified QTextEdit. More...
#include <ktextedit.h>
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
Definition at line 86 of file ktextedit.h.
Constructor & Destructor Documentation
Constructs a KTextEdit object.
See QTextEdit::QTextEdit for details.
Definition at line 264 of file ktextedit.cpp.
| KTextEdit::KTextEdit | ( | QWidget * | parent = 0 | ) | [explicit] |
Constructs a KTextEdit object.
See QTextEdit::QTextEdit for details.
Definition at line 270 of file ktextedit.cpp.
| KTextEdit::~KTextEdit | ( | ) |
Destroys the KTextEdit object.
Definition at line 276 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 783 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 746 of file ktextedit.cpp.
| QString KTextEdit::clickMessage | ( | ) | const |
- Returns:
- the message set with setClickMessage
- Since:
- 4.4
| void KTextEdit::contextMenuEvent | ( | QContextMenuEvent * | event | ) | [protected, virtual] |
Reimplemented from QTextEdit to add spelling related items when appropriate.
Definition at line 554 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().
Definition at line 677 of file ktextedit.cpp.
| void KTextEdit::deleteWordBack | ( | ) | [protected, virtual] |
Deletes a word backwards from the current cursor position, if available.
Definition at line 453 of file ktextedit.cpp.
| void KTextEdit::deleteWordForward | ( | ) | [protected, virtual] |
Deletes a word forwards from the current cursor position, if available.
Definition at line 458 of file ktextedit.cpp.
| void KTextEdit::enableFindReplace | ( | bool | enabled | ) |
| bool KTextEdit::event | ( | QEvent * | ev | ) | [protected, virtual] |
Reimplemented to catch "delete word" shortcut events.
Definition at line 320 of file ktextedit.cpp.
| void KTextEdit::focusInEvent | ( | QFocusEvent * | event | ) | [protected, virtual] |
Reimplemented to instantiate a KDictSpellingHighlighter, if spellchecking is enabled.
Definition at line 727 of file ktextedit.cpp.
| void KTextEdit::focusOutEvent | ( | QFocusEvent * | ev | ) | [protected, virtual] |
Definition at line 1122 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 682 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 816 of file ktextedit.cpp.
| void KTextEdit::keyPressEvent | ( | QKeyEvent * | event | ) | [protected, virtual] |
Reimplemented for internal reasons.
Reimplemented in KRichTextEdit.
Definition at line 1069 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 | ( | ) |
| void KTextEdit::paintEvent | ( | QPaintEvent * | ev | ) | [protected, virtual] |
Reimplemented to paint clickMessage.
Definition at line 1100 of file ktextedit.cpp.
| void KTextEdit::replace | ( | ) | [slot] |
| 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 693 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 701 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 1082 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 687 of file ktextedit.cpp.
| void KTextEdit::setReadOnly | ( | bool | readOnly | ) | [virtual] |
Reimplemented to set a proper "deactivated" background color.
Definition at line 751 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 281 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 291 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 1011 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 306 of file ktextedit.cpp.
| void KTextEdit::slotDoFind | ( | ) | [protected, slot] |
Definition at line 916 of file ktextedit.cpp.
| void KTextEdit::slotDoReplace | ( | ) | [protected, slot] |
- Since:
- 4.1
Definition at line 840 of file ktextedit.cpp.
| void KTextEdit::slotFind | ( | ) | [protected, slot] |
Definition at line 976 of file ktextedit.cpp.
| void KTextEdit::slotFindNext | ( | ) | [protected, slot] |
Definition at line 947 of file ktextedit.cpp.
| void KTextEdit::slotReplace | ( | ) | [protected, slot] |
Definition at line 991 of file ktextedit.cpp.
| void KTextEdit::slotReplaceNext | ( | ) | [protected, slot] |
Definition at line 874 of file ktextedit.cpp.
| void KTextEdit::slotSpeakText | ( | ) | [protected, slot] |
- Since:
- 4.3
Definition at line 533 of file ktextedit.cpp.
| 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 | ) | [protected, virtual] |
Reimplemented to allow fast-wheelscrolling with Ctrl-Wheel or zoom.
Definition at line 669 of file ktextedit.cpp.
Property Documentation
bool KTextEdit::checkSpellingEnabled [read, write] |
Definition at line 90 of file ktextedit.h.
QString KTextEdit::clickMessage [read, write] |
Definition at line 89 of file ktextedit.h.
const QString & KTextEdit::spellCheckingLanguage [read, write] |
Definition at line 91 of file ktextedit.h.
The documentation for this class was generated from the following files:
