| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2010 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:LGPL$
|
|---|
| 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
|
|---|
| 14 | ** a written agreement between you and Nokia.
|
|---|
| 15 | **
|
|---|
| 16 | ** GNU Lesser General Public License Usage
|
|---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
|---|
| 18 | ** General Public License version 2.1 as published by the Free Software
|
|---|
| 19 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
|---|
| 20 | ** packaging of this file. Please review the following information to
|
|---|
| 21 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
|---|
| 22 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|---|
| 23 | **
|
|---|
| 24 | ** In addition, as a special exception, Nokia gives you certain additional
|
|---|
| 25 | ** rights. These rights are described in the Nokia Qt LGPL Exception
|
|---|
| 26 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|---|
| 27 | **
|
|---|
| 28 | ** GNU General Public License Usage
|
|---|
| 29 | ** Alternatively, this file may be used under the terms of the GNU
|
|---|
| 30 | ** General Public License version 3.0 as published by the Free Software
|
|---|
| 31 | ** Foundation and appearing in the file LICENSE.GPL included in the
|
|---|
| 32 | ** packaging of this file. Please review the following information to
|
|---|
| 33 | ** ensure the GNU General Public License version 3.0 requirements will be
|
|---|
| 34 | ** met: http://www.gnu.org/copyleft/gpl.html.
|
|---|
| 35 | **
|
|---|
| 36 | ** If you have questions regarding the use of this file, please contact
|
|---|
| 37 | ** Nokia at qt-info@nokia.com.
|
|---|
| 38 | ** $QT_END_LICENSE$
|
|---|
| 39 | **
|
|---|
| 40 | ****************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | /*!
|
|---|
| 43 | \class QPrinterInfo
|
|---|
| 44 |
|
|---|
| 45 | \brief The QPrinterInfo class gives access to information about
|
|---|
| 46 | existing printers.
|
|---|
| 47 |
|
|---|
| 48 | \ingroup printing
|
|---|
| 49 |
|
|---|
| 50 | Use the static functions to generate a list of QPrinterInfo
|
|---|
| 51 | objects. Each QPrinterInfo object in the list represents a single
|
|---|
| 52 | printer and can be queried for name, supported paper sizes, and
|
|---|
| 53 | whether or not it is the default printer.
|
|---|
| 54 |
|
|---|
| 55 | \since 4.4
|
|---|
| 56 | */
|
|---|
| 57 |
|
|---|
| 58 | /*!
|
|---|
| 59 | \fn QList<QPrinterInfo> QPrinterInfo::availablePrinters()
|
|---|
| 60 |
|
|---|
| 61 | Returns a list of available printers on the system.
|
|---|
| 62 | */
|
|---|
| 63 |
|
|---|
| 64 | /*!
|
|---|
| 65 | \fn QPrinterInfo QPrinterInfo::defaultPrinter()
|
|---|
| 66 |
|
|---|
| 67 | Returns the default printer on the system.
|
|---|
| 68 |
|
|---|
| 69 | The return value should be checked using isNull() before being
|
|---|
| 70 | used, in case there is no default printer.
|
|---|
| 71 |
|
|---|
| 72 | \sa isNull()
|
|---|
| 73 | */
|
|---|
| 74 |
|
|---|
| 75 | /*!
|
|---|
| 76 | \fn QPrinterInfo::QPrinterInfo()
|
|---|
| 77 |
|
|---|
| 78 | Constructs an empty QPrinterInfo object.
|
|---|
| 79 |
|
|---|
| 80 | \sa isNull()
|
|---|
| 81 | */
|
|---|
| 82 |
|
|---|
| 83 | /*!
|
|---|
| 84 | \fn QPrinterInfo::QPrinterInfo(const QPrinterInfo& src)
|
|---|
| 85 |
|
|---|
| 86 | Constructs a copy of \a src.
|
|---|
| 87 | */
|
|---|
| 88 |
|
|---|
| 89 | /*!
|
|---|
| 90 | \fn QPrinterInfo::QPrinterInfo(const QPrinter& printer)
|
|---|
| 91 |
|
|---|
| 92 | Constructs a QPrinterInfo object from \a printer.
|
|---|
| 93 | */
|
|---|
| 94 |
|
|---|
| 95 | /*!
|
|---|
| 96 | \fn QPrinterInfo::~QPrinterInfo()
|
|---|
| 97 |
|
|---|
| 98 | Destroys the QPrinterInfo object. References to the values in the
|
|---|
| 99 | object become invalid.
|
|---|
| 100 | */
|
|---|
| 101 |
|
|---|
| 102 | /*!
|
|---|
| 103 | \fn QPrinterInfo& QPrinterInfo::operator=(const QPrinterInfo& src)
|
|---|
| 104 |
|
|---|
| 105 | Sets the QPrinterInfo object to be equal to \a src.
|
|---|
| 106 | */
|
|---|
| 107 |
|
|---|
| 108 | /*!
|
|---|
| 109 | \fn QString QPrinterInfo::printerName() const
|
|---|
| 110 |
|
|---|
| 111 | Returns the name of the printer.
|
|---|
| 112 |
|
|---|
| 113 | \sa QPrinter::setPrinterName()
|
|---|
| 114 | */
|
|---|
| 115 |
|
|---|
| 116 | /*!
|
|---|
| 117 | \fn bool QPrinterInfo::isNull() const
|
|---|
| 118 |
|
|---|
| 119 | Returns whether this QPrinterInfo object holds a printer definition.
|
|---|
| 120 |
|
|---|
| 121 | An empty QPrinterInfo object could result for example from calling
|
|---|
| 122 | defaultPrinter() when there are no printers on the system.
|
|---|
| 123 | */
|
|---|
| 124 |
|
|---|
| 125 | /*!
|
|---|
| 126 | \fn bool QPrinterInfo::isDefault() const
|
|---|
| 127 |
|
|---|
| 128 | Returns whether this printer is the default printer.
|
|---|
| 129 | */
|
|---|
| 130 |
|
|---|
| 131 | /*!
|
|---|
| 132 | \fn QList< QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes() const
|
|---|
| 133 | \since 4.4
|
|---|
| 134 |
|
|---|
| 135 | Returns a list of supported paper sizes by the printer.
|
|---|
| 136 |
|
|---|
| 137 | Not all printer drivers support this query, so the list may be empty.
|
|---|
| 138 | On Mac OS X 10.3, this function always returns an empty list.
|
|---|
| 139 | */
|
|---|
