Checker class for QTextEdit widgets. More...

#include <QtSpell.hpp>

Public Slots
void	undo ()
	Undo the last edit operation.

void	redo ()
	Redo the last edit operation.

void	clearUndoRedo ()
	Clears the undo/redo stack.

Public Slots inherited from QtSpell::Checker
void	setSpellingEnabled (bool enabled)
	Set whether spell checking should be performed.

Signals
void	undoAvailable (bool available)
	Emitted when the undo stack changes.

void	redoAvailable (bool available)
	Emitted when the redo stak changes.

Signals inherited from QtSpell::Checker
void	languageChanged (const QString &newLang)
	This signal is emitted when the user selects a new language from the spellchecker UI.

Public Member Functions
	TextEditChecker (QObject *parent=0)
	TextEditChecker object constructor.

	~TextEditChecker ()
	TextEditChecker object destructor.

void	setTextEdit (QTextEdit *textEdit)
	Set the QTextEdit to check.

void	setTextEdit (QPlainTextEdit *textEdit)
	Set the QPlainTextEdit to check.

void	setNoSpellingPropertyId (int propertyId)
	Set the QTextCharFormat property identifier which marks whether a word ought to be spell-checked.

int	noSpellingPropertyId () const
	Returns the current QTextCharFormat property identifier which marks whether a word ought to be spell-checked.

void	checkSpelling (int start=0, int end=-1)
	Check the spelling.

void	setUndoRedoEnabled (bool enabled)
	Sets whether undo/redo functionality is enabled.

Public Member Functions inherited from QtSpell::Checker
	Checker (QObject *parent=0)
	QtSpell::Checker object constructor.

virtual	~Checker ()
	QtSpell::Checker object destructor.

bool	setLanguage (const QString &lang)
	Set the spell checking language.

QString	getLanguage () const
	Retreive the current spelling language.

void	setDecodeLanguageCodes (bool decode)
	Set whether to decode language codes in the UI.

bool	getDecodeLanguageCodes () const
	Return whether langauge codes are decoded in the UI.

void	setShowCheckSpellingCheckbox (bool show)
	Set whether to display an "Check spelling" checkbox in the UI.

bool	getShowCheckSpellingCheckbox () const
	Return whether a "Check spelling" checkbox is displayed in the UI.

bool	getSpellingEnabled () const
	Return whether spellchecking is performed.

void	addWordToDictionary (const QString &word)
	Add the specified word to the user dictionary.

bool	checkWord (const QString &word) const
	Check the specified word.

void	ignoreWord (const QString &word) const
	Ignore a word for the current session.

QList< QString >	getSpellingSuggestions (const QString &word) const
	Retreive a list of spelling suggestions for the misspelled word.

Private Member Functions
QString	getWord (int pos, int start=0, int end=0) const
	Get the word at the specified cursor position.

void	insertWord (int start, int end, const QString &word)
	Replaces the specified range with the specified word.

bool	isAttached () const
	Returns whether a widget is attached to the checker.

Additional Inherited Members
Static Public Member Functions inherited from QtSpell::Checker
static QList< QString >	getLanguageList ()
	Requests the list of languages available for spell checking.

static QString	decodeLanguageCode (const QString &lang)
	Translates a language code to a human readable format (i.e. "en_US" -> "English (United States)").

Detailed Description

Checker class for QTextEdit widgets.

Sample usage:

