TextAutoGenerateText::TextAutoGenerateSearchMessageSettings Class

class TextAutoGenerateText::TextAutoGenerateSearchMessageSettings

The TextAutoGenerateSearchMessageSettings class Author: Laurent Montel <montel@kde.org>. More...

Header: #include <TextAutoGenerateText/TextAutoGenerateSearchMessageSettings>
Inherits: QObject

Public Functions

TextAutoGenerateSearchMessageSettings(TextAutoGenerateText::TextAutoGenerateMessagesModel *model, QObject *parent = nullptr)
virtual ~TextAutoGenerateSearchMessageSettings() override
void clear()
QByteArray currentMessageIdentifier() const
int currentSearchIndex() const
int foundSearchCount() const
void next()
void previous()
void setCurrentMessageIdentifier(const QByteArray &newCurrentMessageIdentifier)
void setCurrentSearchIndex(int newCurrentSearchIndex)
void setFoundSearchCount(int newFoundSearchCount)

Signals

void refreshMessage(const QByteArray &identifier, const QByteArray &previousIdentifier, int index)
void updateNextPreviousButtons(bool nextEnabled, bool previousEnabled)

Detailed Description

Member Function Documentation

[explicit] TextAutoGenerateSearchMessageSettings::TextAutoGenerateSearchMessageSettings(TextAutoGenerateText::TextAutoGenerateMessagesModel *model, QObject *parent = nullptr)

Constructs a new TextAutoGenerateSearchMessageSettings object. model The TextAutoGenerateMessagesModel instance parent The parent QObject

[override virtual noexcept] TextAutoGenerateSearchMessageSettings::~TextAutoGenerateSearchMessageSettings()

Destroys the TextAutoGenerateSearchMessageSettings object.

void TextAutoGenerateSearchMessageSettings::clear()

Clears the current search state.

QByteArray TextAutoGenerateSearchMessageSettings::currentMessageIdentifier() const

Returns the identifier of the currently selected search message. Returns The current message identifier

See also setCurrentMessageIdentifier().

int TextAutoGenerateSearchMessageSettings::currentSearchIndex() const

Returns the current search result index. Returns The index of the current search result

See also setCurrentSearchIndex().

int TextAutoGenerateSearchMessageSettings::foundSearchCount() const

Returns the total number of search results found. Returns The count of matching search results

See also setFoundSearchCount().

void TextAutoGenerateSearchMessageSettings::next()

Moves to the next search result.

void TextAutoGenerateSearchMessageSettings::previous()

Moves to the previous search result.

[signal] void TextAutoGenerateSearchMessageSettings::refreshMessage(const QByteArray &identifier, const QByteArray &previousIdentifier, int index)

Emitted when a search message should be refreshed. identifier The ID of the message to refresh previousIdentifier The ID of the previously selected message index The index of the search result

void TextAutoGenerateSearchMessageSettings::setCurrentMessageIdentifier(const QByteArray &newCurrentMessageIdentifier)

Sets the identifier of the currently selected search message. newCurrentMessageIdentifier The message identifier to set

See also currentMessageIdentifier().

void TextAutoGenerateSearchMessageSettings::setCurrentSearchIndex(int newCurrentSearchIndex)

Sets the current search result index. newCurrentSearchIndex The index to set

See also currentSearchIndex().

void TextAutoGenerateSearchMessageSettings::setFoundSearchCount(int newFoundSearchCount)

Sets the total number of search results found. newFoundSearchCount The count to set

See also foundSearchCount().

[signal] void TextAutoGenerateSearchMessageSettings::updateNextPreviousButtons(bool nextEnabled, bool previousEnabled)

Emitted to update the enabled state of navigation buttons. nextEnabled Whether the next button should be enabled previousEnabled Whether the previous button should be enabled