root/dwt/printing/PrinterData.d

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwt.printing.PrinterData;


import dwt.graphics.DeviceData;

import tango.text.convert.Format;
import dwt.dwthelper.utils;

/**
 * Instances of this class are descriptions of a print job
 * in terms of the printer, and the scope and type of printing
 * that is desired. For example, the number of pages and copies
 * can be specified, as well as whether or not the print job
 * should go to a file.
 * <p>
 * Application code does <em>not</em> need to explicitly release the
 * resources managed by each instance when those instances are no longer
 * required, and thus no <code>dispose()</code> method is provided.
 * </p>
 *
 * @see Printer
 * @see Printer#getPrinterList
 * @see PrintDialog#open
 * @see <a href="http://www.eclipse.org/swt/snippets/#printing">Printing snippets</a>
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 */

public final class PrinterData : DeviceData {

    /**
     * the printer driver
     * On Windows systems, this is the name of the driver (often "winspool").
     * On Mac OSX, this is the destination type ("Printer", "Fax", "File", or "Preview").
     * On X/Window systems, this is the name of a display connection to the
     * Xprt server (the default is ":1").
     * On GTK+, this is the backend type name (eg. GtkPrintBackendCups).
     */
    // TODO: note that this api is not finalized for GTK+
    public String driver;

    /**
     * the name of the printer
     * On Windows systems, this is the name of the 'device'.
     * On Mac OSX, X/Window systems, and GTK+, this is the printer's 'name'.
     */
    public String name;

    /**
     * the scope of the print job, expressed as one of the following values:
     * <dl>
     * <dt><code>ALL_PAGES</code></dt>
     * <dd>Print all pages in the current document</dd>
     * <dt><code>PAGE_RANGE</code></dt>
     * <dd>Print the range of pages specified by startPage and endPage</dd>
     * <dt><code>SELECTION</code></dt>
     * <dd>Print the current selection</dd>
     * </dl>
     */
    public int scope_ = ALL_PAGES;

    /**
     * the start page of a page range, used when scope is PAGE_RANGE.
     * This value can be from 1 to the maximum number of pages for the platform.
     */
    public int startPage = 0;

    /**
     * the end page of a page range, used when scope is PAGE_RANGE.
     * This value can be from 1 to the maximum number of pages for the platform.
     */
    public int endPage = 0;

    /**
     * whether or not the print job should go to a file
     */
    public bool printToFile = false;

    /**
     * the name of the file to print to if printToFile is true.
     * Note that this field is ignored if printToFile is false.
     */
    public String fileName;

    /**
     * the number of copies to print.
     * Note that this field may be controlled by the printer driver
     * In other words, the printer itself may be capable of printing
     * multiple copies, and if so, the value of this field will always be 1.
     */
    public int copyCount = 1;

    /**
     * whether or not the printer should collate the printed paper
     * Note that this field may be controlled by the printer driver.
     * In other words, the printer itself may be capable of doing the
     * collation, and if so, the value of this field will always be false.
     */
    public bool collate = false;

    /**
     * <code>scope</code> field value indicating that
     * all pages should be printed
     */
    public static const int ALL_PAGES = 0;

    /**
     * <code>scope</code> field value indicating that
     * the range of pages specified by startPage and endPage
     * should be printed
     */
    public static const int PAGE_RANGE = 1;

    /**
     * <code>scope</code> field value indicating that
     * the current selection should be printed
     */
    public static const int SELECTION = 2;

    /**
     * private, platform-specific data
     * On Windows, this contains a copy of the DEVMODE struct
     * returned from the <code>PrintDialog</code>.
     * On GTK, this contains a copy of the print_settings and page_setup
     * returned from the <code>PrintDialog</code>.
     * On OS X Carbon, this contains a copy of the PrintSettings and PageFormat
     * returned from the <code>PrintDialog</code>.
     * This field is not currently used on the X/Window System.
     */
    byte [] otherData;

    /**
     * Constructs an instance of this class that can be
     * used to print to the default printer.
     *
     * @see Printer#getDefaultPrinterData
     */
    public this() {
    }

    /**
     * Constructs an instance of this class with the given
     * printer driver and printer name.
     *
     * @param driver the printer driver for the printer
     * @param name the name of the printer
     *
     * @see #driver
     * @see #name
     */
    public this(String driver, String name) {
        this.driver = driver;
        this.name = name;
    }

    /**
     * Returns a string containing a concise, human-readable
     * description of the receiver.
     *
     * @return a string representation of the receiver
     */
    public String toString() {
        return Format("PrinterData {{driver = {}, name = {}}", driver, name );  //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
    }
}