#include <qquickpdfsearchmodel_p.h>

Inheritance diagram for QQuickPdfSearchModel:

Collaboration diagram for QQuickPdfSearchModel:

Signals
void	currentPageChanged ()

void	currentResultChanged ()

void	currentResultLinkChanged ()

void	currentPageBoundingPolygonsChanged ()

void	currentResultBoundingPolygonsChanged ()

void	currentResultBoundingRectChanged ()

Signals inherited from QPdfSearchModel
void	documentChanged ()

void	searchStringChanged ()

Signals inherited from QAbstractItemModel
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
	This signal is emitted whenever the data in an existing item changes.

void	headerDataChanged (Qt::Orientation orientation, int first, int last)
	This signal is emitted whenever a header is changed.

void	layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are inserted into the model.

void	rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been inserted into the model.

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are removed from the model.

void	rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been removed from the model.

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are inserted into the model.

void	columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been inserted into the model.

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are removed from the model.

void	columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been removed from the model.

void	modelAboutToBeReset (QPrivateSignal)

void	modelReset (QPrivateSignal)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickPdfSearchModel (QObject *parent=nullptr)
	A representation of text search results within a PDF Document.

	~QQuickPdfSearchModel () override

QQuickPdfDocument *	document () const

void	setDocument (QQuickPdfDocument *document)

Q_INVOKABLE QList< QPolygonF >	boundingPolygonsOnPage (int page)
	\qmlmethod list<list<point>> PdfSearchModel::boundingPolygonsOnPage(int page)

int	currentPage () const

void	setCurrentPage (int currentPage)
	\qmlproperty int PdfSearchModel::currentPage

int	currentResult () const

void	setCurrentResult (int currentResult)
	\qmlproperty int PdfSearchModel::currentResult

QPdfLink	currentResultLink () const
	\qmlproperty QPdfLink PdfSearchModel::currentResultLink

QList< QPolygonF >	currentPageBoundingPolygons () const
	\qmlproperty list<list<point>> PdfSearchModel::currentPageBoundingPolygons

QList< QPolygonF >	currentResultBoundingPolygons () const
	\qmlproperty list<list<point>> PdfSearchModel::currentResultBoundingPolygons

QRectF	currentResultBoundingRect () const
	\qmlproperty point PdfSearchModel::currentResultBoundingRect

Public Member Functions inherited from QPdfSearchModel
	QPdfSearchModel ()

	QPdfSearchModel (QObject *parent)
	Constructs a new search model with parent object parent.

	~QPdfSearchModel () override
	Destroys the model.

QList< QPdfLink >	resultsOnPage (int page) const
	Returns the list of all results found on the given page.

QPdfLink	resultAtIndex (int index) const
	Returns a result found by index in the \l document, regardless of the page on which it was found.

QPdfDocument *	document () const

QString	searchString () const

QHash< int, QByteArray >	roleNames () const override
	\reimp

int	rowCount (const QModelIndex &parent) const override
	\reimp

QVariant	data (const QModelIndex &index, int role) const override
	\reimp

Public Member Functions inherited from QAbstractListModel
	QAbstractListModel (QObject *parent=nullptr)
	Constructs an abstract list model with the given parent.

	~QAbstractListModel ()
	Destroys the abstract list model.

QModelIndex	index (int row, int column=0, const QModelIndex &parent=QModelIndex()) const override
	Returns the index of the data in row and column with parent.

QModelIndex	sibling (int row, int column, const QModelIndex &idx) const override
	\reimp

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
	\reimp

Qt::ItemFlags	flags (const QModelIndex &index) const override
	\reimp

QObject *	parent () const
	Returns a pointer to the parent object.

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)
	Constructs an abstract item model with the given parent.

virtual	~QAbstractItemModel ()
	Destroys the abstract item model.

Q_INVOKABLE bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
	Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.

virtual Q_INVOKABLE QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const =0
	Returns the index of the item in the model specified by the given row, column and parent index.

virtual Q_INVOKABLE QModelIndex	parent (const QModelIndex &child) const =0

virtual Q_INVOKABLE QModelIndex	sibling (int row, int column, const QModelIndex &idx) const
	Returns the sibling at row and column for the item at index, or an invalid QModelIndex if there is no sibling at that location.

virtual Q_INVOKABLE int	rowCount (const QModelIndex &parent=QModelIndex()) const =0
	Returns the number of rows under the given parent.

virtual Q_INVOKABLE int	columnCount (const QModelIndex &parent=QModelIndex()) const =0
	Returns the number of columns for the children of the given parent.

virtual Q_INVOKABLE bool	hasChildren (const QModelIndex &parent=QModelIndex()) const
	Returns {true} if parent has any children; otherwise returns {false}.

virtual Q_INVOKABLE QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const =0
	Returns the data stored under the given role for the item referred to by the index.

virtual Q_INVOKABLE bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Sets the role data for the item at index to value.

virtual Q_INVOKABLE QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Returns the data for the given role and section in the header with the specified orientation.

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
	Sets the data for the given role and section in the header with the specified orientation to the value supplied.

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const
	Returns a map with values for all predefined roles in the model for the item at the given index.

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
	Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.

virtual bool	clearItemData (const QModelIndex &index)

virtual QStringList	mimeTypes () const
	Returns the list of allowed MIME types.

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
	Returns an object that contains serialized items of data corresponding to the list of indexes specified.

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
	Returns {true} if a model can accept a drop of the data.

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
	Handles the data supplied by a drag and drop operation that ended with the given action.

virtual Qt::DropActions	supportedDropActions () const

virtual Qt::DropActions	supportedDragActions () const
	Returns the actions supported by the data in this model.

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertRows(int row

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertColumns(int column

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeRows(int row

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeColumns(int column

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertRow(int row

Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertColumn(int column

Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeRow(int row

Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeColumn(int column

Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent

virtual Q_INVOKABLE void	fetchMore (const QModelIndex &parent)
	Fetches any available data for the items with the parent specified by the parent index.

virtual Q_INVOKABLE bool	canFetchMore (const QModelIndex &parent) const
	Returns {true} if there is more data available for parent; otherwise returns {false}.

virtual Q_INVOKABLE Qt::ItemFlags	flags (const QModelIndex &index) const
	Returns the item flags for the given index.

Q_INVOKABLE	Q_REVISION (6, 4) virtual void sort(int column

virtual QModelIndex	buddy (const QModelIndex &index) const
	Returns a model index for the buddy of the item represented by index.

virtual Q_INVOKABLE QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith\|Qt::MatchWrap)) const
	Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.

virtual QSize	span (const QModelIndex &index) const
	Returns the row and column span of the item represented by index.

virtual QHash< int, QByteArray >	roleNames () const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const

QObject *	parent () const
	Returns a pointer to the parent object.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Properties
QQuickPdfDocument *	document

int	currentPage

int	currentResult

QPdfLink	currentResultLink

QList< QPolygonF >	currentPageBoundingPolygons

QList< QPolygonF >	currentResultBoundingPolygons

QRectF	currentResultBoundingRect

Properties inherited from QPdfSearchModel
QPdfDocument *	document
	the document to search

QString	searchString
	the string to search for

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QPdfSearchModel
enum class	Role : int { Page = Qt::UserRole , IndexOnPage , Location , ContextBefore , ContextAfter , NRoles }
	\value Page The page number where the search result is found (int). More...

Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
	This enum describes the way the model changes layout. More...

enum class	CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }

Public Slots inherited from QPdfSearchModel
void	setSearchString (const QString &searchString)

void	setDocument (QPdfDocument *document)

Public Slots inherited from QAbstractItemModel
virtual bool	submit ()
	Lets the model know that it should submit cached information to permanent storage.

virtual void	revert ()
	Lets the model know that it should discard cached information.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int	count

Q_INVOKABLE int const QModelIndex &	parent = QModelIndex())
	Returns the parent of the model item with the given index.

Q_INVOKABLE int	sourceRow

Q_INVOKABLE int int	count

Q_INVOKABLE int int const QModelIndex &	destinationParent

Q_INVOKABLE int int const QModelIndex int	destinationChild

Q_INVOKABLE int	sourceColumn

Q_INVOKABLE const QModelIndex &	parent = QModelIndex())

Q_INVOKABLE int const QModelIndex &	destinationParent

Q_INVOKABLE int const QModelIndex int	destinationChild

Q_INVOKABLE Qt::SortOrder	order = Qt::AscendingOrder)

Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Member Functions inherited from QPdfSearchModel
void	updatePage (int page)

void	timerEvent (QTimerEvent *event) override
	This event handler can be reimplemented in a subclass to receive timer events for the object.

void	onDocumentPageCountChanged (int count)

Protected Member Functions inherited from QAbstractListModel
	QAbstractListModel (QAbstractItemModelPrivate &dd, QObject *parent)

Protected Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)

QModelIndex	createIndex (int row, int column, const void *data=nullptr) const
	Creates a model index for the given row and column with the internal pointer ptr.

QModelIndex	createIndex (int row, int column, quintptr id) const
	Creates a model index for the given row and column with the internal identifier, id.

void	encodeData (const QModelIndexList &indexes, QDataStream &stream) const

bool	decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)

void	beginInsertRows (const QModelIndex &parent, int first, int last)
	Begins a row insertion operation.

void	endInsertRows ()
	Ends a row insertion operation.

void	beginRemoveRows (const QModelIndex &parent, int first, int last)
	Begins a row removal operation.

void	endRemoveRows ()
	Ends a row removal operation.

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)

