KDirLister Class Reference

from PyKDE4.kio import *

Detailed Description

Enumerations
Changes	{ NONE, NAME_FILTER, MIME_FILTER, DOT_FILES, DIR_ONLY_MODE }
OpenUrlFlag	{ NoFlags, Keep, Reload } Typesafe wrapper: OpenUrlFlags
WhichItems	{ AllItems, FilteredItems }
Signals
	canceled ()
	canceled (KUrl _url)
	clear ()
	clear (KUrl _url)
	completed ()
	completed (KUrl _url)
	deleteItem (KFileItem _fileItem)
	infoMessage (QString msg)
	itemsFilteredByMime (KFileItemList items)
	newItems (KFileItemList items)
	percent (int percent)
	processedSize (KIO.filesize_t size)
	redirection (KUrl _url)
	redirection (KUrl oldUrl, KUrl newUrl)
	refreshItems ([QPair] items)
	speed (int bytes_per_second)
	started (KUrl _url)
	totalSize (KIO.filesize_t size)
Methods
	__init__ (self, QObject parent=0)
bool	autoErrorHandlingEnabled (self)
bool	autoUpdate (self)
	canceled (self)
	canceled (self, KUrl _url)
	clear (self)
	clear (self, KUrl _url)
	clearMimeFilter (self)
	completed (self)
	completed (self, KUrl _url)
bool	delayedMimeTypes (self)
	deleteItem (self, KFileItem _fileItem)
bool	dirOnlyMode (self)
KUrl.List	directories (self)
bool	doMimeFilter (self, QString mime, QStringList filters)
bool	doNameFilter (self, QString name, [QRegExp] filters)
	emitChanges (self)
KFileItem	findByName (self, QString name)
KFileItem	findByUrl (self, KUrl _url)
	handleError (self, KIO.Job a0)
	infoMessage (self, QString msg)
bool	isFinished (self)
KFileItemList	items (self, KDirLister.WhichItems which=KDirLister.FilteredItems)
	itemsFilteredByMime (self, KFileItemList items)
KFileItemList	itemsForDir (self, KUrl dir, KDirLister.WhichItems which=KDirLister.FilteredItems)
QWidget	mainWindow (self)
bool	matchesFilter (self, QString name)
bool	matchesFilter (self, KFileItem a0)
bool	matchesMimeFilter (self, QString mime)
bool	matchesMimeFilter (self, KFileItem a0)
QStringList	mimeFilters (self)
QString	nameFilter (self)
	newItems (self, KFileItemList items)
bool	openUrl (self, KUrl _url, KDirLister.OpenUrlFlags _flags=KDirLister.NoFlags)
	percent (self, int percent)
	processedSize (self, KIO.filesize_t size)
	redirection (self, KUrl _url)
	redirection (self, KUrl oldUrl, KUrl newUrl)
	refreshItems (self, [QPair] items)
KFileItem	rootItem (self)
	setAutoErrorHandlingEnabled (self, bool enable, QWidget parent)
	setAutoUpdate (self, bool enable)
	setDelayedMimeTypes (self, bool delayedMimeTypes)
	setDirOnlyMode (self, bool dirsOnly)
	setMainWindow (self, QWidget window)
	setMimeExcludeFilter (self, QStringList mimeList)
	setMimeFilter (self, QStringList mimeList)
	setNameFilter (self, QString filter)
	setShowingDotFiles (self, bool _showDotFiles)
bool	showingDotFiles (self)
	speed (self, int bytes_per_second)
	started (self, KUrl _url)
	stop (self)
	stop (self, KUrl _url)
	totalSize (self, KIO.filesize_t size)
	updateDirectory (self, KUrl _dir)
KUrl	url (self)

Method Documentation

__init__	(	self,
		QObject	parent=0
	)

Create a directory lister.

bool autoErrorHandlingEnabled ( self )

Check whether auto error handling is enabled. If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default.

Returns:: true if auto error handling is enabled, false otherwise

See also:: setAutoErrorHandlingEnabled()

