• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

Nepomuk-Core

Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
KInotify Class Reference

#include <kinotify.h>

Inheritance diagram for KInotify:
Inheritance graph
[legend]

Public Types

enum  WatchEvent {
  EventAccess = 0x00000001, EventAttributeChange = 0x00000004, EventCloseWrite = 0x00000008, EventCloseRead = 0x00000010,
  EventCreate = 0x00000100, EventDelete = 0x00000200, EventDeleteSelf = 0x00000400, EventModify = 0x00000002,
  EventMoveSelf = 0x00000800, EventMoveFrom = 0x00000040, EventMoveTo = 0x00000080, EventOpen = 0x00000020,
  EventUnmount = 0x00002000, EventQueueOverflow = 0x00004000, EventIgnored = 0x00008000, EventMove = ( EventMoveFrom|EventMoveTo),
  EventAll
}
 
enum  WatchFlag { FlagOnlyDir = 0x01000000, FlagDoNotFollow = 0x02000000, FlagOneShot = 0x80000000, FlagExclUnlink = 0x04000000 }
 

Public Slots

virtual bool addWatch (const QString &path, WatchEvents modes, WatchFlags flags=WatchFlags())
 
bool removeWatch (const QString &path)
 

Signals

void accessed (const QString &file)
 
void attributeChanged (const QString &file)
 
void closedRead (const QString &file)
 
void closedWrite (const QString &file)
 
void created (const QString &file, bool isDir)
 
void deleted (const QString &file, bool isDir)
 
void modified (const QString &file)
 
void moved (const QString &oldName, const QString &newName)
 
void opened (const QString &file)
 
void unmounted (const QString &file)
 
void watchUserLimitReached (const QString &path)
 

Public Member Functions

 KInotify (QObject *parent=0)
 
virtual ~KInotify ()
 
bool available () const
 
void resetUserLimit ()
 
bool watchingPath (const QString &path) const
 

Protected Member Functions

virtual bool filterWatch (const QString &path, WatchEvents &modes, WatchFlags &flags)
 

Detailed Description

A simple wrapper around inotify which only allows to add folders recursively.

Warning: moving of top-level folders is not supported and results in undefined behaviour.

Definition at line 33 of file kinotify.h.

Member Enumeration Documentation

enum KInotify::WatchEvent

Inotify events that can occur.

Use with addWatch to define the events that should be watched.

These flags correspond to the native Linux inotify flags.

Enumerator
EventAccess 

File was accessed (read, compare inotify's IN_ACCESS)

EventAttributeChange 

Metadata changed (permissions, timestamps, extended attributes, etc., compare inotify's IN_ATTRIB)

EventCloseWrite 

File opened for writing was closed (compare inotify's IN_CLOSE_WRITE)

EventCloseRead 

File not opened for writing was closed (compare inotify's IN_CLOSE_NOWRITE)

EventCreate 
EventDelete 

File/directory created in watched directory (compare inotify's IN_CREATE)

File/directory deleted from watched directory (compare inotify's IN_DELETE)

EventDeleteSelf 

Watched file/directory was itself deleted (compare inotify's IN_DELETE_SELF)

EventModify 

File was modified (compare inotify's IN_MODIFY)

EventMoveSelf 

Watched file/directory was itself moved (compare inotify's IN_MOVE_SELF)

EventMoveFrom 

File moved out of watched directory (compare inotify's IN_MOVED_FROM)

EventMoveTo 

File moved into watched directory (compare inotify's IN_MOVED_TO)

EventOpen 

File was opened (compare inotify's IN_OPEN)

EventUnmount 

Backing fs was unmounted (compare inotify's IN_UNMOUNT)

EventQueueOverflow 

Event queued overflowed (compare inotify's IN_Q_OVERFLOW)

EventIgnored 

File was ignored (compare inotify's IN_IGNORED)

EventMove 
EventAll 

Definition at line 47 of file kinotify.h.

enum KInotify::WatchFlag

Watch flags.

These flags correspond to the native Linux inotify flags.

Enumerator
FlagOnlyDir 

Only watch the path if it is a directory (IN_ONLYDIR)

FlagDoNotFollow 

Don't follow a sym link (IN_DONT_FOLLOW)

FlagOneShot 

Only send event once (IN_ONESHOT)

FlagExclUnlink 

Do not generate events for unlinked files (IN_EXCL_UNLINK)

Definition at line 84 of file kinotify.h.

Constructor & Destructor Documentation

KInotify::KInotify ( QObject *  parent = 0)

Definition at line 215 of file kinotify.cpp.

KInotify::~KInotify ( )
virtual

Definition at line 227 of file kinotify.cpp.

Member Function Documentation

void KInotify::accessed ( const QString &  file)
signal

Emitted if a file is accessed (KInotify::EventAccess)

bool KInotify::addWatch ( const QString &  path,
WatchEvents  modes,
WatchFlags  flags = WatchFlags() 
)
virtualslot

Definition at line 271 of file kinotify.cpp.

void KInotify::attributeChanged ( const QString &  file)
signal

Emitted if file attributes are changed (KInotify::EventAttributeChange)

bool KInotify::available ( ) const
Returns
true if inotify is available and usable.

Definition at line 233 of file kinotify.cpp.

void KInotify::closedRead ( const QString &  file)
signal

Emitted if FIXME (KInotify::EventCloseRead)

void KInotify::closedWrite ( const QString &  file)
signal

Emitted if FIXME (KInotify::EventCloseWrite)

void KInotify::created ( const QString &  file,
bool  isDir 
)
signal

Emitted if a new file has been created in one of the watched folders (KInotify::EventCreate)

void KInotify::deleted ( const QString &  file,
bool  isDir 
)
signal

Emitted if a watched file or folder has been deleted.

This includes files in watched foldes (KInotify::EventDelete and KInotify::EventDeleteSelf)

bool KInotify::filterWatch ( const QString &  path,
WatchEvents &  modes,
WatchFlags &  flags 
)
protectedvirtual

Called for every folder that is being watched.

Returns true if the watch should be add or false if it should NOT be added.

Definition at line 322 of file kinotify.cpp.

void KInotify::modified ( const QString &  file)
signal

Emitted if a watched file is modified (KInotify::EventModify)

void KInotify::moved ( const QString &  oldName,
const QString &  newName 
)
signal

Emitted if a file or folder has been moved or renamed.

Warning
The moved signal will only be emitted if both the source and target folder are being watched.
void KInotify::opened ( const QString &  file)
signal

Emitted if a file is opened (KInotify::EventOpen)

bool KInotify::removeWatch ( const QString &  path)
slot

Definition at line 293 of file kinotify.cpp.

void KInotify::resetUserLimit ( )

Call this when the inotify limit has been increased.

Definition at line 266 of file kinotify.cpp.

void KInotify::unmounted ( const QString &  file)
signal

Emitted if a watched path has been unmounted (KInotify::EventUnmount)

bool KInotify::watchingPath ( const QString &  path) const

Definition at line 260 of file kinotify.cpp.

void KInotify::watchUserLimitReached ( const QString &  path)
signal

Emitted if during updating the internal watch structures (recursive watches) the inotify user watch limit was reached.

This means that not all requested paths can be watched until the user watch limit is increased.

The argument is the path being added when the limit was reached.

This signal will only be emitted once until resetUserLimit is called.


The documentation for this class was generated from the following files:
  • kinotify.h
  • kinotify.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:48:09 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Nepomuk-Core

Skip menu "Nepomuk-Core"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal