|
|
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)
| void started ( const KURL& _url )
| started |
[signal]
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.
| void completed ()
| completed |
[signal]
Tell the view that listing is finished. There are no jobs running anymore.
| void completed ( const KURL& _url )
| completed |
[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 |
| void canceled ()
| canceled |
[signal]
Tell the view that the user canceled the listing. No running jobs are left.
| void canceled ( const KURL& _url )
| canceled |
[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 |
| void redirection ( const KURL& _url )
| redirection |
[signal]
Signal a redirection. Only emitted if there's just one directory to list, i.e. most probably _keep == false
| void redirection ( const KURL& oldUrl, const KURL& newUrl )
| redirection |
[signal]
Signal a redirection.
| void clear ()
| clear |
[signal]
Signal to clear all items. It must always be connected to this signal to avoid doubled items!
| void clear ( const KURL& _url )
| clear |
[signal]
Signal to empty the directory _url. It is only emitted if the lister is holding more than one directory.
| void newItems ( const KFileItemList& items )
| newItems |
[signal]
Signal new items, complete is true when the directory loading has
finished
| void itemsFilteredByMime ( const KFileItemList& items )
| itemsFilteredByMime |
[signal]
Send a list of items filtered-out by mime-type.
| void deleteItem ( KFileItem *_fileItem )
| deleteItem |
[signal]
Signal an item to remove.
ATTENTION: if _fileItem == rootItem() the directory this lister
is holding was deleted and you HAVE to release especially the
rootItem of this lister otherwise your app will CRASH!!
The clear() signals have been emitted already.
| void refreshItems ( const KFileItemList& items )
| refreshItems |
[signal]
Signal an item to refresh (its mimetype/icon/name has changed) Note: KFileItem::refresh has already been called on those items.
| void infoMessage ( const QString& msg )
| infoMessage |
[signal]
Emitted to display information about running jobs. Examples of message are "Resolving host", "Connecting to host...", etc.
| void percent ( int percent )
| percent |
[signal]
Progress signal showing the overall progress of the KDirLister. This allows using a progress bar very easily. (see KProgress)
| void totalSize ( KIO::filesize_t size )
| totalSize |
[signal]
Emitted when we know the size of the jobs.
| void processedSize ( KIO::filesize_t size )
| processedSize |
[signal]
Regularly emitted to show the progress of this KDirLister.
| void speed ( int bytes_per_second )
| speed |
[signal]
Emitted to display information about the speed of the jobs.
| bool matchesFilter ( const KFileItem * )
| matchesFilter |
[protected const virtual]
Called for every new item before emitting newItems().
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
| bool matchesMimeFilter ( const KFileItem * )
| matchesMimeFilter |
[protected const virtual]
| bool doNameFilter ( const QString& name, const QPtrList<QRegExp>& filters )
| doNameFilter |
[protected const virtual]
Called by the public matchesFilter/matchesMimeFilter to do the actual filtering. Those methods may be reimplemented to customize filtering.
| bool doMimeFilter ( const QString& mime, const QStringList& filters )
| doMimeFilter |
[protected const virtual]
| bool validURL ( const KURL& )
| validURL |
[protected const virtual]
Checks if an url is malformed or not and displays an error message if it is and autoErrorHandling is set to true.
Returns: true if url is valid, otherwise false.
| void handleError ( KIO::Job* )
| handleError |
[protected virtual]
| void virtual_hook ( int id, void* data )
| virtual_hook |
[protected virtual]
| Generated by: dfaure on faure on Tue Apr 16 08:49:48 2002, using kdoc 2.0a53. |