kprinter.h

/*
 *  This file is part of the KDE libraries
 *  Copyright (c) 2001 Michael Goffioul <tdeprint@swing.be>
 *
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License version 2 as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/
 
#ifndef KPRINTER_H
#define KPRINTER_H
 
#include <tqpaintdevice.h>
#include <tqprinter.h>
#include <tqmap.h>
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
#include <tdemacros.h>
#include <tdelibs_export.h>
 
#include <tdeprint/kpreloadobject.h>
 
class KPrinterImpl;
class KPrintDialogPage;
class KPrinterPrivate;
class DrPageSize;
 
class TDEPRINT_EXPORT KPrinter : public TQPaintDevice, public KPReloadObject
{
friend class KPrinterWrapper;
friend class KPrinterImpl;
public:
    // Print global settings (set via static functions)
    enum StandardPageType { CopiesPage = 0x01, FilesPage = 0x02, Custom = 0x10 };
    enum PageSelectionType { ApplicationSide = 0x01, SystemSide = 0x02 };
    enum ApplicationType { Dialog = 0x00, StandAlone = 0x01, StandAlonePersistent = 0x02 };
 
    // TQPrinter extension
    enum PageSetType { AllPages = 0x00, OddPages = 0x01, EvenPages = 0x02 };
    enum CollateType { Collate = 0x00, Uncollate = 0x01 };
 
    // from TQPrinter class
    enum ColorMode { GrayScale = TQPrinter::GrayScale, Color = TQPrinter::Color };
    enum Orientation { Portrait = TQPrinter::Portrait, Landscape = TQPrinter::Landscape };
    enum PageOrder { FirstPageFirst = TQPrinter::FirstPageFirst, LastPageFirst = TQPrinter::LastPageFirst };
    enum PageSize
    {
        A4 = TQPrinter::A4,
        B5 = TQPrinter::B5,
        Letter = TQPrinter::Letter,
        Legal = TQPrinter::Legal,
        Executive = TQPrinter::Executive,
        A0 = TQPrinter::A0,
        A1 = TQPrinter::A1,
        A2 = TQPrinter::A2,
        A3 = TQPrinter::A3,
        A5 = TQPrinter::A5,
        A6 = TQPrinter::A6,
        A7 = TQPrinter::A7,
        A8 = TQPrinter::A8,
        A9 = TQPrinter::A9,
        B0 = TQPrinter::B0,
        B1 = TQPrinter::B1,
        B10 = TQPrinter::B10,
        B2 = TQPrinter::B2,
        B3 = TQPrinter::B3,
        B4 = TQPrinter::B4,
        B6 = TQPrinter::B6,
        B7 = TQPrinter::B7,
        B8 = TQPrinter::B8,
        B9 = TQPrinter::B9,
        C5E = TQPrinter::C5E,
        Comm10E = TQPrinter::Comm10E,
        DLE = TQPrinter::DLE,
        Folio = TQPrinter::Folio,
        Ledger = TQPrinter::Ledger,
        Tabloid = TQPrinter::Tabloid,
        NPageSize = TQPrinter::NPageSize
    };
 
    // constructors / destructor
    KPrinter(bool restore = true, TQPrinter::PrinterMode m = TQPrinter::ScreenResolution );
    ~KPrinter();
 
    // TQPrinter interface (+ some extensions)
    bool newPage();
    bool abort();
    bool aborted() const;
    bool outputToFile() const;
    void setOutputToFile(bool);
    TQString outputFileName() const;
    void setOutputFileName(const TQString&);
    TQString docName() const;
    void setDocName(const TQString&);
    TQString creator() const;
    void setCreator(const TQString&);
    bool fullPage() const;
    void setFullPage(bool);
    ColorMode colorMode() const;
    void setColorMode(ColorMode);
    int numCopies() const;
    void setNumCopies(int n);
    Orientation orientation() const;
    void setOrientation(Orientation, bool locking = false);
    PageOrder pageOrder() const;
    void setPageOrder(PageOrder);
    CollateType collate() const;
    void setCollate(CollateType type);
    int minPage() const;
    int maxPage() const;
    void setMinMax(int, int);
    int fromPage() const TDE_DEPRECATED;
    int toPage() const;
    void setFromTo(int, int);
    PageSize pageSize() const;
    void setPageSize(PageSize, bool locking = false);
    TQString printerName() const;
    void setPrinterName(const TQString&);
    TQString printProgram() const;
    void setPrintProgram(const TQString& cmd);
    TQString printerSelectionOption() const;
    void setPrinterSelectionOption(const TQString&);
    int currentPage() const;
    void setCurrentPage(int p = 0);
    PageSetType pageSet() const;
    bool setup(TQWidget *parent = 0, const TQString& caption = TQString::null, bool forceExpand = false);
    TQSize margins() const;
    void setMargins(TQSize m);
    TQSize realPageSize() const;
    void setRealPageSize( TQSize p );
    void setRealDrawableArea( const TQRect& r );
    TQRect realDrawableArea() const;
 
    void margins( uint *top, uint *left, uint *bottom, uint *right ) const;
    void setMargins( uint top, uint left, uint bottom, uint right );
 
    TQValueList<int> pageList() const;
    void setPreviewOnly(bool on);
    bool previewOnly() const;
    void setResolution(int dpi);
    int resolution() const;
 
    void setUsePrinterResolution( bool on );
 
    KPrinterImpl* implementation() const;
    bool printFiles(const TQStringList& files, bool removeafter = false, bool startviewer = true);
 
    static void addDialogPage(KPrintDialogPage* _page);
    static void setPageSelection(PageSelectionType _mode);
    static PageSelectionType pageSelection();
    static void setApplicationType(ApplicationType type);
    static ApplicationType applicationType();
    static void addStandardPage(int p);
    static void removeStandardPage(int p);
    //static int addPrinterWizard(TQWidget *parent = 0);
 
    const TQString& option(const TQString& key) const;
    void setOption(const TQString& key, const TQString& value);
    const TQMap<TQString,TQString>& options() const;
    void setOptions(const TQMap<TQString,TQString>& opts);
    void initOptions(const TQMap<TQString,TQString>& opts);
 
    TQString searchName() const;
    void setSearchName(const TQString& n);
    TQString errorMessage() const;
    void setErrorMessage(const TQString& msg);
    bool autoConfigure(const TQString& prname = TQString::null, TQWidget *parent = 0);
    void setDocFileName(const TQString& filename);
    TQString docFileName() const;
    void setDocDirectory( const TQString& dir );
    TQString docDirectory() const;
 
protected:
    virtual bool cmd(int, TQPainter*, TQPDevCmdParam*);
    virtual int metric(int) const;
    void translateQtOptions();
    void loadSettings();
    void saveSettings();
    void preparePrinting();
    void finishPrinting();
    void reload();
    void init(bool restore = true, TQPrinter::PrinterMode m = TQPrinter::ScreenResolution);
    bool doPreview(const TQString& file);
    void setRealPageSize(DrPageSize* p);
    void setOption( const TQString& key, const TQString& value, bool broadcast );
 
protected:
    KPrinterPrivate     *d;
};
 
//**************************************************************************************
 
// Utility functions
 
TDEPRINT_EXPORT KPrinter::PageSize pageNameToPageSize(const TQString& name);
TDEPRINT_EXPORT const char* pageSizeToPageName(KPrinter::PageSize s);
TQSize rangeToSize( const TQString& );
 
#endif