bool autoUpdate ( self )

Checks whether KDirWatch will automatically update directories. This is enabled by default.

Returns:: true if KDirWatch is used to automatically update directories.

canceled ( self )

Tell the view that the user canceled the listing. No running jobs are left.

Signal syntax:: QObject.connect(source, SIGNAL("canceled()"), target_slot)

canceled	(	self,
		KUrl	_url
	)

Tell the view that the listing of the directory _url was canceled. There might be other running jobs left.

Parameters:

_url

the directory URL

Signal syntax:: QObject.connect(source, SIGNAL("canceled(const KUrl&)"), target_slot)

clear ( self )

Signal to clear all items. It must always be connected to this signal to avoid doubled items!

Signal syntax:: QObject.connect(source, SIGNAL("clear()"), target_slot)

clear	(	self,
		KUrl	_url
	)

Signal to empty the directory _url. It is only emitted if the lister is holding more than one directory.

Parameters:

_url

the directory that will be emptied

Signal syntax:: QObject.connect(source, SIGNAL("clear(const KUrl&)"), target_slot)

clearMimeFilter ( self )

Clears the mime based filter.

See also:: setMimeFilter

completed ( self )

Tell the view that listing is finished. There are no jobs running anymore.

Signal syntax:: QObject.connect(source, SIGNAL("completed()"), target_slot)

completed	(	self,
		KUrl	_url
	)

Tell the view that the listing of the directory _url is finished. There might be other running jobs left.

Parameters:

_url

the directory URL

Signal syntax:: QObject.connect(source, SIGNAL("completed(const KUrl&)"), target_slot)

bool delayedMimeTypes ( self )

Returns:: true if the "delayed mimetypes" feature was enabled

See also:: setDelayedMimeTypes

deleteItem	(	self,
		KFileItem	_fileItem
	)

Signal an item to remove.

Parameters:

_fileItem

the fileItem to delete

Signal syntax:: QObject.connect(source, SIGNAL("deleteItem(const KFileItem&)"), target_slot)

bool dirOnlyMode ( self )

Checks whether the KDirLister only lists directories or all files. By default this option is disabled (all files will be shown).

Returns:: true if setDirOnlyMode(true) was called

KUrl.List directories ( self )

Returns all URLs that are listed by this KDirLister. This is only useful if you called openUrl() with _keep == true, as it happens in a treeview, for example. (Note that the base url is included in the list as well, of course.)

Returns:: the list of all listed URLs

bool doMimeFilter	(	self,
		QString	mime,
		QStringList	filters
	)

Called by the public matchesMimeFilter() to do the actual filtering. Those methods may be reimplemented to customize filtering.

Parameters:

	mime	the mime type to filter
	filters	the list of mime types to filter

bool doNameFilter	(	self,
		QString	name,
		[QRegExp]	filters
	)

Called by the public matchesFilter() to do the actual filtering. Those methods may be reimplemented to customize filtering.

Parameters:

	name	the name to filter
	filters	a list of regular expressions for filtering

emitChanges ( self )

Actually emit the changes made with setShowingDotFiles, setDirOnlyMode, setNameFilter and setMimeFilter.

KFileItem findByName	(	self,
		QString	name
	)

Find an item by its name.

Parameters:

name

the item name

Returns:: the KFileItem

KFileItem findByUrl	(	self,
		KUrl	_url
	)

Find an item by its URL.

Parameters:

_url

the item URL

Returns:: the KFileItem

handleError	(	self,
		KIO.Job	a0
	)

Reimplement to customize error handling

infoMessage	(	self,
		QString	msg
	)

Emitted to display information about running jobs. Examples of message are "Resolving host", "Connecting to host...", etc.

Parameters:

msg

the info message

Signal syntax:: QObject.connect(source, SIGNAL("infoMessage(const QString&)"), target_slot)

bool isFinished ( self )

Returns true if no io operation is currently in progress.

Returns:: true if finished, false otherwise

KFileItemList items	(	self,
		KDirLister.WhichItems	which=KDirLister.FilteredItems
	)

Returns the items listed for the current url(). This method will NOT start listing a directory, you should only call this when receiving the finished() signal.

The items in the KFileItemList are references to the items used by KDirLister, so e.g. an item gets destroyed when the deleteItem() signal is emitted.

Parameters:

which

specifies whether the returned list will contain all entries or only the ones that passed the nameFilter(), mimeFilter(), etc. Note that the latter causes iteration over all the items, filtering them. If this is too slow for you, use the newItems() signal, sending out filtered items in chunks.

Returns:: the items listed for the current url().

itemsFilteredByMime	(	self,
		KFileItemList	items
	)

Send a list of items filtered-out by mime-type.

Parameters:

items

the list of filtered items

Signal syntax:: QObject.connect(source, SIGNAL("itemsFilteredByMime(const KFileItemList&)"), target_slot)

KFileItemList itemsForDir	(	self,
		KUrl	dir,
		KDirLister.WhichItems	which=KDirLister.FilteredItems
	)

Returns the items listed for the given dir. This method will NOT start listing dir, you should only call this when receiving the finished() signal.

The items in the KFileItemList are references to the items used by KDirLister, so e.g. an item gets destroyed when the deleteItem() signal is emitted.

Parameters:

	dir	specifies the url for which the items should be returned. This is only useful if you use KDirLister with multiple URLs i.e. using bool keep = true in openUrl().
	which	specifies whether the returned list will contain all entries or only the ones that passed the nameFilter, mimeFilter, etc. Note that the latter causes iteration over all the items, filtering them. If this is too slow for you, use the newItems() signal, sending out filtered items in chunks.

Returns:: the items listed for dir.

QWidget mainWindow ( self )

Returns the main window associated with this object.

Returns:: the associated main window, or 0 if there is none

bool matchesFilter	(	self,
		QString	name
	)

Checks whether name matches a filter in the list of name filters.

Returns:: true if name matches a filter in the list, otherwise false.

See also:: setNameFilter

bool matchesFilter	(	self,
		KFileItem	a0
	)

Called for every new item before emitting newItems(). You may reimplement this method in a subclass to implement your own filtering. The default implementation filters out ".." and everything not matching the name filter(s)

Returns:: true if the item is "ok". false if the item shall not be shown in a view, e.g. files not matching a pattern *.cpp ( KFileItem.isHidden())

See also:: matchesFilter

See also:: setNameFilter

bool matchesMimeFilter	(	self,
		QString	mime
	)

Checks whether mime matches a filter in the list of mime types

Parameters:

mime

the mimetype to find in the filter list.

Returns:: true if name matches a filter in the list, otherwise false.

See also:: setMimeFilter.

bool matchesMimeFilter	(	self,
		KFileItem	a0
	)

Returns:: true if the item is "ok". false if the item shall not be shown in a view, e.g. files not matching a pattern *.cpp ( KFileItem.isHidden())

See also:: matchesMimeFilter

See also:: setMimeFilter

QStringList mimeFilters ( self )

Returns the list of mime based filters, as set via setMimeFilter().

Returns:: the list of mime based filters. Empty, when no mime filter is set.

QString nameFilter ( self )

Returns the current name filter, as set via setNameFilter()

Returns:: the current name filter, can be QString() if filtering is turned off

newItems	(	self,
		KFileItemList	items
	)

Signal new items.

So use this signal only if you want to modify original KFileItems

Parameters:

items

a list of new items

Signal syntax:: QObject.connect(source, SIGNAL("newItems(const KFileItemList&)"), target_slot)

bool openUrl	(	self,
		KUrl	_url,
		KDirLister.OpenUrlFlags	_flags=KDirLister.NoFlags
	)

Run the directory lister on the given url.

This method causes KDirLister to emit _all_ the items of _url, in any case. Depending on _keep either clear() or clear(const KUrl &) will be emitted first.

