class KDirLister

Helper class for the kiojob used to list and update a directory. More...

Full nameKIO::KDirLister
Definition#include <kdirlister.h>
InheritsKDirNotify, QObject (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Signals

Protected Methods

Protected Slots

Protected Members


Detailed Description

The dir lister deals with the kiojob used to list and update a directory, handles the timer, and has signals for the user of this class (e.g. konqueror view or kdesktop) to create/destroy its items when asked.

This class is independent from the graphical representation of the dir (icon container, tree view, ...) and it stores the items (as KFileItems).

Typical usage : Create an instance, Connect to at least update, clear, newItem, and deleteItem Call openURL - the signals will be called Reuse the instance when opening a new url (openURL) Destroy the instance when not needed anymore (usually destructor)

Advanced usage : call openURL with _keep = true to list directories without forgetting the ones previously read (e.g. for a tree view)

 KDirLister ( bool _delayedMimeTypes = false )

Create a directory lister

KDirLister ()

[virtual]

Destroy the directory lister

void  openURL ( const KURL& _url, bool _showDotFiles, bool _keep = false )

[virtual]

Run the directory lister on the given url

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:

void  stop ()

[virtual]

Stop listing the current directory

const KURL &  url ()

[const virtual]

Returns: the url used by this instance to list the files It might be different from the one we gave, if there was a redirection.

bool  setURL ( const KURL& url )

[virtual]

Sets url as the current url, forgetting any previous ones and stopping any pending job. If url is malformed, the previous url will be kept and false will be returned.

Does _not_ start loading that url,

void  updateDirectory ( const KURL& dir )

[virtual]

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

void  listDirectory ()

Convenience method. Starts loading the current directory, e.g. set via setURL(), if the URL is "dirty" -- otherwise the cached entries are reused. The url is dirty when a new URL was set via setURL or the nameFilter was changed.

void  setURLDirty ( bool dirty )

Sets the current URL "dirty", so it will be reloaded upon the next listDirectory() call.

void  setAutoUpdate ( bool enable )

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

bool  autoUpdate ()

[const]

Returns: whether KDirWatch is used to automatically update directories. enabled by default.

void  setShowingDotFiles ( bool _showDotFiles )

[virtual]

Changes the "is viewing dot files" setting. Calls updateDirectory() if setting changed

bool  showingDotFiles ()

[const virtual]

Returns: whether dotfiles are shown

KFileItem*  find ( const KURL& _url )

[const]

Find an item by its URL

Parameters:

Returns: the pointer to the KFileItem

Reimplemented from DCOPObject.

KFileItem*  findByName ( const QString& name )

[const]

Find an item by its name

Parameters:

Returns: the pointer to the KFileItem

QList<KFileItem> &  items ()

Returns: the list of file items. The list may be incomplete if isFinished() is false, i.e. it is still loading items.

KFileItem *  rootItem ()

[const]

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

KIO::ListJob *  job ()

[const]

void  setDirOnlyMode ( bool dirsOnly )

Call this with dirsOnly = true to list only directories

bool  dirOnlyMode ()

[const]

Returns: true if setDirOnlyMode(true) was called

void  setNameFilter (const QString&)

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". Call setNameFilter( QString::null ) to disable filtering. Note: the direcory is not automatically reloaded.

const QString&  nameFilter ()

[const]

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

bool  matchesFilter ( const QString& name )

[const]

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

void  FilesAdded ( const KURL & directory )

[virtual]

Notify that files have been added in directory The receiver will list that directory again to find the new items (since it needs more than just the names anyway). Reimplemented from KDirNotify.

Reimplemented from KDirNotify.

void  FilesRemoved ( const KURL::List & fileList )

[virtual]

Notify that files have been deleted. This call passes the exact urls of the deleted files so that any view showing them can simply remove them or be closed (if its current dir was deleted) Reimplemented from KDirNotify.

Reimplemented from KDirNotify.

void  FilesChanged ( const KURL::List & fileList )

[virtual]

Notify that files have been changed. At the moment, this is only used for new icon, but it could be used for size etc. as well. Note: this is ASYNC so that it can be used with a broadcast

Reimplemented from KDirNotify.

void  FileRenamed ( const KURL &src, const KURL &dst )

[virtual]

Reimplemented from KDirNotify.

bool  isFinished ()

[const]

Returns true if no io operation is currently in progress.

void  started ( const QString& _url )

[signal]

Tell the view that we started to list _url. 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.

void  completed ()

[signal]

Tell the view that listing is finished

void  canceled ()

[signal]

Tell the view that user canceled the listing

void  redirection ( const KURL & url )

[signal]

Signal a redirection

void  clear ()

[signal]

Clear all items

void  newItems ( const KFileItemList & items )

[signal]

Signal new items, complete is true when the directory loading has finished

void  deleteItem ( KFileItem * _fileItem )

[signal]

Signal an item to remove

void  refreshItems ( const KFileItemList & items )

[signal]

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

void  closeView ()

[signal]

Instruct the view to close itself, since the dir was just deleted.

void  slotResult ( KIO::Job * )

[protected slot]

void  slotEntries ( KIO::Job*, const KIO::UDSEntryList& )

[protected slot]

void  slotUpdateResult ( KIO::Job * )

[protected slot]

void  slotUpdateEntries ( KIO::Job*, const KIO::UDSEntryList& )

[protected slot]

void  slotRedirection ( KIO::Job *, const KURL & url )

[protected slot]

void  slotDirectoryDirty ( const QString& _dir )

[protected slot]

void  slotFileDirty ( const QString& _file )

[protected slot]

void  slotURLDirty ( const KURL& dir )

[protected slot]

KFileItem *  createFileItem ( const KIO::UDSEntry&, const KURL&url, bool determineMimeTypeOnDemand )

[protected virtual]

called to create a KFileItem - you may subclass and reimplement this method if you use "special KFileItems", i.e. a subclass like KonqFileItem Must return a valid KFileItem

Parameters:

bool  matchesFilter ( const KFileItem * )

[protected const virtual]

Called for every item after createFileItem().

Returns: false if the item shall not be shown in a view, e.g. files not matching a pattern *.cpp (KFileItem::isHidden()) 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)

See also: matchesFilter, setNameFilter

void  forgetDirs ()

[protected]

Unregister dirs from kdirwatch and clear list of dirs

void  deleteUnmarkedItems ()

[protected]

Delete unmarked items, as it says on the tin

bool  validURL ( const KURL& )

[protected const]

Checks if a url is malformed or not and displays an error message if it is. Returns true if it is valid, otherwise false.

KURL m_url

[protected]

The url that we used to list (can be different in case of redirect)

KIO::ListJob * m_job

[protected]

QList<KFileItem> m_lstFileItems

[protected]

The internal storage of file items

KFileItem * m_rootFileItem

[protected]

File Item for m_url itself (".")

KURL::List m_lstDirs

[protected]

List of dirs handled by this instance. Same as m_url if only one dir But for a tree view, it contains all the dirs shown (Used to unregister from kdirwatch)

bool m_isShowingDotFiles

[protected]

bool m_bComplete

[protected]

QValueList<KIO::UDSEntry> m_buffer

[protected]

Keep entries found - used by slotUpdate*

bool m_bDirOnlyMode

[protected]

List only directories

bool m_bDelayedMimeTypes

[protected]

QList<QRegExp> m_lstFilters

[protected]

a list of file-filters

KDirListerPrivate * d

[protected]


Generated by: baudens@ke.mandrakesoft.com on Thu Oct 26 17:36:34 2000, using kdoc 2.0a40.