Nepomuk2::FileIndexingQueue Class Reference

#include <fileindexingqueue.h>

Inheritance diagram for Nepomuk2::FileIndexingQueue:

Public Slots
void	enqueue (const QUrl &url)
void	start ()
Public Slots inherited from Nepomuk2::IndexingQueue
void	resume ()
void	suspend ()

Signals
void	beginIndexingFile (const QUrl &url)
void	endIndexingFile (const QUrl &url)
Signals inherited from Nepomuk2::IndexingQueue
void	finishedIndexing ()
void	startedIndexing ()

Public Member Functions
	FileIndexingQueue (QObject *parent=0)
void	clear ()
void	clear (const QString &path)
QUrl	currentUrl ()
virtual void	fillQueue ()
virtual bool	isEmpty ()
Public Member Functions inherited from Nepomuk2::IndexingQueue
	IndexingQueue (QObject *parent=0)
void	setDelay (int msec)

Protected Member Functions
virtual void	processNextIteration ()

Additional Inherited Members
Protected Slots inherited from Nepomuk2::IndexingQueue
void	callForNextIteration ()
void	finishIteration ()

Detailed Description

Definition at line 31 of file fileindexingqueue.h.

Constructor & Destructor Documentation

Nepomuk2::FileIndexingQueue::FileIndexingQueue ( QObject *  parent = 0 )

explicit

Definition at line 35 of file fileindexingqueue.cpp.

Member Function Documentation

void Nepomuk2::FileIndexingQueue::beginIndexingFile ( const QUrl &  url )

signal

void Nepomuk2::FileIndexingQueue::clear

(

)

Definition at line 122 of file fileindexingqueue.cpp.

void Nepomuk2::FileIndexingQueue::clear

(

const QString &

path

)

Definition at line 128 of file fileindexingqueue.cpp.

QUrl Nepomuk2::FileIndexingQueue::currentUrl

(

)

Definition at line 138 of file fileindexingqueue.cpp.

void Nepomuk2::FileIndexingQueue::endIndexingFile ( const QUrl &  url )

signal

void Nepomuk2::FileIndexingQueue::enqueue ( const QUrl &  url )

slot

Definition at line 66 of file fileindexingqueue.cpp.

void Nepomuk2::FileIndexingQueue::fillQueue ( )

virtual

fill the queue if there is available data, return true if something is enqueued.

Should be used in combinition with isEmpty()

Default implementation will do nothing.

Reimplemented from Nepomuk2::IndexingQueue.

Definition at line 51 of file fileindexingqueue.cpp.

bool Nepomuk2::FileIndexingQueue::isEmpty ( )

virtual

Implements Nepomuk2::IndexingQueue.

Definition at line 75 of file fileindexingqueue.cpp.

void Nepomuk2::FileIndexingQueue::processNextIteration ( )

protectedvirtual

Process the next iteration in your queue.

Once you are done processing the file call finishIndexingFile so that the queue can continue processing and call this function when it is ready for the next iteration.

See also

finishIndexingFile

Implements Nepomuk2::IndexingQueue.

Definition at line 80 of file fileindexingqueue.cpp.

void Nepomuk2::FileIndexingQueue::start ( )

slot

Fills up the queue and starts the indexing.

Definition at line 43 of file fileindexingqueue.cpp.

---

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

• fileindexingqueue.h
• fileindexingqueue.cpp