IFindSupport Class

(Core::IFindSupport)

The IFindSupport class provides functions for searching in a document or widget. More...

Header: #include <IFindSupport>
Inherited By:

Core::BaseTextFind

Public Types

enum Result { Found, NotFound, NotYetFound }

Public Functions

IFindSupport()
virtual ~IFindSupport() override
virtual void clearFindScope()
virtual void clearHighlights() = 0
virtual QString completedFindString() const = 0
virtual QString currentFindString() const = 0
virtual void defineFindScope()
virtual Core::IFindSupport::Result findIncremental(const QString &txt, Core::FindFlags findFlags) = 0
virtual Core::IFindSupport::Result findStep(const QString &txt, Core::FindFlags findFlags) = 0
virtual void highlightAll(const QString &txt, Core::FindFlags findFlags)
virtual void replace(const QString &before, const QString &after, Core::FindFlags findFlags)
virtual int replaceAll(const QString &before, const QString &after, Core::FindFlags findFlags)
virtual bool replaceStep(const QString &before, const QString &after, Core::FindFlags findFlags)
virtual void resetIncrementalSearch() = 0
virtual Core::FindFlags supportedFindFlags() const = 0
virtual bool supportsReplace() const = 0

Signals

void changed()

Static Public Members

void showWrapIndicator(QWidget *parent)

Detailed Description

The IFindSupport class provides functions for searching in a document or widget.

See also Core::BaseTextFind.

Member Type Documentation

enum IFindSupport::Result

This enum holds whether the search term was found within the search scope using the find flags.

ConstantValueDescription
Core::IFindSupport::Found0The search term was found.
Core::IFindSupport::NotFound1The search term was not found.
Core::IFindSupport::NotYetFound2The search term has not been found yet.

Member Function Documentation

IFindSupport::IFindSupport()

Default constructs an instance of IFindSupport.

[override virtual] IFindSupport::~IFindSupport()

Destroys the instance of IFindSupport. The destructor is virtual.

[signal] void IFindSupport::changed()

[virtual] void IFindSupport::clearFindScope()

[pure virtual] void IFindSupport::clearHighlights()

[pure virtual] QString IFindSupport::completedFindString() const

[pure virtual] QString IFindSupport::currentFindString() const

[virtual] void IFindSupport::defineFindScope()

[pure virtual] Core::IFindSupport::Result IFindSupport::findIncremental(const QString &txt, Core::FindFlags findFlags)

[pure virtual] Core::IFindSupport::Result IFindSupport::findStep(const QString &txt, Core::FindFlags findFlags)

[virtual] void IFindSupport::highlightAll(const QString &txt, Core::FindFlags findFlags)

[virtual] void IFindSupport::replace(const QString &before, const QString &after, Core::FindFlags findFlags)

Replaces before with after as specified by findFlags.

[virtual] int IFindSupport::replaceAll(const QString &before, const QString &after, Core::FindFlags findFlags)

Finds and replaces all instances of before with after as specified by findFlags.

[virtual] bool IFindSupport::replaceStep(const QString &before, const QString &after, Core::FindFlags findFlags)

Replaces before with after as specified by findFlags, and then performs findStep().

Returns whether the find step found another match.

[pure virtual] void IFindSupport::resetIncrementalSearch()

[static] void IFindSupport::showWrapIndicator(QWidget *parent)

Shows parent overlayed with the wrap indicator.

[pure virtual] Core::FindFlags IFindSupport::supportedFindFlags() const

[pure virtual] bool IFindSupport::supportsReplace() const