The newItems() signal may be emitted more than once to supply you with KFileItems, up until the signal completed() is emitted (and isFinished() returns true).

Parameters:

	_url	the directory URL.
	_flags	whether to keep previous directories, and whether to reload, see OpenUrlFlags

Returns:: true if successful, false otherwise (e.g. invalid _url)

percent	(	self,
		int	percent
	)

Progress signal showing the overall progress of the KDirLister. This allows using a progress bar very easily. (see QProgressBar)

Parameters:

percent

the progress in percent

Signal syntax:: QObject.connect(source, SIGNAL("percent(int)"), target_slot)

processedSize	(	self,
		KIO.filesize_t	size
	)

Regularly emitted to show the progress of this KDirLister.

Parameters:

size

the processed size in bytes

Signal syntax:: QObject.connect(source, SIGNAL("processedSize(filesize_t)"), target_slot)

redirection	(	self,
		KUrl	_url
	)

Signal a redirection. Only emitted if there's just one directory to list, i.e. most probably openUrl() has been called with _keep == false.

Parameters:

_url

the new URL

Signal syntax:: QObject.connect(source, SIGNAL("redirection(const KUrl&)"), target_slot)

redirection	(	self,
		KUrl	oldUrl,
		KUrl	newUrl
	)

Signal a redirection.

Parameters:

	oldUrl	the original URL
	newUrl	the new URL

Signal syntax:: QObject.connect(source, SIGNAL("redirection(const KUrl&, const KUrl&)"), target_slot)

refreshItems	(	self,
		[QPair]	items
	)

Signal an item to refresh (its mimetype/icon/name has changed). Note: KFileItem.refresh has already been called on those items.

Parameters:

items

the items to refresh. This is a list of pairs, where the first item in the pair is the OLD item, and the second item is the NEW item. This allows to track which item has changed, especially after a renaming.

Signal syntax:: QObject.connect(source, SIGNAL("refreshItems(const QList>&)"), target_slot)

KFileItem rootItem ( self )

Returns the file item of the URL.

Can return an empty KFileItem.

Returns:: the file item for url() itself (".")

setAutoErrorHandlingEnabled	(	self,
		bool	enable,
		QWidget	parent
	)

Enable or disable auto error handling is enabled. If enabled, it will show an error dialog to the user when an error occurs. It is turned on by default.

Parameters:

	enable	true to enable auto error handling, false to disable
	parent	the parent widget for the error dialogs, can be 0 for top-level

See also:: autoErrorHandlingEnabled()

setAutoUpdate	(	self,
		bool	enable
	)

Enable/disable automatic directory updating, when a directory changes (using KDirWatch).

Parameters:

enable

true to enable, false to disable

setDelayedMimeTypes	(	self,
		bool	delayedMimeTypes
	)

Delayed mimetypes feature: If enabled, mime types will be fetched on demand, which leads to a faster initial directory listing, where icons get progressively replaced with the correct one while KMimeTypeResolver is going through the items with unknown or imprecise mimetype (e.g. files with no extension or an unknown extension).

setDirOnlyMode	(	self,
		bool	dirsOnly
	)

Call this to list only directories. By default this option is disabled (all files will be shown).

Parameters:

dirsOnly

true to list only directories

setMainWindow	(	self,
		QWidget	window
	)

Pass the main window this object is associated with this is used for caching authentication data

Parameters:

window

the window to associate with, 0 to disassociate

setMimeExcludeFilter	(	self,
		QStringList	mimeList
	)

Filtering should be done with KFileFilter. This will be implemented in a later revision of KDirLister. This method may be removed then.

Set mime-based exclude filter to only list items not matching the given mimetypes

NOTE: setting the filter does not automatically reload directory. Also calling this function will not affect any named filter already set.

Parameters:

mimeList

a list of mime-types.

See also:: clearMimeFilter

See also:: matchesMimeFilter

Internal:

setMimeFilter	(	self,
		QStringList	mimeList
	)

Set mime-based filter to only list items matching the given mimetypes.

