class KDirLister |
|
|
Helper class for the kiojob used to list and update a directory. 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 : Advanced usage : call openUrl with _keep = true to list directories without forgetting the ones previously read (e.g. for a tree view)
Author Michael Brade |
|
Create a directory lister. |
|
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() |
|
Checks whether KDirWatch will automatically update directories. This is enabled by default. Returns true if KDirWatch is used to automatically update directories. |
|
Tell the view that the user canceled the listing. No running jobs are left. |
|
Tell the view that the listing of the directory _url was canceled. There might be other running jobs left. _url - the directory URL |
|
Signal to clear all items. It must always be connected to this signal to avoid doubled items! |
|
Signal to empty the directory _url. It is only emitted if the lister is holding more than one directory. _url - the directory that will be emptied |
|
Clears the mime based filter. See also setMimeFilter |
|
Tell the view that listing is finished. There are no jobs running anymore. |
|
Tell the view that the listing of the directory _url is finished. There might be other running jobs left. _url - the directory URL |
|
Returns true if the "delayed mimetypes" feature was enabled See also setDelayedMimeTypes |
|
Signal an item to remove. For KDE 4 applications it is recommended using KDirLister.deleteItem(KFileItem _fileItem) instead, as the interfaces have been adjusted using KFileItem per value instead of per pointer. 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. _fileItem - the fileItem to delete |
|
Signal an item to remove. For KDE 4 applications it is recommended using KDirLister.deleteItem(KFileItem _fileItem) instead, as the interfaces have been adjusted using KFileItem per value instead of per pointer. 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. _fileItem - the fileItem to delete |
|
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 |
|
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 |
|
Called by the public matchesMimeFilter() to do the actual filtering. Those methods may be reimplemented to customize filtering. mime - the mime type to filter filters - the list of mime types to filter |
|
Called by the public matchesFilter() to do the actual filtering. Those methods may be reimplemented to customize filtering. name - the name to filter filters - a list of regular expressions for filtering |
|
Actually emit the changes made with setShowingDotFiles, setDirOnlyMode, setNameFilter and setMimeFilter. |
|
Find an item by its name. name - the item name Returns the pointer to the KFileItem |
|
Find an item by its URL. _url - the item URL Returns the pointer to the KFileItem |
|
Reimplement to customize error handling |
|
Emitted to display information about running jobs. Examples of message are "Resolving host", "Connecting to host...", etc. msg - the info message |
|
Returns true if no io operation is currently in progress. Returns true if finished, false otherwise |
|
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.
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(). |
|
Send a list of items filtered-out by mime-type.
For KDE 4 applications it is recommended using
KDirLister.itemsFilteredByMime(const QList items - the list of filtered items |
|
Send a list of items filtered-out by mime-type. items - the list of filtered items |
|
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.
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. |
|
Returns the main window associated with this object. Returns the associated main window, or 0 if there is none |
|
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 |
|
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 |
|
Checks whether mime matches a filter in the list of mime types mime - the mimetype to find in the filter list. Returns true if name matches a filter in the list, otherwise false. See also setMimeFilter. |
|
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 matchesMimeFilter See also setMimeFilter |
|
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. |
|
Returns the current name filter, as set via setNameFilter() Returns the current name filter, can be QString() if filtering is turned off |
|
Signal new items.
For KDE 4 applications it is recommended using
KDirLister.newItems(const QList So use this signal only if you want to modify original KFileItems items - a list of new items |
|
Signal new items. items - a list of new items |
|
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).
_url - the directory URL. _keep - if true the previous directories aren't forgotten (they are still watched by kdirwatch and their items are kept for this KDirLister). This is useful for e.g. a treeview. _reload - indicates wether to use the cache (false) or to reread the directory from the disk. Use only when opening a dir not yet listed by this lister without using the cache. Otherwise use updateDirectory. Returns true if successful, false otherwise (e.g. invalid _url) |
|
Progress signal showing the overall progress of the KDirLister. This allows using a progress bar very easily. (see QProgressBar) percent - the progress in percent |
|
Regularly emitted to show the progress of this KDirLister. size - the processed size in bytes |
|
Signal a redirection. Only emitted if there's just one directory to list, i.e. most probably openUrl() has been called with _keep == false. _url - the new URL |
|
Signal a redirection. oldUrl - the original URL newUrl - the new URL |
|
Signal an item to refresh (its mimetype/icon/name has changed).
Note: KFileItem.refresh has already been called on those items.
For KDE 4 applications it is recommended using
KDirLister.refreshItems(const QList So use this signal only if you want to modify original KFileItems items - the items to refresh |
|
Signal an item to refresh (its mimetype/icon/name has changed). Note: KFileItem.refresh has already been called on those items. items - the items to refresh |
|
Returns the file item of the URL. Can return 0. TODO is it OK? maybe use KFileItem(void)? Returns the file item for url() itself (".") |
|
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. 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() |
|
Enable/disable automatic directory updating, when a directory changes (using KDirWatch). enable - true to enable, false to disable |
|
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). |
|
Call this to list only directories. By default this option is disabled (all files will be shown). dirsOnly - true to list only directories |
|
Pass the main window this object is associated with this is used for caching authentication data window - the window to associate with, 0 to disassociate |
|
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.
mimeList - a list of mime-types. See also clearMimeFilter See also matchesMimeFilter Internal |
|
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.
mimeList - a list of mime-types. See also clearMimeFilter See also matchesMimeFilter |
|
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.
filter - the new filter, QString() to disable filtering See also matchesFilter |
|
Changes the "is viewing dot files" setting. Calls updateDirectory() if setting changed. By default this option is disabled (hidden files will not be shown). _showDotFiles - true to enable showing hidden files, false to disable See also showingDotFiles() |
|
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() |
|
Emitted to display information about the speed of the jobs. bytes_per_second - the speed in bytes/s |
|
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. _url - the URL to list |
|
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. _url - the directory URL |
|
Emitted when we know the size of the jobs. size - the total size in bytes |
|
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.
_dir - the directory URL |
|
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. |
NONE | - | ||
NAME_FILTER | - | ||
MIME_FILTER | - | ||
DOT_FILES | - | ||
DIR_ONLY_MODE | - |
AllItems | - | ||
FilteredItems | - |