#include <searchinterface.h>

Public Member Functions
	SearchInterface ()

virtual	~SearchInterface ()

virtual QVector < KTextEditor::Range >	searchText (const KTextEditor::Range &range, const QString &pattern, const Search::SearchOptions options=Search::Default)=0

virtual Search::SearchOptions	supportedSearchOptions () const =0

Detailed Description

Search interface extension for the Document.

Introduction

The SearchInterface provides methods to search for a given text pattern in a Document. You can either search for a simple text or for a regular expression, see searchText.

Accessing the HighlightInterface

The SearchInterface is supposed to be an extension interface for a Document, i.e. the Document inherits the interface provided that the used KTextEditor library implements the interface. Use qobject_cast to access the interface:

// doc is of type KTextEditor::Document*
KTextEditor::SearchInterface *iface =
    qobject_cast<KTextEditor::SearchInterface*>( doc );
if( iface ) {
    // the implementation supports the interface
    // do stuff
}

See also: KTextEditor::Document

Author: Christoph Cullmann <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

Definition at line 104 of file searchinterface.h.

Constructor & Destructor Documentation

SearchInterface::SearchInterface ( )

Constructor.

Definition at line 246 of file ktexteditor.cpp.

SearchInterface::~SearchInterface ( )

virtual

Virtual destructor.

Definition at line 250 of file ktexteditor.cpp.

Member Function Documentation

virtual QVector<KTextEditor::Range> KTextEditor::SearchInterface::searchText	(	const KTextEditor::Range &	range,
		const QString &	pattern,
		const Search::SearchOptions	options = `Search::Default`
	)

pure virtual

Searches the given input range for a text pattern.

Searches for a text pattern within the given input range. The kind of search performed depends on the options used. Use this function for plaintext searches as well as regular expression searches. Query supportedSearchOptions to find out, which options the current implementation does support. If no match is found the first (and only) element in the vector return is the invalid range. When searching for regular expressions, the first element holds the range of the full match, the subsequent elements hold the ranges of the capturing parentheses.

Parameters