Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

FileWatcher Class Reference

#include <filewatcher.h>

List of all members.

Public Slots

void addFile (QString fileName)
void removeFile (QString fileName)
void addDir (QString fileName)
void removeDir (QString fileName)
void start ()
void stop ()
void forceScan ()

Signals

void fileChanged (QString)
void fileDeleted (QString)
void dirChanged (QString)
void dirDeleted (QString)
void statePending (QString)

Public Member Functions

 FileWatcher (QObject *parent)
 ~FileWatcher ()
bool isActive ()
void setTimeOut (const int newTimeOut, const bool restartTimer=false)
int timeOut () const
QList< QString > files ()

Private Slots

void checkFiles ()

Private Attributes

QMap< QString, fileModwatchedFiles
QTimer * watchTimer
bool blockAddRemove
bool stopped
bool dying
int m_timeOut

Classes

struct  fileMod


Detailed Description

Definition at line 19 of file filewatcher.h.


Constructor & Destructor Documentation

FileWatcher::FileWatcher ( QObject *  parent  ) 

Definition at line 23 of file filewatcher.cpp.

References blockAddRemove, checkFiles(), dying, m_timeOut, stopped, watchedFiles, and watchTimer.

FileWatcher::~FileWatcher (  ) 

Definition at line 36 of file filewatcher.cpp.

References blockAddRemove, checkFiles(), dying, watchedFiles, and watchTimer.


Member Function Documentation

bool FileWatcher::isActive (  ) 

Definition at line 111 of file filewatcher.cpp.

References blockAddRemove.

Referenced by ScribusCore::fileWatcherActive().

void FileWatcher::setTimeOut ( const int  newTimeOut,
const bool  restartTimer = false 
)

Definition at line 46 of file filewatcher.cpp.

References m_timeOut, and start().

Referenced by PageItem_LatexFrame::PageItem_LatexFrame().

int FileWatcher::timeOut (  )  const

Definition at line 53 of file filewatcher.cpp.

References m_timeOut.

QList< QString > FileWatcher::files (  ) 

void FileWatcher::addFile ( QString  fileName  )  [slot]

void FileWatcher::removeFile ( QString  fileName  )  [slot]

void FileWatcher::addDir ( QString  fileName  )  [slot]

Definition at line 83 of file filewatcher.cpp.

References addFile().

void FileWatcher::removeDir ( QString  fileName  )  [slot]

Definition at line 88 of file filewatcher.cpp.

References removeFile().

void FileWatcher::start (  )  [slot]

void FileWatcher::stop (  )  [slot]

void FileWatcher::forceScan (  )  [slot]

void FileWatcher::checkFiles (  )  [private, slot]

void FileWatcher::fileChanged ( QString   )  [signal]

Referenced by checkFiles().

void FileWatcher::fileDeleted ( QString   )  [signal]

Referenced by checkFiles().

void FileWatcher::dirChanged ( QString   )  [signal]

Referenced by checkFiles().

void FileWatcher::dirDeleted ( QString   )  [signal]

Referenced by checkFiles().

void FileWatcher::statePending ( QString   )  [signal]

Referenced by checkFiles().


Member Data Documentation

QMap<QString, fileMod> FileWatcher::watchedFiles [private]

Definition at line 57 of file filewatcher.h.

Referenced by addFile(), checkFiles(), files(), FileWatcher(), removeFile(), and ~FileWatcher().

QTimer* FileWatcher::watchTimer [private]

Definition at line 58 of file filewatcher.h.

Referenced by addFile(), checkFiles(), FileWatcher(), removeFile(), start(), stop(), and ~FileWatcher().

Definition at line 59 of file filewatcher.h.

Referenced by checkFiles(), FileWatcher(), isActive(), and ~FileWatcher().

bool FileWatcher::stopped [private]

Definition at line 60 of file filewatcher.h.

Referenced by addFile(), checkFiles(), FileWatcher(), removeFile(), start(), and stop().

bool FileWatcher::dying [private]

Definition at line 61 of file filewatcher.h.

Referenced by checkFiles(), FileWatcher(), and ~FileWatcher().

int FileWatcher::m_timeOut [private]

Definition at line 62 of file filewatcher.h.

Referenced by addFile(), checkFiles(), FileWatcher(), removeFile(), setTimeOut(), start(), and timeOut().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.