void	endMoveRows ()
	Ends a row move operation.

void	beginInsertColumns (const QModelIndex &parent, int first, int last)
	Begins a column insertion operation.

void	endInsertColumns ()
	Ends a column insertion operation.

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
	Begins a column removal operation.

void	endRemoveColumns ()
	Ends a column removal operation.

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
	Begins a column move operation.

void	endMoveColumns ()
	Ends a column move operation.

void	beginResetModel ()
	Begins a model reset operation.

void	endResetModel ()
	Completes a model reset operation.

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
	Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndexList	persistentIndexList () const

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 26 of file qquickpdfsearchmodel_p.h.

Constructor & Destructor Documentation

◆ QQuickPdfSearchModel()

QT_BEGIN_NAMESPACE QQuickPdfSearchModel::QQuickPdfSearchModel ( QObject * parent = nullptr )

explicit

A representation of text search results within a PDF Document.

\qmltype PdfSearchModel

! \instantiates QQuickPdfSearchModel \inqmlmodule QtQuick.Pdf

Since: 5.15

PdfSearchModel provides the ability to search for text strings within a document and get the geometric locations of matches on each page.

Definition at line 23 of file qquickpdfsearchmodel.cpp.

References connect(), and QPdfSearchModel::searchStringChanged().

Here is the call graph for this function:

◆ ~QQuickPdfSearchModel()

QQuickPdfSearchModel::~QQuickPdfSearchModel ( )

overridedefault

Member Function Documentation

◆ boundingPolygonsOnPage()

QList< QPolygonF > QQuickPdfSearchModel::boundingPolygonsOnPage ( int page )

\qmlmethod list<list<point>> PdfSearchModel::boundingPolygonsOnPage(int page)

Returns a set of paths in a form that can be bound to the paths property of a \l {QtQuick::PathMultiline}{PathMultiline} instance, which is used to render a batch of rectangles around all the matching locations on the page:

\qml PdfDocument { id: doc } PdfSearchModel { id: searchModel document: doc } Shape { ShapePath { PathMultiline { paths: searchModel.matchGeometry(view.currentPage) } } } \endqml

See also: PathMultiline

Definition at line 177 of file qquickpdfsearchmodel.cpp.

References document, page, rect, QPdfSearchModel::resultsOnPage(), ret, QPdfSearchModel::searchString, and QPdfSearchModel::updatePage().

Referenced by currentPageBoundingPolygons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ currentPage()

