vcl/inc/jobset.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_INC_JOBSET_H
  21 #define INCLUDED_VCL_INC_JOBSET_H
  22
  23 #include <rtl/ustring.hxx>
  24 #include <i18nutil/paper.hxx>
  25 #include <vcl/dllapi.h>
  26 #include <vcl/prntypes.hxx>
  27 #include <unordered_map>
  28
  29 // see com.sun.star.portal.client.JobSetupSystem.idl:
  30 #define JOBSETUP_SYSTEM_WINDOWS     1
  31 #define JOBSETUP_SYSTEM_UNIX        3
  32 #define JOBSETUP_SYSTEM_MAC         4
  33
  34 class VCL_DLLPUBLIC ImplJobSetup
  35 {
  36 private:
  37     sal_uInt16      mnSystem;           //< System - JOBSETUP_SYSTEM_xxxx
  38     OUString        maPrinterName;      //< Printer-Name
  39     OUString        maDriver;           //< Driver-Name
  40     Orientation     meOrientation;      //< Orientation
  41     DuplexMode      meDuplexMode;       //< Duplex
  42     sal_uInt16      mnPaperBin;         //< paper bin / in tray
  43     Paper           mePaperFormat;      //< paper format
  44     tools::Long            mnPaperWidth;       //< paper width (100th mm)
  45     tools::Long            mnPaperHeight;      //< paper height (100th mm)
  46     sal_uInt32      mnDriverDataLen;    //< length of system specific data
  47     sal_uInt8*      mpDriverData;       //< system specific data (will be streamed a byte block)
  48     bool            mbPapersizeFromSetup;
  49     // setup mode
  50     PrinterSetupMode meSetupMode;
  51     // TODO: orig paper size
  52     std::unordered_map< OUString, OUString > maValueMap;
  53
  54 public:
  55     ImplJobSetup();
  56     ImplJobSetup( const ImplJobSetup& rJobSetup );
  57     ~ImplJobSetup();
  58
  59     bool operator==( const ImplJobSetup& rImplJobSetup ) const;
  60
  61     sal_uInt16       GetSystem() const { return mnSystem; }
  62     void             SetSystem(sal_uInt16 nSystem);
  63
  64     const OUString&  GetPrinterName() const { return maPrinterName; }
  65     void             SetPrinterName(const OUString& rPrinterName);
  66
  67     const OUString&  GetDriver() const { return maDriver; }
  68     void             SetDriver(const OUString& rDriver);
  69
  70     Orientation      GetOrientation() const { return meOrientation; }
  71     void             SetOrientation(Orientation eOrientation);
  72
  73     DuplexMode       GetDuplexMode() const { return meDuplexMode; }
  74     void             SetDuplexMode(DuplexMode eDuplexMode);
  75
  76     sal_uInt16       GetPaperBin() const { return mnPaperBin; }
  77     void             SetPaperBin(sal_uInt16 nPaperBin);
  78
  79     Paper            GetPaperFormat() const { return mePaperFormat; }
  80     void             SetPaperFormat(Paper ePaperFormat);
  81
  82     tools::Long             GetPaperWidth() const { return mnPaperWidth; }
  83     void             SetPaperWidth(tools::Long nWidth);
  84
  85     tools::Long             GetPaperHeight() const { return mnPaperHeight; }
  86     void             SetPaperHeight(tools::Long nHeight);
  87
  88     sal_uInt32       GetDriverDataLen() const { return mnDriverDataLen; }
  89     void             SetDriverDataLen(sal_uInt32 nDriverDataLen);
  90
  91     const sal_uInt8* GetDriverData() const { return mpDriverData; }
  92     void             SetDriverData(sal_uInt8* pDriverData);
  93
  94     bool             GetPapersizeFromSetup() const { return mbPapersizeFromSetup; }
  95     void             SetPapersizeFromSetup(bool bPapersizeFromSetup);
  96
  97     PrinterSetupMode GetPrinterSetupMode() const { return meSetupMode; }
  98     void             SetPrinterSetupMode(PrinterSetupMode eMode);
  99
 100     const std::unordered_map< OUString, OUString >& GetValueMap() const
 101                     { return maValueMap; }
 102     void            SetValueMap(const OUString& rKey, const OUString& rValue);
 103 };
 104
 105 // If paper format is PAPER_USER, in the system-independent part it will
 106 // automatically be computed from paper width/height.
 107 // If paper width/height is 0, in the system-independent part it will
 108 // automatically be computed from paper format, if the latter is not PAPER_USER.
 109
 110 #endif // INCLUDED_VCL_INC_JOBSET_H
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */