org.kde.koala

Class KProgressDialog

public class KProgressDialog extends KDialogBase

KProgressDialog provides a dialog with a text label, a progress bar and an optional cancel button with a KDE look 'n feel. Since knowing how long it can take to complete an action and it is undesirable to show a dialog for a split second before hiding it, there are a few ways to control the timing behavior of KProgressDialog. There is a time out that can be set before showing the dialog as well as an option to autohide or keep displaying the dialog once complete. All the functionality of KProgress is available through direct access to the progress bar widget via progressBar();

Author: Aaron J. Seigo

UNKNOWN: A dialog with a progress bar.

Constructor Summary
protected KProgressDialog(Class dummy)
KProgressDialog(QWidget parent, String name, String caption, String text, boolean modal)
Constructs a KProgressDialog
KProgressDialog(QWidget parent, String name, String caption, String text)
KProgressDialog(QWidget parent, String name, String caption)
KProgressDialog(QWidget parent, String name)
KProgressDialog(QWidget parent)
KProgressDialog()
Method Summary
booleanallowCancel()
Returns true if the dialog can be canceled, false otherwise
booleanautoClose()
Returns true if the dialog will close upon completion, or false otherwise
booleanautoReset()
Returns true if the KProgress widget will be reset upon completion, or false otherwise
StringbuttonText()
Returns the text on the cancel button
StringclassName()
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
protected voidfinalize()
Deletes the wrapped C++ instance
booleanisDisposed()
Has the wrapped C++ instance been deleted?
StringlabelText()
Returns the current dialog text
QMetaObjectmetaObject()
intminimumDuration()
Returns the wait duration in milliseconds
KProgressprogressBar()
Returns the KProgress used in this dialog.
voidsetAllowCancel(boolean allowCancel)
Sets whether or not the user can cancel the process.
voidsetAutoClose(boolean close)
Sets whether the dialog should close automagically when all the steps in the KProgress have been completed.
voidsetAutoReset(boolean autoReset)
Sets whether the dialog should reset the KProgress dialog back to 0 steps compelete when all steps have been completed.
voidsetButtonText(String arg1)
Sets the text to appear on the cancel button.
voidsetLabel(String text)
Sets the text in the dialog
voidsetMinimumDuration(int ms)
Set the minimum number of milliseconds to wait before actually showing the dialog
voidshowCancelButton(boolean show)
Sets whether the cancel button is visible. setAllowCancel(false) implies showCancelButton(false)
protected voidslotAutoActions(int percentage)
protected voidslotAutoShow()
protected voidslotCancel()
booleanwasCancelled()
Returns true if the dialog was closed or canceled before completion.

Constructor Detail

KProgressDialog

protected KProgressDialog(Class dummy)

KProgressDialog

public KProgressDialog(QWidget parent, String name, String caption, String text, boolean modal)
Constructs a KProgressDialog

Parameters: parent Parent of the widget name Widget name caption Text to display in window title bar text Text to display in the dialog modal Set to true to make the dialog modal

UNKNOWN: Constructs a KProgressDialog

KProgressDialog

public KProgressDialog(QWidget parent, String name, String caption, String text)

KProgressDialog

public KProgressDialog(QWidget parent, String name, String caption)

KProgressDialog

public KProgressDialog(QWidget parent, String name)

KProgressDialog

public KProgressDialog(QWidget parent)

KProgressDialog

public KProgressDialog()

Method Detail

allowCancel

public boolean allowCancel()
Returns true if the dialog can be canceled, false otherwise

UNKNOWN: Returns true if the dialog can be canceled, false otherwise

autoClose

public boolean autoClose()
Returns true if the dialog will close upon completion, or false otherwise

UNKNOWN: Returns true if the dialog will close upon completion, or false otherwise

autoReset

public boolean autoReset()
Returns true if the KProgress widget will be reset upon completion, or false otherwise

UNKNOWN: Returns true if the KProgress widget will be reset upon completion, or false otherwise

buttonText

public String buttonText()
Returns the text on the cancel button

UNKNOWN: Returns the text on the cancel button

className

public String className()

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

finalize

protected void finalize()
Deletes the wrapped C++ instance

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

labelText

public String labelText()
Returns the current dialog text

UNKNOWN: Returns the current dialog text

metaObject

public QMetaObject metaObject()

minimumDuration

public int minimumDuration()
Returns the wait duration in milliseconds

UNKNOWN: Returns the wait duration in milliseconds

progressBar

public KProgress progressBar()
Returns the KProgress used in this dialog. To set the number of steps or other progress bar related settings, access the KProgress object directly via this method.

UNKNOWN: Returns the KProgress used in this dialog.

setAllowCancel

public void setAllowCancel(boolean allowCancel)
Sets whether or not the user can cancel the process. If the dialog is cancellable, the Cancel button will be shown and the user can close the window using the window decorations. If the process is not (or should not be) interuptable, set the dialog to be modal and not cancellable.

Parameters: allowCancel Set to true to make the dialog non-closable

UNKNOWN: Sets whether or not the user can cancel the process.

setAutoClose

public void setAutoClose(boolean close)
Sets whether the dialog should close automagically when all the steps in the KProgress have been completed.

UNKNOWN: Sets whether the dialog should close automagically when all the steps in the KProgress have been completed.

setAutoReset

public void setAutoReset(boolean autoReset)
Sets whether the dialog should reset the KProgress dialog back to 0 steps compelete when all steps have been completed. This is useful for KProgressDialogs that will be reused.

UNKNOWN: Sets whether the dialog should reset the KProgress dialog back to 0 steps compelete when all steps have been completed.

setButtonText

public void setButtonText(String arg1)
Sets the text to appear on the cancel button.

UNKNOWN: Sets the text to appear on the cancel button.

setLabel

public void setLabel(String text)
Sets the text in the dialog

Parameters: text the text to display

UNKNOWN: Sets the text in the dialog

setMinimumDuration

public void setMinimumDuration(int ms)
Set the minimum number of milliseconds to wait before actually showing the dialog

UNKNOWN: Set the minimum number of milliseconds to wait before actually showing the dialog

showCancelButton

public void showCancelButton(boolean show)
Sets whether the cancel button is visible. setAllowCancel(false) implies showCancelButton(false)

Parameters: show Whether or not the cancel button should be shown

UNKNOWN: Sets whether the cancel button is visible.

slotAutoActions

protected void slotAutoActions(int percentage)

slotAutoShow

protected void slotAutoShow()

slotCancel

protected void slotCancel()

wasCancelled

public boolean wasCancelled()
Returns true if the dialog was closed or canceled before completion. If the dialog is not cancellable it will always return false.

UNKNOWN: Returns true if the dialog was closed or canceled before completion.