sw/inc/IDocumentDeviceAccess.hxx

   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_SW_INC_IDOCUMENTDEVICEACCESS_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTDEVICEACCESS_HXX
  22
  23 class SfxPrinter;
  24 class JobSetup;
  25 class SwPrintData;
  26 class VirtualDevice;
  27 class OutputDevice;
  28
  29 /** Provides access to the formatting devices of a document
  30  */
  31 class IDocumentDeviceAccess
  32 {
  33 public:
  34     /** Return the printer set at the document.
  35
  36        @param bCreate
  37        [in] if set, a printer will be created if not already done.
  38
  39        @returns
  40        the printer set at the document.
  41     */
  42     virtual SfxPrinter* getPrinter(/*[in]*/ bool bCreate) const = 0;
  43
  44     /** Set the printer at the document.
  45
  46        @param pP
  47        [in] the new printer or 0.
  48
  49        @param bDeleteOld
  50        [in] if set, the old printer will be deleted.
  51
  52        @param bCallPrtDataChanged
  53        [in] if set, triggers all necessary invalidations.
  54     */
  55     virtual void setPrinter(/*[in]*/ SfxPrinter* pP, /*[in]*/ bool bDeleteOld,
  56                             /*[in]*/ bool bCallPrtDataChanged)
  57         = 0;
  58
  59     /** Return the virtual device set at the document.
  60
  61        @param bCreate
  62        [in] if set, a virtual device will be created if not already done.
  63
  64        @returns
  65        the virtual device set at the document.
  66     */
  67     virtual VirtualDevice* getVirtualDevice(/*[in]*/ bool bCreate) const = 0;
  68
  69     /** Sets the current virtual device
  70
  71        @param pVd
  72        [in] the new virtual device.
  73
  74        The old virtual device will be deleted.
  75        Triggers all necessary invalidations.
  76      */
  77     virtual void setVirtualDevice(/*[in]*/ VirtualDevice* pVd) = 0;
  78
  79     /** Returns the current reference device
  80
  81        @param bCreate
  82        [in] if set, the reference device will be created if not already done.
  83
  84        @returns
  85        the current reference device
  86      */
  87     virtual OutputDevice* getReferenceDevice(/*[in]*/ bool bCreate) const = 0;
  88
  89     /** Sets the type of the reference device used for formatting the document
  90
  91        @param bNewVirtual
  92        [in] if set, the reference device will be a virtual device, otherwise
  93             the printer is used for formatting the document
  94
  95        @param bNewHiRes
  96        [in] if set, the virtual device will be the HiRes virtual device
  97      */
  98     virtual void setReferenceDeviceType(/*[in]*/ bool bNewVirtual, /*[in]*/ bool bNewHiRes) = 0;
  99
 100     /** Returns the Jobsetup
 101
 102        @returns
 103        the current Jobsetup
 104      */
 105     virtual const JobSetup* getJobsetup() const = 0;
 106
 107     /** Sets the Jobsetup
 108
 109        @param rJobSetup
 110        [in] the new Jobsetup.
 111      */
 112     virtual void setJobsetup(/*[in]*/ const JobSetup& rJobSetup) = 0;
 113
 114     /** Returns the PrintData
 115
 116        @returns
 117        the current PrintData
 118      */
 119     virtual const SwPrintData& getPrintData() const = 0;
 120
 121     /** Sets the PrintData
 122
 123        @param rPrtData
 124        [in] the new PrintData.
 125      */
 126     virtual void setPrintData(/*[in]*/ const SwPrintData& rPrtData) = 0;
 127
 128 protected:
 129     virtual ~IDocumentDeviceAccess(){};
 130 };
 131
 132 #endif // INCLUDED_SW_INC_IDOCUMENTDEVICEACCESS_HXX
 133
 134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */