Differences

This shows you the differences between two versions of the page.

--- code:windows:progressdialog [2011/01/29 22:06] – created jmgr
+++ code:windows:progressdialog [2011/04/20 20:32] (current) – removed jmgr
@@ Line 1: / Line 1: @@
-====== ProgressDialog ======
-This object represents a window showing a progress bar.
-===== Functions =====
-==== ProgressDialog ====
-Constructor function.
-=== Syntax ===
-<code javascript>
-var myObject = new ProgressDialog();
-</code>
-<code javascript>
-var myObject = new ProgressDialog(parameters);
-</code>
-=== Arguments ===
-  - parameters - (object) window parameters
-    * title - (string) the window's title
-    * position - ([[code:core:point|Point]]) the window's position
-    * opacity - (float) the window's opacity
-    * enabled - (boolean) the window's enabled status
-    * visible - (boolean) the window's visible status
-    * value - (integer) the value
-    * labelText - (string) the label text
-    * minimum - (integer) the minimum value
-    * maximum - (integer) the maximum value
-    * range - (object) the range
-      * minimum - (integer) the minimum value
-      * maximum - (integer) the maximum value
-    * onCanceled - ([[#oncanceled|OnCanceled]]) event called when the window is canceled
-=== Exceptions ===
-  * (ParameterTypeError) incorrect parameter type
-  * (ParameterCountError) incorrect parameter count
-=== Example ===
-<code javascript>
-var myObject = new ProgressDialog();
-</code>
-<code javascript>
-var myObject = new ProgressDialog({
-	title: "Please wait",
-	value: 50
-});
-</code>
-===== Methods =====
-==== setTitle ====
-Sets the window's title.
-=== Syntax ===
-<code javascript>
-myObject.setTitle(title);
-</code>
-=== Arguments ===
-  - title - (string) the window's title
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setPosition ====
-Sets the window's position.
-=== Syntax ===
-<code javascript>
-myObject.setPosition(point);
-</code>
-=== Arguments ===
-  - point - ([[code:core:point|Point]]) the window's position
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setOpacity ====
-Sets the window's opacity.
-=== Syntax ===
-<code javascript>
-myObject.setOpacity(opacity);
-</code>
-=== Arguments ===
-  - opacity - (float) the window's opacity
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setEnabled ====
-Sets the window's enabled status.
-=== Syntax ===
-<code javascript>
-myObject.setEnabled(enabled);
-</code>
-=== Arguments ===
-  - enabled - (boolean) the window's enabled status
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setVisible ====
-Sets the window's visible status.
-=== Syntax ===
-<code javascript>
-myObject.setVisible(visible);
-</code>
-=== Arguments ===
-  - visible - (boolean) the window's visible status
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== close ====
-Closes the window.
-=== Syntax ===
-<code javascript>
-myObject.close();
-</code>
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== title ====
-Returns the window's title.
-=== Syntax ===
-<code javascript>
-myObject.title();
-</code>
-=== Returns ===
-  * (string) the window's title
-==== position ====
-Returns the window's position.
-=== Syntax ===
-<code javascript>
-myObject.position();
-</code>
-=== Returns ===
-  * ([[code:core:point|Point]]) the window's position
-==== opacity ====
-Returns the window's opacity.
-=== Syntax ===
-<code javascript>
-myObject.opacity();
-</code>
-=== Returns ===
-  * (float) the window's opacity
-==== enabled ====
-Returns the window's enabled status.
-=== Syntax ===
-<code javascript>
-myObject.enabled();
-</code>
-=== Returns ===
-  * (boolean) the window's enabled status
-==== visible ====
-Returns the window's visible status.
-=== Syntax ===
-<code javascript>
-myObject.visible();
-</code>
-=== Returns ===
-  * (boolean) the window's visible status
-==== setValue ====
-Sets the progress value.
-=== Syntax ===
-<code javascript>
-myObject.setValue(value);
-</code>
-=== Arguments ===
-  - value - (integer) the progress value
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setLabelText ====
-Sets the label text.
-=== Syntax ===
-<code javascript>
-myObject.setLabelText(labelText);
-</code>
-=== Arguments ===
-  - labelText - (string) the label text
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setMinimum ====
-Sets the minimum value.
-=== Syntax ===
-<code javascript>
-myObject.setMinimum(minimum);
-</code>
-=== Arguments ===
-  - minimum - (integer) the minimum value
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setMaximum ====
-Sets the maximum value.
-=== Syntax ===
-<code javascript>
-myObject.setMaximum(maximum);
-</code>
-=== Arguments ===
-  - maximum - (integer) the maximum value
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== setRange ====
-Sets the minimum and maximum value.
-=== Syntax ===
-<code javascript>
-myObject.setRange(minimum, maximum);
-</code>
-=== Arguments ===
-  - minimum - (integer) the minimum value
-  - maximum - (integer) the maximum value
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== show ====
-Show the window. (non-blocking)
-Use the [[#oncanceled|OnCanceled]] event to know when the window has been closed.
-=== Syntax ===
-<code javascript>
-myObject.show();
-</code>
-=== Returns ===
-  * (ProgressDialog) this ProgressDialog
-==== showModal ====
-Show the window. (blocking)
-=== Syntax ===
-<code javascript>
-myObject.showModal();
-</code>
-=== Returns ===
-  * (integer) the window result (0 means that it has been canceled)
-===== Events =====
-==== onCanceled ====
-Called when the window is canceled.
-=== Syntax ===
-<code javascript>
-myObject.onCanceled = function() {};
-</code>
-=== Example ===
-<code javascript>
-myObject.onCanceled = function()
-{
-	//Event action
-};
-</code>
-===== Attributes =====
-==== title ====
-The window's title. (string)
-==== position ====
-The window's position. ([[code:core:point|Point]])
-==== opacity ====
-The window's opacity. (float)
-==== enabled ====
-The window's enabled status. (boolean)
-==== value ====
-The progress bar's value. (integer)