int QQuickPdfSearchModel::currentPage ( ) const

inline

Definition at line 48 of file qquickpdfsearchmodel_p.h.

◆ currentPageBoundingPolygons()

QList< QPolygonF > QQuickPdfSearchModel::currentPageBoundingPolygons ( ) const

\qmlproperty list<list<point>> PdfSearchModel::currentPageBoundingPolygons

A set of paths in a form that can be bound to the paths property of a \l {QtQuick::PathMultiline}{PathMultiline} instance to render a batch of rectangles around all the regions where search results are found on \l currentPage:

\qml PdfDocument { id: doc } PdfSearchModel { id: searchModel document: doc } Shape { ShapePath { PathMultiline { paths: searchModel.matchGeometry(view.currentPage) } } } \endqml

See also: PathMultiline

Definition at line 146 of file qquickpdfsearchmodel.cpp.

References boundingPolygonsOnPage().

Here is the call graph for this function:

◆ currentPageBoundingPolygonsChanged

void QQuickPdfSearchModel::currentPageBoundingPolygonsChanged ( )

signal

◆ currentPageChanged

void QQuickPdfSearchModel::currentPageChanged ( )

signal

Referenced by setCurrentPage().

Here is the caller graph for this function:

◆ currentResult()

int QQuickPdfSearchModel::currentResult ( ) const

inline

Definition at line 51 of file qquickpdfsearchmodel_p.h.

◆ currentResultBoundingPolygons()

QList< QPolygonF > QQuickPdfSearchModel::currentResultBoundingPolygons ( ) const

\qmlproperty list<list<point>> PdfSearchModel::currentResultBoundingPolygons

A set of paths in a form that can be bound to the paths property of a \l {QtQuick::PathMultiline}{PathMultiline} instance to render a batch of rectangles around the regions comprising the search result \l currentResult on \l currentPage. This is normally used to highlight one search result at a time, in a UI that allows stepping through the results:

\qml PdfDocument { id: doc } PdfSearchModel { id: searchModel document: doc currentPage: view.currentPage currentResult: ... } Shape { ShapePath { PathMultiline { paths: searchModel.currentResultBoundingPolygons } } } \endqml

It becomes empty whenever {currentPage != currentResultLink.page}.

See also: PathMultiline

Definition at line 81 of file qquickpdfsearchmodel.cpp.

References currentResultLink, rect, and ret.

◆ currentResultBoundingPolygonsChanged

void QQuickPdfSearchModel::currentResultBoundingPolygonsChanged ( )

signal

Referenced by setCurrentResult().

Here is the caller graph for this function:

◆ currentResultBoundingRect()

QRectF QQuickPdfSearchModel::currentResultBoundingRect ( ) const

\qmlproperty point PdfSearchModel::currentResultBoundingRect

The bounding box containing all \l currentResultBoundingPolygons, if {currentPage == currentResultLink.page}; otherwise, an invalid rectangle.

Definition at line 98 of file qquickpdfsearchmodel.cpp.

References currentResultLink, rect, and ret.

◆ currentResultBoundingRectChanged

void QQuickPdfSearchModel::currentResultBoundingRectChanged ( )

signal

Referenced by setCurrentResult().

Here is the caller graph for this function:

◆ currentResultChanged

void QQuickPdfSearchModel::currentResultChanged ( )

signal

Referenced by setCurrentResult().

Here is the caller graph for this function:

◆ currentResultLink()

QPdfLink QQuickPdfSearchModel::currentResultLink ( ) const

\qmlproperty QPdfLink PdfSearchModel::currentResultLink

The result at index \l currentResult.

Definition at line 262 of file qquickpdfsearchmodel.cpp.

References QPdfSearchModel::resultAtIndex().

Here is the call graph for this function:

◆ currentResultLinkChanged

void QQuickPdfSearchModel::currentResultLinkChanged ( )

signal

Referenced by setCurrentResult().

Here is the caller graph for this function:

◆ document()

QQuickPdfDocument * QQuickPdfSearchModel::document ( ) const

