TextAutoCorrectionCore::AutoCorrection Class

The AutoCorrection class. More...

Header: #include <TextAutoCorrectionCore/AutoCorrection>
CMake: find_package(KF6TextAutoCorrectionCore REQUIRED)
target_link_libraries(mytarget PRIVATE KF6::TextAutoCorrectionCore)

Public Functions

AutoCorrection()
~AutoCorrection()
TextAutoCorrectionCore::AutoCorrectionSettings *autoCorrectionSettings() const
bool autocorrect(bool htmlMode, QTextDocument &document, int &position)
void loadGlobalFileName(const QString &fname)
void readConfig()
void setAutoCorrectionSettings(TextAutoCorrectionCore::AutoCorrectionSettings *newAutoCorrectionSettings)
void writeAutoCorrectionXmlFile(const QString &filename)
void writeConfig()

Detailed Description

\n

Provides automatic text correction functionality including quote replacement, capitalization, and other typographic corrections.

Author: Laurent Montel <montel@kde.org>

Member Function Documentation

AutoCorrection::AutoCorrection()

Constructs an AutoCorrection instance

[noexcept] AutoCorrection::~AutoCorrection()

Destroys the AutoCorrection instance

TextAutoCorrectionCore::AutoCorrectionSettings *AutoCorrection::autoCorrectionSettings() const

Returns the autocorrection settings Returns A pointer to the AutoCorrectionSettings instance

See also setAutoCorrectionSettings().

bool AutoCorrection::autocorrect(bool htmlMode, QTextDocument &document, int &position)

Applies autocorrection to the document at the given position htmlMode true if the document contains HTML content document The text document to correct position The cursor position (will be updated) Returns true if corrections were applied

void AutoCorrection::loadGlobalFileName(const QString &fname)

Loads the global autocorrection file fname The path to the autocorrection file

void AutoCorrection::readConfig()

Reads the configuration from settings

void AutoCorrection::setAutoCorrectionSettings(TextAutoCorrectionCore::AutoCorrectionSettings *newAutoCorrectionSettings)

Sets the autocorrection settings newAutoCorrectionSettings The new AutoCorrectionSettings instance

See also autoCorrectionSettings().

void AutoCorrection::writeAutoCorrectionXmlFile(const QString &filename)

Writes the autocorrection data to an XML file filename The path to write the XML file to

void AutoCorrection::writeConfig()

Writes the configuration to settings