NOTE: setting the filter does not automatically reload directory. Also calling this function will not affect any named filter already set.

Parameters:

mimeList

a list of mime-types.

See also:: clearMimeFilter

See also:: matchesMimeFilter

setNameFilter	(	self,
		QString	filter
	)

Set a name filter to only list items matching this name, e.g. "*.cpp".

You can set more than one filter by separating them with whitespace, e.g "*.cpp *.h". Note: the directory is not automatically reloaded.

Parameters:

filter

the new filter, QString() to disable filtering

See also:: matchesFilter

setShowingDotFiles	(	self,
		bool	_showDotFiles
	)

Changes the "is viewing dot files" setting. Calls updateDirectory() if setting changed. By default this option is disabled (hidden files will not be shown).

Parameters:

_showDotFiles

true to enable showing hidden files, false to disable

See also:: showingDotFiles()

bool showingDotFiles ( self )

Checks whether hidden files (files beginning with a dot) will be shown. By default this option is disabled (hidden files will be not shown).

Returns:: true if dot files are shown, false otherwise

See also:: setShowingDotFiles()

speed	(	self,
		int	bytes_per_second
	)

Emitted to display information about the speed of the jobs.

Parameters:

bytes_per_second

the speed in bytes/s

Signal syntax:: QObject.connect(source, SIGNAL("speed(int)"), target_slot)

started	(	self,
		KUrl	_url
	)

Tell the view that we started to list _url. NOTE: this does _not_ imply that there is really a job running! I.e. KDirLister.jobs() may return an empty list. In this case the items are taken from the cache.

The view knows that openUrl should start it, so it might seem useless, but the view also needs to know when an automatic update happens.

Parameters:

_url

the URL to list

Signal syntax:: QObject.connect(source, SIGNAL("started(const KUrl&)"), target_slot)

stop ( self )

Stop listing all directories currently being listed.

Emits canceled() if there was at least one job running. Emits canceled( const KUrl& ) for each stopped job if there are at least two dirctories being watched by KDirLister.

stop	(	self,
		KUrl	_url
	)

Stop listing the given directory.

Emits canceled() if the killed job was the last running one. Emits canceled( const KUrl& ) for the killed job if there are at least two directories being watched by KDirLister. No signal is emitted if there was no job running for _url.

Parameters:

_url

the directory URL

totalSize	(	self,
		KIO.filesize_t	size
	)

Emitted when we know the size of the jobs.

Parameters:

size

the total size in bytes

Signal syntax:: QObject.connect(source, SIGNAL("totalSize(filesize_t)"), target_slot)

updateDirectory	(	self,
		KUrl	_dir
	)

Update the directory _dir. This method causes KDirLister to _only_ emit the items of _dir that actually changed compared to the current state in the cache and updates the cache.

The current implementation calls updateDirectory automatically for local files, using KDirWatch (if autoUpdate() is true), but it might be useful to force an update manually.

Parameters:

_dir

the directory URL

KUrl url ( self )

Returns the top level URL that is listed by this KDirLister. It might be different from the one given with openUrl() if there was a redirection. If you called openUrl() with _keep == true this is the first url opened (e.g. in a treeview this is the root).

Returns:: the url used by this instance to list the files.

Enumeration Documentation

Changes

Enumerator:

NONE = 0
NAME_FILTER = 1
MIME_FILTER = 2
DOT_FILES = 4
DIR_ONLY_MODE = 8

OpenUrlFlag

Note:: It is necessary to wrap members of this enumeration in a OpenUrlFlags instance when passing them to a method as group of flags. For example: OpenUrlFlags( NoFlags | Keep)

Enumerator:

NoFlags = 0x0
Keep = 0x1
Reload = 0x2

WhichItems

Used by items() and itemsForDir() to specify whether you want all items for a directory or just the filtered ones.

Enumerator:

AllItems = 0
FilteredItems = 1

KDirLister Class Reference

Detailed Description

Enumerations

Signals

Methods

Method Documentation

Enumeration Documentation

Modules