/* QtSpell - Spell checking for Qt text widgets.
 * Copyright (c) 2014-2022 Sandro Mani
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License along
 *    with this program; if not, write to the Free Software Foundation, Inc.,
 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef EXAMPLE_HPP
#define EXAMPLE_HPP
 
#include <QCheckBox>
#include <QLabel>
#include <QMainWindow>
#include <QTextEdit>
#include <QVBoxLayout>
#include <QtSpell.hpp>
#include <QDialogButtonBox>
#include <QPushButton>
 
class MainWindow : public QMainWindow
{
        Q_OBJECT
public:
        MainWindow()
                : QMainWindow()
        {
                setWindowTitle("QtSpell Example");
 
                QLabel* label = new QLabel("Type some text into the text box.\n"
                                                                   "Try misspelling some words. Then right click them.");
                m_textEdit = new QTextEdit(this);
 
                QDialogButtonBox* bbox = new QDialogButtonBox(this);
 
                QPushButton* buttonUndo = bbox->addButton("Undo", QDialogButtonBox::ActionRole);
                buttonUndo->setEnabled(false);
 
                QPushButton* buttonRedo = bbox->addButton("Redo", QDialogButtonBox::ActionRole);
                buttonRedo->setEnabled(false);
 
                QPushButton* buttonClear = bbox->addButton("Clear", QDialogButtonBox::ActionRole);
 
                QPushButton* buttonDetach = bbox->addButton("Detach", QDialogButtonBox::ActionRole);
                QPushButton* buttonAttach = bbox->addButton("Attach", QDialogButtonBox::ActionRole);
 
                QWidget* widget = new QWidget(this);
                setCentralWidget(widget);
 
                QVBoxLayout* layout = new QVBoxLayout(widget);
                layout->addWidget(label);
                layout->addWidget(m_textEdit, 1);
                layout->addWidget(bbox);
 
 
                m_checker = new QtSpell::TextEditChecker(this);
                m_checker->setTextEdit(m_textEdit);
                m_checker->setDecodeLanguageCodes(true);
                m_checker->setShowCheckSpellingCheckbox(true);
                m_checker->setUndoRedoEnabled(true);
 
                connect(m_checker, &QtSpell::TextEditChecker::undoAvailable, buttonUndo, &QPushButton::setEnabled);
                connect(m_checker, &QtSpell::TextEditChecker::redoAvailable, buttonRedo, &QPushButton::setEnabled);
                connect(buttonUndo, &QPushButton::clicked, m_checker, &QtSpell::TextEditChecker::undo);
                connect(buttonRedo, &QPushButton::clicked, m_checker, &QtSpell::TextEditChecker::redo);
                connect(buttonClear, &QPushButton::clicked, m_textEdit, &QTextEdit::clear);
                connect(buttonClear, &QPushButton::clicked, m_checker, &QtSpell::TextEditChecker::clearUndoRedo);
                connect(buttonDetach, &QPushButton::clicked, this, &MainWindow::detach);
                connect(buttonAttach, &QPushButton::clicked, this, &MainWindow::attach);
        }
 
private slots:
        void attach() {
                m_checker->setTextEdit(m_textEdit);
        }
        void detach() {
                m_checker->setTextEdit(static_cast<QTextEdit*>(nullptr));
        }
 
private:
        QtSpell::TextEditChecker* m_checker = nullptr;
        QTextEdit* m_textEdit = nullptr;
};
 
#endif // EXAMPLE_HPP

Definition at line 220 of file QtSpell.hpp.

Member Function Documentation

◆ checkSpelling()

void QtSpell::TextEditChecker::checkSpelling	(	int	start = `0`,
		int	end = `-1`
	)

virtual

Check the spelling.

Parameters

start	The start position within the buffer.
end	The end position within the buffer (-1 for the buffer end).

Implements QtSpell::Checker.

Definition at line 201 of file TextEditChecker.cpp.

References QtSpell::Checker::checkWord(), QtSpell::TextCursor::isWordChar(), QtSpell::TextCursor::moveWordEnd(), and QtSpell::TextCursor::nextChar().

◆ clearUndoRedo

void QtSpell::TextEditChecker::clearUndoRedo ( )

slot

Clears the undo/redo stack.

Note: QtSpell::TextEditChecker reimplements the undo/redo functionality since the one provided by QTextDocument also tracks text format changes (i.e. underlining of spelling errors) which is undesirable.

Definition at line 275 of file TextEditChecker.cpp.

◆ getWord()

QString QtSpell::TextEditChecker::getWord	(	int	pos,
		int *	start = `0`,
		int *	end = `0`
	)		const

privatevirtual

Get the word at the specified cursor position.

Parameters

pos	The cursor position.
start	If not 0, will contain the start position of the word.
end	If not 0, will contain the end position of the word.

Returns: The word.

Implements QtSpell::Checker.

Definition at line 301 of file TextEditChecker.cpp.

References QtSpell::TextCursor::moveWordEnd(), and QtSpell::TextCursor::moveWordStart().

◆ insertWord()

void QtSpell::TextEditChecker::insertWord	(	int	start,
		int	end,
		const QString &	word
	)

privatevirtual

Replaces the specified range with the specified word.

Parameters

start	The start position.
end	The end position.
word	The word to insert.

Implements QtSpell::Checker.

Definition at line 315 of file TextEditChecker.cpp.

◆ isAttached()

bool QtSpell::TextEditChecker::isAttached ( ) const

privatevirtual

Returns whether a widget is attached to the checker.

Returns: Whether a widget is attached to the checker.

Implements QtSpell::Checker.

Definition at line 415 of file TextEditChecker.cpp.

◆ noSpellingPropertyId()

int QtSpell::TextEditChecker::noSpellingPropertyId ( ) const

Returns the current QTextCharFormat property identifier which marks whether a word ought to be spell-checked.

Returns: The no-spelling QTextCharFormat property identifier.

Definition at line 180 of file TextEditChecker.cpp.

◆ redo

void QtSpell::TextEditChecker::redo ( )

slot

Redo the last edit operation.

Note: QtSpell::TextEditChecker reimplements the undo/redo functionality since the one provided by QTextDocument also tracks text format changes (i.e. underlining of spelling errors) which is undesirable.

Definition at line 404 of file TextEditChecker.cpp.

◆ redoAvailable

void QtSpell::TextEditChecker::redoAvailable ( bool available )

signal

Emitted when the redo stak changes.

Parameters

available Whether redo steps are available.

Note: QtSpell::TextEditChecker reimplements the undo/redo functionality since the one provided by QTextDocument also tracks text format changes (i.e. underlining of spelling errors) which is undesirable.

Referenced by setUndoRedoEnabled().

◆ setNoSpellingPropertyId()

void QtSpell::TextEditChecker::setNoSpellingPropertyId ( int propertyId )

Set the QTextCharFormat property identifier which marks whether a word ought to be spell-checked.

Parameters

propertyId By default this is -1, meaning that no such property is set. To enable, pass a value above QTextFormat::UserProperty.

Note: If the value returned by QTextFormat::intProperty is 1, spelling is skipped. To work correctly, this property needs to be set for the entire word.

Definition at line 174 of file TextEditChecker.cpp.

◆ setTextEdit() [1/2]

void QtSpell::TextEditChecker::setTextEdit ( QPlainTextEdit * textEdit )

Set the QPlainTextEdit to check.

Parameters

textEdit The QPlainTextEdit to check, or 0 to detach.

Definition at line 120 of file TextEditChecker.cpp.

◆ setTextEdit() [2/2]

void QtSpell::TextEditChecker::setTextEdit ( QTextEdit * textEdit )

Set the QTextEdit to check.

Parameters

textEdit The QTextEdit to check, or 0 to detach.

Definition at line 114 of file TextEditChecker.cpp.

◆ setUndoRedoEnabled()

void QtSpell::TextEditChecker::setUndoRedoEnabled ( bool enabled )

Sets whether undo/redo functionality is enabled.

Parameters

enabled Whether undo/redo is enabled.

Note: QtSpell::TextEditChecker reimplements the undo/redo functionality since the one provided by QTextDocument also tracks text format changes (i.e. underlining of spelling errors) which is undesirable.

Definition at line 283 of file TextEditChecker.cpp.

References redoAvailable(), and undoAvailable().

◆ undo

void QtSpell::TextEditChecker::undo ( )

slot

Undo the last edit operation.

Note: QtSpell::TextEditChecker reimplements the undo/redo functionality since the one provided by QTextDocument also tracks text format changes (i.e. underlining of spelling errors) which is undesirable.

Definition at line 393 of file TextEditChecker.cpp.

◆ undoAvailable

void QtSpell::TextEditChecker::undoAvailable ( bool available )

signal

Emitted when the undo stack changes.

Parameters

available Whether undo steps are available.

Note: QtSpell::TextEditChecker reimplements the undo/redo functionality since the one provided by QTextDocument also tracks text format changes (i.e. underlining of spelling errors) which is undesirable.

Referenced by setUndoRedoEnabled().

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

Public Slots

Signals

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkSpelling()

◆ clearUndoRedo

◆ getWord()

◆ insertWord()

◆ isAttached()

◆ noSpellingPropertyId()

◆ redo

◆ redoAvailable

◆ setNoSpellingPropertyId()

◆ setTextEdit() [1/2]

◆ setTextEdit() [2/2]

◆ setUndoRedoEnabled()

◆ undo

◆ undoAvailable