class KDirLister

Public Methods

•  KDirLister ( bool _delayedMimeTypes = false )
• virtual ~ KDirLister ()
• virtual void  openURL ( const KURL& _url, bool _showDotFiles, bool _keep = false )
• virtual void  stop ()
• virtual const KURL &  url () const
• virtual bool  setURL ( const KURL& url )
• virtual void  updateDirectory ( const KURL& dir )
• void  listDirectory ()
• void  setAutoUpdate ( bool enable )
• bool  autoUpdate () const
• virtual void  setShowingDotFiles ( bool _showDotFiles )
• virtual bool  showingDotFiles () const
• KFileItem*  find ( const KURL& _url ) const
• KFileItem*  findByName ( const QString& name ) const
• QList<KFileItem> &  items ()
• KFileItem *  rootItem () const
• KIO::ListJob *  job () const
• void  setDirOnlyMode ( bool dirsOnly )
• bool  dirOnlyMode () const
• void  setNameFilter (const QString&)
• bool  matchesFilter ( const QString& name ) const
• virtual void  FilesAdded ( const KURL & directory )
• virtual void  FilesRemoved ( const KURL::List & fileList )
• virtual void  FilesChanged ( const KURL::List & fileList )
• bool  isFinished () const

Signals

• void  started ( const QString& _url )
• void  completed ()
• void  canceled ()
• void  redirection ( const KURL & url )
• void  clear ()
• void  newItems ( const KFileItemList & items )
• void  deleteItem ( KFileItem * _fileItem )
• void  refreshItems ( const KFileItemList & items )
• void  closeView ()

Protected Methods

• virtual KFileItem *  createFileItem ( const KIO::UDSEntry&, const KURL&url, bool determineMimeTypeOnDemand )
• virtual bool  matchesFilter ( const KFileItem * ) const
• void  forgetDirs ()
• void  deleteUnmarkedItems ()
• bool  validURL ( const KURL& ) const

Protected Slots

• void  slotResult ( KIO::Job * )
• void  slotEntries ( KIO::Job*, const KIO::UDSEntryList& )
• void  slotUpdateResult ( KIO::Job * )
• void  slotUpdateEntries ( KIO::Job*, const KIO::UDSEntryList& )
• void  slotRedirection ( KIO::Job *, const KURL & url )
• void  slotDirectoryDirty ( const QString& _dir )
• void  slotFileDirty ( const QString& _file )
• void  slotURLDirty ( const KURL& dir )

Protected Members

• KURL m_url
• KIO::ListJob *m_job
• QList<KFileItem> m_lstFileItems
• KFileItem *m_rootFileItem
• KURL::List m_lstDirs
• bool m_isShowingDotFiles
• bool m_bComplete
• QValueList<KIO::UDSEntry> m_buffer
• bool m_bDirOnlyMode
• bool m_bDelayedMimeTypes
• QList<QRegExp> m_lstFilters
• Forward KDirListerPrivate
• KDirListerPrivate *d

Create a directory lister

[virtual]

Destroy the directory lister

[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:

_url	the directory URL
_showDotFiles	whether to return the "hidden" files
_keep	if true the previous directories aren't forgotten (they are still watched by kdirwatch and their items are kept in m_lstFileItems)

[virtual]

Stop listing the current directory

[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.

[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,

[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.

Convenience method. Starts loading the current directory, e.g. set via setURL().

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

[const]

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

[virtual]

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

[const virtual]

Returns: whether dotfiles are shown

[const]

Find an item by its URL

Parameters:

_url	the item URL

Returns: the pointer to the KFileItem

Reimplemented from DCOPObject.

[const]

Find an item by its name

Parameters:

name	the item name

Returns: the pointer to the KFileItem

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

[const]

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

[const]

Call this with dirsOnly = true to list only directories

[const]

Returns: true if setDirOnlyMode(true) was called

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.

[const]

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

[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.

[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.

[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.

[const]

Returns true if no io operation is currently in progress.

[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.

[signal]

Tell the view that listing is finished

[signal]

Tell the view that user canceled the listing

[signal]

Signal a redirection

[signal]

Clear all items

[signal]

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

[signal]

Signal an item to remove

[signal]

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

[signal]

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

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[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:

url	the URL of the DIRECTORY where this item is.

[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

[protected]

Unregister dirs from kdirwatch and clear list of dirs

[protected]

Delete unmarked items, as it says on the tin

[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.

[protected]

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

[protected]

[protected]

The internal storage of file items

[protected]

File Item for m_url itself (".")

[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)

[protected]

[protected]

[protected]

Keep entries found - used by slotUpdate*

[protected]

List only directories

[protected]

[protected]

a list of file-filters

[protected]