kutils/kprintpreview.h

   1 /*
   2  *  This file is part of the KDE libraries
   3  *  Copyright (c) 2007 Alex Merry <alex.merry@kdemail.net>
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Library General Public
   7  *  License version 2 as published by the Free Software Foundation.
   8  *
   9  *  This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU Library General Public License
  15  *  along with this library; see the file COPYING.LIB.  If not, write to
  16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  *  Boston, MA 02110-1301, USA.
  18  **/
  19
  20 #ifndef KPRINTPREVIEW_H
  21 #define KPRINTPREVIEW_H
  22
  23 #include <kutils_export.h>
  24
  25 #include <kdialog.h>
  26
  27 class KPrintPreviewPrivate;
  28
  29 /**
  30  * KPrintPreview provides a print preview dialog.
  31  *
  32  * Use it like this:
  33  *
  34  * @code
  35  * QPrinter printer;
  36  * KPrintPreview preview(&printer);
  37  * doPrint(printer); // draws to the QPrinter
  38  * preview.exec();
  39  * @endcode
  40  */
  41 class KUTILS_EXPORT KPrintPreview : public KDialog
  42 {
  43     Q_OBJECT
  44
  45 public:
  46     /**
  47      * Create a KPrintPreview object.
  48      *
  49      * This will change the settings on the QPrinter, so you
  50      * should not re-use the QPrinter object for printing
  51      * normally.
  52      *
  53      * @param printer pointer to a QPrinter to configure for
  54      *                print preview
  55      * @param parent  pointer to the parent widget for the dialog
  56      */
  57     explicit KPrintPreview(QPrinter *printer, QWidget *parent = 0);
  58     virtual ~KPrintPreview();
  59
  60 protected:
  61     void showEvent(QShowEvent *event);
  62
  63 private:
  64     KPrintPreviewPrivate * const d;
  65 };
  66
  67
  68 #endif // KPRINTPREVIEW_H
  69