org.kde.koala

Interface ReadOnlyPartSignals

public interface ReadOnlyPartSignals

Method Summary
voidcanceled(String errMsg)
Emit this if loading is canceled by the user or by an error.
voidcompleted()
Emit this when you have completed loading data.
voidcompleted(boolean pendingAction)
Same as the above signal except it indicates whether there is a pending action to be executed on a delay timer.
voidstarted(Job arg1)
The part emits this when starting data.

Method Detail

canceled

public void canceled(String errMsg)
Emit this if loading is canceled by the user or by an error.

Parameters: errMsg the error message, empty if the user canceled the loading voluntarily.

UNKNOWN: Emit this if loading is canceled by the user or by an error.

completed

public void completed()
Emit this when you have completed loading data. Hosting apps will want to know when the process of loading the data is finished, so that they can access the data when everything is loaded.

UNKNOWN: Emit this when you have completed loading data.

completed

public void completed(boolean pendingAction)
Same as the above signal except it indicates whether there is a pending action to be executed on a delay timer. An example of this is the meta-refresh tags on web pages used to reload/redirect after a certain period of time. This signal is useful if you want to give the user the ability to cancel such pending actions.

Parameters: pendingAction true if a pending action exists, false otherwise.

UNKNOWN: Same as the above signal except it indicates whether there is a pending action to be executed on a delay timer.

started

public void started(Job arg1)
The part emits this when starting data. If using a KIO.Job, it sets the job in the signal, so that progress information can be shown. Otherwise, job is 0.

UNKNOWN: The part emits this when starting data.