src/gui/painting/qprinterinfo.qdoc
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/painting/qprinterinfo.qdoc	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,139 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \class QPrinterInfo
+
+    \brief The QPrinterInfo class gives access to information about
+    existing printers.
+    
+    \ingroup printing
+
+    Use the static functions to generate a list of QPrinterInfo
+    objects. Each QPrinterInfo object in the list represents a single
+    printer and can be queried for name, supported paper sizes, and
+    whether or not it is the default printer.
+
+    \since 4.4
+*/
+
+/*!
+    \fn QList<QPrinterInfo> QPrinterInfo::availablePrinters()
+
+    Returns a list of available printers on the system.
+*/
+
+/*!
+    \fn QPrinterInfo QPrinterInfo::defaultPrinter()
+
+    Returns the default printer on the system.
+
+    The return value should be checked using isNull() before being
+    used, in case there is no default printer.
+
+    \sa isNull()
+*/
+
+/*!
+    \fn QPrinterInfo::QPrinterInfo()
+
+    Constructs an empty QPrinterInfo object.
+
+    \sa isNull()
+*/
+
+/*!
+    \fn QPrinterInfo::QPrinterInfo(const QPrinterInfo& src)
+
+    Constructs a copy of \a src.
+*/
+
+/*!
+    \fn QPrinterInfo::QPrinterInfo(const QPrinter& printer)
+
+    Constructs a QPrinterInfo object from \a printer.
+*/
+
+/*!
+    \fn QPrinterInfo::~QPrinterInfo()
+
+    Destroys the QPrinterInfo object. References to the values in the
+    object become invalid.
+*/
+
+/*!
+    \fn QPrinterInfo& QPrinterInfo::operator=(const QPrinterInfo& src)
+
+    Sets the QPrinterInfo object to be equal to \a src.
+*/
+
+/*!
+    \fn QString QPrinterInfo::printerName() const
+
+    Returns the name of the printer.
+
+    \sa QPrinter::setPrinterName()
+*/
+
+/*!
+    \fn bool QPrinterInfo::isNull() const
+
+    Returns whether this QPrinterInfo object holds a printer definition.
+
+    An empty QPrinterInfo object could result for example from calling
+    defaultPrinter() when there are no printers on the system.
+*/
+
+/*!
+    \fn bool QPrinterInfo::isDefault() const
+
+    Returns whether this printer is the default printer.
+*/
+
+/*!
+    \fn QList< QPrinter::PaperSize> QPrinterInfo::supportedPaperSizes() const
+    \since 4.4
+
+    Returns a list of supported paper sizes by the printer.
+
+    Not all printer drivers support this query, so the list may be empty.
+    On Mac OS X 10.3, this function always returns an empty list.
+*/