Nepomuk2::IndexScheduler Class Reference

#include <indexscheduler.h>

Inheritance diagram for Nepomuk2::IndexScheduler:

Public Types
enum	State {   State_Normal = 0, State_UserIdle = 1, State_OnBattery = 2, State_LowDiskSpace = 3,   State_Suspended = 4, State_Cleaning = 5 }

Public Slots
void	analyzeFile (const QString &path)
void	resume ()
void	setSuspended (bool)
void	suspend ()
void	updateAll (bool forceUpdate=false)
void	updateDir (const QString &path, UpdateDirFlags flags=NoUpdateFlags)

Signals
void	basicIndexingDone ()
void	fileIndexingDone ()
void	indexingStarted ()
void	indexingStateChanged (bool indexing)
void	indexingStopped ()
void	indexingSuspended (bool suspended)
void	statusStringChanged ()

Public Member Functions
	IndexScheduler (QObject *parent=0)
	~IndexScheduler ()
UpdateDirFlags	currentFlags () const
State	currentStatus () const
QUrl	currentUrl () const
bool	isCleaning () const
bool	isIndexing () const
bool	isSuspended () const
QString	userStatusString () const

Detailed Description

The IndexScheduler is responsible for controlling the indexing queues and reacting to events.

It contains an EventMonitor and listens for events such as power management, battery and disk space.

Definition at line 39 of file indexscheduler.h.

Member Enumeration Documentation

enum Nepomuk2::IndexScheduler::State

Represents the current state of the indexer.

The enumes are assigned with fixed numbers because they will be transferred via dBus

See also

Nepomuk2::FileIndexer::status()

Enumerator
State_Normal
State_UserIdle
State_OnBattery
State_LowDiskSpace
State_Suspended
State_Cleaning

Definition at line 52 of file indexscheduler.h.

Constructor & Destructor Documentation

Nepomuk2::IndexScheduler::IndexScheduler

(

QObject *

parent = 0

)

Definition at line 45 of file indexscheduler.cpp.

Nepomuk2::IndexScheduler::~IndexScheduler

(

)

Definition at line 116 of file indexscheduler.cpp.

Member Function Documentation

void Nepomuk2::IndexScheduler::analyzeFile ( const QString &  path )

slot

Analyze the one file without conditions.

Definition at line 297 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::basicIndexingDone ( )

signal

Nepomuk2::UpdateDirFlags Nepomuk2::IndexScheduler::currentFlags

(

)

const

The UpdateDirFlags of the the current url that is being indexed.

Definition at line 176 of file indexscheduler.cpp.

Nepomuk2::IndexScheduler::State Nepomuk2::IndexScheduler::currentStatus

(

)

const

Returns the internal stateof the indexer as enum.

This status is used to expose the current state of the indexer via dbus.

Returns

Enum state of the indexer

Definition at line 448 of file indexscheduler.cpp.

QUrl Nepomuk2::IndexScheduler::currentUrl

(

)

const

The current uri being indexed.

It is empty if no file is being indexed. The url being empty does not indicate that the indexer isn't running, just that it hasn't found a file to index.

See also

indexingStarted

indexingStopped

Definition at line 168 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::fileIndexingDone ( )

signal

void Nepomuk2::IndexScheduler::indexingStarted ( )

signal

void Nepomuk2::IndexScheduler::indexingStateChanged ( bool  indexing )

signal

void Nepomuk2::IndexScheduler::indexingStopped ( )

signal

void Nepomuk2::IndexScheduler::indexingSuspended ( bool  suspended )

signal

bool Nepomuk2::IndexScheduler::isCleaning

(

)

const

Definition at line 158 of file indexscheduler.cpp.

bool Nepomuk2::IndexScheduler::isIndexing

(

)

const

Definition at line 163 of file indexscheduler.cpp.

bool Nepomuk2::IndexScheduler::isSuspended

(

)

const

Definition at line 153 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::resume ( )

slot

Definition at line 133 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::setSuspended ( bool  suspended )

slot

Definition at line 145 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::statusStringChanged ( )

signal

void Nepomuk2::IndexScheduler::suspend ( )

slot

Definition at line 121 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::updateAll ( bool  forceUpdate = false )

slot

Updates all configured folders.

Definition at line 218 of file indexscheduler.cpp.

void Nepomuk2::IndexScheduler::updateDir ( const QString &  path, UpdateDirFlags  flags = NoUpdateFlags  )

slot

Slot to connect to certain event systems like KDirNotify or KDirWatch.

Updates a complete folder. Makes sense for signals like KDirWatch::dirty.

Parameters

path	The folder to update
flags	Additional flags, all except AutoUpdateFolder are supported. This also means that by default path is updated non-recursively.

Definition at line 212 of file indexscheduler.cpp.

QString Nepomuk2::IndexScheduler::userStatusString

(

)

const

A user readable description of the scheduler's status.

Definition at line 424 of file indexscheduler.cpp.

---

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

• indexscheduler.h
• indexscheduler.cpp