org.kde.koala

Interface KDirListerSignals

public interface KDirListerSignals

Method Summary
voidcanceled()
Tell the view that the user canceled the listing.
voidcanceled(KURL _url)
Tell the view that the listing of the directory _url was canceled.
voidclear()
Signal to clear all items.
voidclear(KURL _url)
Signal to empty the directory _url. It is only emitted if the lister is holding more than one directory.
voidcompleted()
Tell the view that listing is finished.
voidcompleted(KURL _url)
Tell the view that the listing of the directory _url is finished.
voiddeleteItem(KFileItem _fileItem)
Signal an item to remove.
voidinfoMessage(String msg)
Emitted to display information about running jobs.
voiditemsFilteredByMime(ArrayList items)
Send a list of items filtered-out by mime-type.
voidnewItems(ArrayList items)
Signal new items.
voidpercent(int percent)
Progress signal showing the overall progress of the KDirLister.
voidprocessedSize(long size)
Regularly emitted to show the progress of this KDirLister.
voidredirection(KURL _url)
Signal a redirection.
voidredirection(KURL oldUrl, KURL newUrl)
Signal a redirection.
voidrefreshItems(ArrayList items)
Signal an item to refresh (its mimetype/icon/name has changed).
voidspeed(int bytes_per_second)
Emitted to display information about the speed of the jobs.
voidstarted(KURL _url)
Tell the view that we started to list _url. NOTE: this does _not_ imply that there is really a job running!
voidtotalSize(long size)
Emitted when we know the size of the jobs.

Method Detail

canceled

public void canceled()
Tell the view that the user canceled the listing. No running jobs are left.

UNKNOWN: Tell the view that the user canceled the listing.

canceled

public void canceled(KURL _url)
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

UNKNOWN: Tell the view that the listing of the directory _url was canceled.

clear

public void clear()
Signal to clear all items. It must always be connected to this signal to avoid doubled items!

UNKNOWN: Signal to clear all items.

clear

public void clear(KURL _url)
Signal to empty the directory _url. It is only emitted if the lister is holding more than one directory.

Parameters: _url the directory that will be emptied

UNKNOWN: Signal to empty the directory _url.

completed

public void completed()
Tell the view that listing is finished. There are no jobs running anymore.

UNKNOWN: Tell the view that listing is finished.

completed

public void completed(KURL _url)
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

UNKNOWN: Tell the view that the listing of the directory _url is finished.

deleteItem

public void deleteItem(KFileItem _fileItem)
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.

Parameters: _fileItem the fileItem to delete

UNKNOWN: Signal an item to remove.

infoMessage

public void infoMessage(String msg)
Emitted to display information about running jobs. Examples of message are "Resolving host", "Connecting to host...", etc.

Parameters: msg the info message

UNKNOWN: Emitted to display information about running jobs.

itemsFilteredByMime

public void itemsFilteredByMime(ArrayList items)
Send a list of items filtered-out by mime-type.

Parameters: items the list of filtered items

UNKNOWN: Send a list of items filtered-out by mime-type.

newItems

public void newItems(ArrayList items)
Signal new items.

Parameters: items a list of new items

UNKNOWN: Signal new items.

percent

public void percent(int percent)
Progress signal showing the overall progress of the KDirLister. This allows using a progress bar very easily. (see KProgress)

Parameters: percent the progress in percent

UNKNOWN: Progress signal showing the overall progress of the KDirLister.

processedSize

public void processedSize(long size)
Regularly emitted to show the progress of this KDirLister.

Parameters: size the processed size in bytes

UNKNOWN: Regularly emitted to show the progress of this KDirLister.

redirection

public void redirection(KURL _url)
Signal a redirection. Only emitted if there's just one directory to list, i.e. most probably openURL() has been called with _keep == false.

Parameters: _url the new URL

UNKNOWN: Signal a redirection.

redirection

public void redirection(KURL oldUrl, KURL newUrl)
Signal a redirection.

Parameters: oldUrl the original URL newUrl the new URL

UNKNOWN: Signal a redirection.

refreshItems

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

Parameters: items the items to refresh

UNKNOWN: Signal an item to refresh (its mimetype/icon/name has changed).

speed

public void speed(int bytes_per_second)
Emitted to display information about the speed of the jobs.

Parameters: bytes_per_second the speed in bytes/s

UNKNOWN: Emitted to display information about the speed of the jobs.

started

public void started(KURL _url)
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.

Parameters: _url the URL to list

UNKNOWN: Tell the view that we started to list _url.

totalSize

public void totalSize(long size)
Emitted when we know the size of the jobs.

Parameters: size the total size in bytes

UNKNOWN: Emitted when we know the size of the jobs.