| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** All rights reserved.
|
|---|
| 5 | ** Contact: Nokia Corporation (qt-info@nokia.com)
|
|---|
| 6 | **
|
|---|
| 7 | ** This file is part of the documentation of the Qt Toolkit.
|
|---|
| 8 | **
|
|---|
| 9 | ** $QT_BEGIN_LICENSE:FDL$
|
|---|
| 10 | ** Commercial Usage
|
|---|
| 11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 12 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 13 | ** Software or, alternatively, in accordance with the terms contained in a
|
|---|
| 14 | ** written agreement between you and Nokia.
|
|---|
| 15 | **
|
|---|
| 16 | ** GNU Free Documentation License
|
|---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Free
|
|---|
| 18 | ** Documentation License version 1.3 as published by the Free Software
|
|---|
| 19 | ** Foundation and appearing in the file included in the packaging of this
|
|---|
| 20 | ** file.
|
|---|
| 21 | **
|
|---|
| 22 | ** If you have questions regarding the use of this file, please contact
|
|---|
| 23 | ** Nokia at qt-info@nokia.com.
|
|---|
| 24 | ** $QT_END_LICENSE$
|
|---|
| 25 | **
|
|---|
| 26 | ****************************************************************************/
|
|---|
| 27 |
|
|---|
| 28 | /*!
|
|---|
| 29 | \class QPrinterInfo
|
|---|
| 30 |
|
|---|
| 31 | \brief The QPrinterInfo class gives access to information about
|
|---|
| 32 | existing printers.
|
|---|
| 33 |
|
|---|
| 34 | \ingroup printing
|
|---|
| 35 |
|
|---|
| 36 | Use the static functions to generate a list of QPrinterInfo
|
|---|
| 37 | objects. Each QPrinterInfo object in the list represents a single
|
|---|
| 38 | printer and can be queried for name, supported paper sizes, and
|
|---|
| 39 | whether or not it is the default printer.
|
|---|
| 40 |
|
|---|
| 41 | \since 4.4
|
|---|
| 42 | */
|
|---|
| 43 |
|
|---|
| 44 | /*!
|
|---|
| 45 | \fn QList<QPrinterInfo> QPrinterInfo::availablePrinters()
|
|---|
| 46 |
|
|---|
| 47 | Returns a list of available printers on the system.
|
|---|
| 48 | */
|
|---|
| 49 |
|
|---|
| 50 | /*!
|
|---|
| 51 | \fn QPrinterInfo QPrinterInfo::defaultPrinter()
|
|---|
| 52 |
|
|---|
| 53 | Returns the default printer on the system.
|
|---|
| 54 |
|
|---|
| 55 | The return value should be checked using isNull() before being
|
|---|
| 56 | used, in case there is no default printer.
|
|---|
| 57 |
|
|---|
| 58 | \sa isNull()
|
|---|
| 59 | */
|
|---|
| 60 |
|
|---|
| 61 | /*!
|
|---|
| 62 | \fn QPrinterInfo::QPrinterInfo()
|
|---|
| 63 |
|
|---|
| 64 | Constructs an empty QPrinterInfo object.
|
|---|
| 65 |
|
|---|
| 66 | \sa isNull()
|
|---|
| 67 | */
|
|---|
| 68 |
|
|---|
| 69 | /*!
|
|---|
| 70 | \fn QPrinterInfo::QPrinterInfo(const QPrinterInfo& src)
|
|---|
| 71 |
|
|---|
| 72 | Constructs a copy of \a src.
|
|---|
| 73 | */
|
|---|
| 74 |
|
|---|
| 75 | /*!
|
|---|
| 76 | \fn QPrinterInfo::QPrinterInfo(const QPrinter& printer)
|
|---|
| 77 |
|
|---|
| 78 | Constructs a QPrinterInfo object from \a printer.
|
|---|
| 79 | */
|
|---|
| 80 |
|
|---|
| 81 | /*!
|
|---|
| 82 | \fn QPrinterInfo::~QPrinterInfo()
|
|---|
| 83 |
|
|---|
| 84 | Destroys the QPrinterInfo object. References to the values in the
|
|---|
| 85 | object become invalid.
|
|---|
| 86 | */
|
|---|
| 87 |
|
|---|
| 88 | /*!
|
|---|
| 89 | \fn QPrinterInfo& QPrinterInfo::operator=(const QPrinterInfo& src)
|
|---|
| 90 |
|
|---|
| 91 | Sets the QPrinterInfo object to be equal to \a src.
|
|---|
| 92 | */
|
|---|
| 93 |
|
|---|
| 94 | /*!
|
|---|
| 95 | \fn QString QPrinterInfo::printerName() const
|
|---|
| 96 |
|
|---|
| 97 | Returns the name of the printer.
|
|---|
| 98 |
|
|---|
| 99 | \sa QPrinter::setPrinterName()
|
|---|
| 100 | */
|
|---|
| 101 |
|
|---|
| 102 | /*!
|
|---|
| 103 | \fn bool QPrinterInfo::isNull() const
|
|---|
| 104 |
|
|---|
| 105 | Returns whether this QPrinterInfo object holds a printer definition.
|
|---|
| 106 |
|
|---|
| 107 | An empty QPrinterInfo object could result for example from calling
|
|---|
| 108 | defaultPrinter() when there are no printers on the system.
|
|---|
| 109 | */
|
|---|
| 110 |
|
|---|
| 111 | /*!
|
|---|
| 112 | \fn bool QPrinterInfo::isDefault() const
|
|---|
| 113 |
|
|---|
| 114 | Returns whether this printer is the default printer.
|
|---|
| 115 | */
|
|---|
| 116 |
|
|---|
| 117 | /*!
|
|---|
| 118 | \fn QList< QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes() const
|
|---|
| 119 | \since 4.4
|
|---|
| 120 |
|
|---|
| 121 | Returns a list of supported paper sizes by the printer.
|
|---|
| 122 |
|
|---|
| 123 | Not all printer drivers support this query, so the list may be empty.
|
|---|
| 124 | On Mac OS X 10.3, this function always returns an empty list.
|
|---|
| 125 | */
|
|---|
