summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2009-05-27 19:05:21 +0000
committerCarolyn MacLeod <carolyn>2009-05-27 19:05:21 +0000
commit252fa34277ec96231d89bbba1b2222a71f04f4b5 (patch)
treed1ab9d844a8f24e69ec7c33d43992143e4825371 /bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java
parent0e9de50affb69f2c41b7aaf179af3432f3658daf (diff)
downloadeclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.tar.gz
eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.tar.xz
eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.zip
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java10
1 files changed, 8 insertions, 2 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java b/bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java
index cc22a599be..2118f08233 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Printing/emulated/org/eclipse/swt/printing/PrintDialog.java
@@ -27,6 +27,7 @@ import org.eclipse.swt.widgets.*;
* @see <a href="http://www.eclipse.org/swt/snippets/#printing">Printing snippets</a>
* @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a>
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
+ * @noextend This class is not intended to be subclassed by clients.
*/
public class PrintDialog extends Dialog {
PrinterData printerData;
@@ -102,8 +103,12 @@ static int checkStyle (Shell parent, int style) {
/**
* Sets the printer data that will be used when the dialog
* is opened.
+ * <p>
+ * Setting the printer data to null is equivalent to
+ * resetting all data fields to their default values.
+ * </p>
*
- * @param data the data that will be used when the dialog is opened
+ * @param data the data that will be used when the dialog is opened or null to use default data
*
* @since 3.4
*/
@@ -249,7 +254,8 @@ protected void checkSubclass() {
* Makes the receiver visible and brings it to the front
* of the display.
*
- * @return a printer data object describing the desired print job parameters
+ * @return a printer data object describing the desired print job parameters,
+ * or null if the dialog was canceled, no printers were found, or an error occurred
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>