Definition at line 35 of file qquickpdfsearchmodel.cpp.

◆ setCurrentPage()

void QQuickPdfSearchModel::setCurrentPage ( int currentPage )

\qmlproperty int PdfSearchModel::currentPage

The page on which \l currentResultBoundingPolygons should provide filtered search results.

Definition at line 200 of file qquickpdfsearchmodel.cpp.

References currentPage, currentPageChanged(), document, emit, and QPdfDocument::pageCount.

Referenced by setCurrentResult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentResult()

void QQuickPdfSearchModel::setCurrentResult ( int currentResult )

\qmlproperty int PdfSearchModel::currentResult

The result index within the whole set of search results, for which \l currentResultBoundingPolygons should provide the regions to highlight if currentPage matches currentResultLink.page.

Definition at line 225 of file qquickpdfsearchmodel.cpp.

References currentResult, currentResultBoundingPolygonsChanged(), currentResultBoundingRectChanged(), currentResultChanged(), currentResultLinkChanged(), emit, QPdfLink::isValid(), QPdfLink::page, qCDebug, qWarning, QPdfSearchModel::resultAtIndex(), QPdfSearchModel::rowCount(), and setCurrentPage().

Here is the call graph for this function:

◆ setDocument()

void QQuickPdfSearchModel::setDocument ( QQuickPdfDocument * document )

Definition at line 40 of file qquickpdfsearchmodel.cpp.

References document, and QPdfSearchModel::setDocument().

Here is the call graph for this function:

Property Documentation

◆ currentPage

int QQuickPdfSearchModel::currentPage

readwrite

Definition at line 80 of file qquickpdfsearchmodel_p.h.

Referenced by setCurrentPage().

◆ currentPageBoundingPolygons

QList<QPolygonF> QQuickPdfSearchModel::currentPageBoundingPolygons

read

Definition at line 80 of file qquickpdfsearchmodel_p.h.

◆ currentResult

int QQuickPdfSearchModel::currentResult

readwrite

Definition at line 80 of file qquickpdfsearchmodel_p.h.

Referenced by setCurrentResult().

◆ currentResultBoundingPolygons

QList<QPolygonF> QQuickPdfSearchModel::currentResultBoundingPolygons

read

Definition at line 80 of file qquickpdfsearchmodel_p.h.

◆ currentResultBoundingRect

QRectF QQuickPdfSearchModel::currentResultBoundingRect

read

Definition at line 80 of file qquickpdfsearchmodel_p.h.

◆ currentResultLink

QPdfLink QQuickPdfSearchModel::currentResultLink

read

Definition at line 80 of file qquickpdfsearchmodel_p.h.

Referenced by currentResultBoundingPolygons(), and currentResultBoundingRect().

◆ document

QQuickPdfDocument * QQuickPdfSearchModel::document

readwrite

Definition at line 80 of file qquickpdfsearchmodel_p.h.

Referenced by boundingPolygonsOnPage(), setCurrentPage(), and setDocument().

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

qtwebengine/src/pdfquick/qquickpdfsearchmodel_p.h
qtwebengine/src/pdfquick/qquickpdfsearchmodel.cpp

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickPdfSearchModel()

◆ ~QQuickPdfSearchModel()

Member Function Documentation

◆ boundingPolygonsOnPage()

◆ currentPage()

◆ currentPageBoundingPolygons()

◆ currentPageBoundingPolygonsChanged

◆ currentPageChanged

◆ currentResult()

◆ currentResultBoundingPolygons()

◆ currentResultBoundingPolygonsChanged

◆ currentResultBoundingRect()

◆ currentResultBoundingRectChanged

◆ currentResultChanged

◆ currentResultLink()

◆ currentResultLinkChanged

◆ document()

◆ setCurrentPage()

◆ setCurrentResult()

◆ setDocument()

Property Documentation

◆ currentPage

◆ currentPageBoundingPolygons

◆ currentResult

◆ currentResultBoundingPolygons

◆ currentResultBoundingRect

◆ currentResultLink

◆ document