doc/src/qprinterinfo.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 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 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  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 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  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     Use the static functions to generate a list of QPrinterInfo
  49     objects. Each QPrinterInfo object in the list represents a single
  50     printer and can be queried for name, supported paper sizes, and
  51     whether or not it is the default printer.
  52
  53     \since 4.4
  54 */
  55
  56 /*!
  57     \fn QList<QPrinterInfo> QPrinterInfo::availablePrinters()
  58
  59     Returns a list of available printers on the system.
  60 */
  61
  62 /*!
  63     \fn QPrinterInfo QPrinterInfo::defaultPrinter()
  64
  65     Returns the default printer on the system.
  66
  67     The return value should be checked using isNull() before being
  68     used, in case there is no default printer.
  69
  70     \sa isNull()
  71 */
  72
  73 /*!
  74     \fn QPrinterInfo::QPrinterInfo()
  75
  76     Constructs an empty QPrinterInfo object.
  77
  78     \sa isNull()
  79 */
  80
  81 /*!
  82     \fn QPrinterInfo::QPrinterInfo(const QPrinterInfo& src)
  83
  84     Constructs a copy of \a src.
  85 */
  86
  87 /*!
  88     \fn QPrinterInfo::QPrinterInfo(const QPrinter& printer)
  89
  90     Constructs a QPrinterInfo object from \a printer.
  91 */
  92
  93 /*!
  94     \fn QPrinterInfo::~QPrinterInfo()
  95
  96     Destroys the QPrinterInfo object. References to the values in the
  97     object become invalid.
  98 */
  99
 100 /*!
 101     \fn QPrinterInfo& QPrinterInfo::operator=(const QPrinterInfo& src)
 102
 103     Sets the QPrinterInfo object to be equal to \a src.
 104 */
 105
 106 /*!
 107     \fn QString QPrinterInfo::printerName() const
 108
 109     Returns the name of the printer.
 110
 111     \sa QPrinter::setPrinterName()
 112 */
 113
 114 /*!
 115     \fn bool QPrinterInfo::isNull() const
 116
 117     Returns whether this QPrinterInfo object holds a printer definition.
 118
 119     An empty QPrinterInfo object could result for example from calling
 120     defaultPrinter() when there are no printers on the system.
 121 */
 122
 123 /*!
 124     \fn bool QPrinterInfo::isDefault() const
 125
 126     Returns whether this printer is the default printer.
 127 */
 128
 129 /*!
 130     \fn QList< QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes() const
 131     \since 4.4
 132
 133     Returns a list of supported paper sizes by the printer.
 134
 135     Not all printer drivers support this query, so the list may be empty.
 136     On Mac OS X 10.3, this function always returns an empty list.
 137 */