Nepomuk2::FileIndexer Class Reference

#include <fileindexer.h>

Inheritance diagram for Nepomuk2::FileIndexer:

Public Slots
Q_SCRIPTABLE QString	currentFile () const
Q_SCRIPTABLE QString	currentFolder () const
Q_SCRIPTABLE int	currentStatus () const
Q_SCRIPTABLE int	indexedFiles () const
Q_SCRIPTABLE void	indexFile (const QString &path)
Q_SCRIPTABLE void	indexFolder (const QString &path, bool recursive, bool forced)
Q_SCRIPTABLE bool	isCleaning () const
Q_SCRIPTABLE bool	isIndexing () const
Q_SCRIPTABLE bool	isSuspended () const
Q_SCRIPTABLE void	resume () const
Q_SCRIPTABLE void	setSuspended (bool)
Q_SCRIPTABLE QString	statusMessage () const
Q_SCRIPTABLE void	suspend () const
Q_SCRIPTABLE int	totalFiles () const
Q_SCRIPTABLE void	updateAllFolders (bool forced)
Q_SCRIPTABLE void	updateFolder (const QString &path, bool recursive, bool forced)
Q_SCRIPTABLE QString	userStatusString () const

Signals
Q_SCRIPTABLE void	fileIndexingDone ()
Q_SCRIPTABLE void	indexingStarted ()
Q_SCRIPTABLE void	indexingStopped ()
Q_SCRIPTABLE void	status (int status, QString msg)
Q_SCRIPTABLE void	statusChanged ()
void	statusStringChanged ()

Public Member Functions
	FileIndexer ()
	~FileIndexer ()
Public Member Functions inherited from Nepomuk2::Service2
	Service2 (QObject *parent=0, bool delayedInitialization=false)
virtual	~Service2 ()
QString	dbusServiceName ()
QString	description ()
QString	name ()

Additional Inherited Members
Static Public Member Functions inherited from Nepomuk2::Service2
static QString	dbusServiceName (const QString &serviceName)
template<typename T >
static int	init (int argc, char **argv, const KAboutData &aboutData)
template<typename T >
static int	initUI (int argc, char **argv, const KAboutData &aboutData)
Protected Member Functions inherited from Nepomuk2::Service2
bool	initCommon (const QString &name)
void	setServiceInitialized (bool success)

Detailed Description

Service controlling the file indexer.

Definition at line 33 of file fileindexer.h.

Constructor & Destructor Documentation

Nepomuk2::FileIndexer::FileIndexer

(

)

Definition at line 36 of file fileindexer.cpp.

Nepomuk2::FileIndexer::~FileIndexer

(

)

Definition at line 74 of file fileindexer.cpp.

Member Function Documentation

QString Nepomuk2::FileIndexer::currentFile ( ) const

slot

Definition at line 145 of file fileindexer.cpp.

QString Nepomuk2::FileIndexer::currentFolder ( ) const

slot

Definition at line 151 of file fileindexer.cpp.

int Nepomuk2::FileIndexer::currentStatus ( ) const

slot

Returns the internal state of the indexer.

Since

4.11

Returns

an integer that represents the status as defined in Nepomuk2::IndexScheduler::Status

Definition at line 95 of file fileindexer.cpp.

Q_SCRIPTABLE void Nepomuk2::FileIndexer::fileIndexingDone ( )

signal

int Nepomuk2::FileIndexer::indexedFiles ( ) const

slot

Definition at line 174 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::indexFile ( const QString &  path )

slot

Index a specific file.

Definition at line 207 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::indexFolder ( const QString &  path, bool  recursive, bool  forced  )

slot

Index a folder independent of its configuration status.

Definition at line 213 of file fileindexer.cpp.

Q_SCRIPTABLE void Nepomuk2::FileIndexer::indexingStarted ( )

signal

Q_SCRIPTABLE void Nepomuk2::FileIndexer::indexingStopped ( )

signal

bool Nepomuk2::FileIndexer::isCleaning ( ) const

slot

Definition at line 127 of file fileindexer.cpp.

bool Nepomuk2::FileIndexer::isIndexing ( ) const

slot

Definition at line 122 of file fileindexer.cpp.

bool Nepomuk2::FileIndexer::isSuspended ( ) const

slot

Definition at line 116 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::resume ( ) const

slot

Definition at line 139 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::setSuspended ( bool  suspend )

slot

Definition at line 105 of file fileindexer.cpp.

Q_SCRIPTABLE void Nepomuk2::FileIndexer::status ( int  status, QString  msg  )

signal

Emitted each time the status/activity of the FileIndexer changes.

status what the watcher is doing tehse represent the IndexScheduler::Status enum

See also

Nepomuk2::IndexScheduler::Status

msg translated status message that indicates what is happening

Q_SCRIPTABLE void Nepomuk2::FileIndexer::statusChanged ( )

signal

QString Nepomuk2::FileIndexer::statusMessage ( ) const

slot

Translated status message of the current Indexer behaviour.

Since

4.11

Definition at line 90 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::statusStringChanged ( )

signal

void Nepomuk2::FileIndexer::suspend ( ) const

slot

Definition at line 133 of file fileindexer.cpp.

int Nepomuk2::FileIndexer::totalFiles ( ) const

slot

Definition at line 188 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::updateAllFolders ( bool  forced )

slot

Update all folders configured to be indexed.

Definition at line 201 of file fileindexer.cpp.

void Nepomuk2::FileIndexer::updateFolder ( const QString &  path, bool  recursive, bool  forced  )

slot

Update folder path if it is configured to be indexed.

Definition at line 157 of file fileindexer.cpp.

QString Nepomuk2::FileIndexer::userStatusString ( ) const

slot

Returns

A user readable status string. Includes the currently indexed folder.

Deprecated:

use statusMessage() instead

Definition at line 100 of file fileindexer.cpp.

---

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

• fileindexer.h
• fileindexer.cpp