class KDirLister

Public Methods

•  KDirLister ( bool _delayedMimeTypes = false )
• virtual  ~KDirLister ()
• virtual void  openURL ( const KURL& _url, bool _showDotFiles, bool _keep = false )
• virtual void  stop ()
• void  stop ( const KURL& _url )
• virtual const KURL &  url () const
• virtual bool  setURL ( const KURL& url )
• virtual void  updateDirectory ( const KURL& _dir )
• void  listDirectory ()
• void  setURLDirty ( bool dirty )
• 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& )
• void  setMimeFilter ( const QStringList& )
• void  clearMimeFilter ()
• void  setMimeFilter ( const QString& )
• const QString&  nameFilter () const
• QStringList  mimeFilters () const
• const QString&  mimeFilter () const
• bool  matchesFilter ( const QString& name ) const
• bool  matchesMimeFilter ( const QString& mime ) const
• virtual void  FilesAdded ( const KURL & directory )
• virtual void  FilesRemoved ( const KURL::List & fileList )
• virtual void  FilesChanged ( const KURL::List & fileList )
• virtual void  FileRenamed ( const KURL &src, const KURL &dst )
• bool  isFinished () const

Signals

• void  started ( const QString& _url )
• void  completed ()
• void  completed ( const KURL& _url )
• void  canceled ()
• void  canceled ( const KURL& _url )
• void  redirection ( const KURL & url )
• void  redirection ( const KURL & oldUrl, const KURL & newUrl )
• void  clear ()
• void  newItems ( const KFileItemList & items )
• void  itemsFilteredByMime ( 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
• bool  matchesMimeFilter ( const KFileItem * ) const
• void  forgetDirs ()
• void  deleteUnmarkedItems ()
• bool  validURL ( const KURL& ) const
• void  processPendingUpdates ()

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 m_lstFileItems
• KFileItem * m_rootFileItem
• KURL::List m_lstDirs
• bool m_isShowingDotFiles
• bool m_bComplete
• QValueList m_buffer
• bool m_bDirOnlyMode
• bool m_bDelayedMimeTypes
• QList m_lstFilters
• Forward KDirListerPrivate
• KDirListerPrivate * d

Detailed Description

The dir lister deals with the kiojob used to list and update a directory 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)

Create a directory lister.

[virtual]

Destroy the directory lister.

[virtual]

Run the directory lister on the given url. If _url is already in the cache (i.e. openURL() was already called with _url) and _keep == true this is equivalent to updateDirectory( _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). This is useful for e.g. a treeview.

[virtual]

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

[const virtual]

Returns: the url used by this instance to list the files, with _keep == true, this is the first url opened (in e.g. a treeview this is the root). It might be different from the one given with openURL() or setURL() 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 _dir. 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.

Parameters:

_dir	the directory URL

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.

See also: setURLDirty

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

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

[const]

Returns: whether KDirWatch is used to automatically update directories. This is 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]

## problem, if there are more jobs running (merge?)

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. Note: the direcory is not automatically reloaded.

See also: matchesFilter

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

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

Parameters:

a	list of mime-types.

See also: clearMimeFilter, matchesMimeFilter

Clears the mime based filter.

See also: setMimeFilter

Sets mime filters separated with space. ## remove for 3.0

[const]

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

[const]

Returns: the list of mime based filters, as set via setMimeFilter(). Empty, when no mime filter is set.

[const]

Returns: the current mime filter as set via setMimeFilter()

[const]

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

See also: setNameFilter

[const]

Parameters:

mime	the mimetype to find in the filter list.

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

See also: setNameFilter.

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

[virtual]

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.

## KDE 3.0: change to const KURL&

[signal]

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

[signal]

Tell the view that the listing of the directory _url is finished. There might be other running jobs left. This signal is only emitted if KDirLister is watching more than one directory.

Parameters:

_url	the directory URL

[signal]

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

[signal]

Tell the view that the listing of the directory _url was canceled. There might be other running jobs left. This signal is only emitted if KDirLister is watching more than one directory.

Parameters:

_url	the directory URL

[signal]

Signal a redirection. Only emitted if _keep == false

[signal]

Signal a redirection. Only emitted if _keep == true, i.e. there are more than one dirs to list

[signal]

[signal]

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

[signal]

[signal]

Signal an item to remove. ## change to const KFileItem in 3.0

[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 slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots slot]

[protected slots 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 const]

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

If an update was triggered while we were listing, we'll process it after the end of the listing. This processes the next update in the list of pending updates.

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]