include/svx/sdrpaintwindow.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_SVX_SDRPAINTWINDOW_HXX
  21 #define INCLUDED_SVX_SDRPAINTWINDOW_HXX
  22
  23 #include <rtl/ref.hxx>
  24 #include <vcl/virdev.hxx>
  25 #include <svx/svxdllapi.h>
  26 #include <memory>
  27
  28 class SdrPaintView;
  29
  30 namespace sdr
  31 {
  32     namespace overlay
  33     {
  34         class OverlayManager;
  35     }
  36 }
  37
  38 #ifdef _MSC_VER // broken msvc template instantiation
  39 #include <svx/sdr/overlay/overlaymanager.hxx>
  40 #endif
  41
  42 /// paint the transparent children of rWin that overlap rPixelRect
  43 /// (for example, transparent form controls like check boxes)
  44 void SVX_DLLPUBLIC
  45 PaintTransparentChildren(vcl::Window const & rWindow, tools::Rectangle const& rPixelRect);
  46
  47 class SdrPreRenderDevice
  48 {
  49     // The original OutputDevice
  50     VclPtr<OutputDevice>   mpOutputDevice;
  51
  52     // The VirtualDevice for PreRendering
  53     VclPtr<VirtualDevice>  mpPreRenderDevice;
  54
  55 public:
  56     explicit SdrPreRenderDevice(OutputDevice& rOriginal);
  57     ~SdrPreRenderDevice();
  58
  59     void PreparePreRenderDevice();
  60     void OutputPreRenderDevice(const vcl::Region& rExpandedRegion);
  61
  62     OutputDevice& GetPreRenderDevice() { return *mpPreRenderDevice; }
  63 };
  64
  65 class SVX_DLLPUBLIC SdrPaintWindow
  66 {
  67 private:
  68     // the OutputDevice this window represents
  69     VclPtr<OutputDevice>                                mpOutputDevice;
  70
  71     /// In case mrOutputDevice is a buffer for a vcl::Window, this is the window.
  72     VclPtr<vcl::Window>                                 mpWindow;
  73
  74     // the SdrPaintView this window belongs to
  75     SdrPaintView&                                       mrPaintView;
  76
  77     // the new OverlayManager for the new OverlayObjects. Test add here, will
  78     // replace the IAOManager as soon as it works.
  79     rtl::Reference< sdr::overlay::OverlayManager >    mxOverlayManager;
  80
  81     // The PreRenderDevice for PreRendering
  82     std::unique_ptr<SdrPreRenderDevice>               mpPreRenderDevice;
  83
  84     // The RedrawRegion used for rendering
  85     vcl::Region                                              maRedrawRegion;
  86
  87     // #i72889# flag if this is only a temporary target for repaint, default is false
  88     bool                                                mbTemporaryTarget : 1;
  89
  90     bool                                                mbOutputToWindow : 1;
  91
  92     // helpers
  93     void impCreateOverlayManager();
  94
  95 public:
  96     SdrPaintWindow(SdrPaintView& rNewPaintView, OutputDevice& rOut, vcl::Window* pWindow = nullptr);
  97     ~SdrPaintWindow();
  98
  99     // data read accesses
 100     SdrPaintView& GetPaintView() const { return mrPaintView; }
 101     OutputDevice& GetOutputDevice() const { return *mpOutputDevice; }
 102     vcl::Window* GetWindow() const { return mpWindow; }
 103
 104     // OVERLAYMANAGER
 105     rtl::Reference< sdr::overlay::OverlayManager > const & GetOverlayManager() const;
 106
 107     // #i73602# add flag if buffer shall be used
 108     void DrawOverlay(const vcl::Region& rRegion);
 109
 110     // calculate visible area and return
 111     tools::Rectangle GetVisibleArea() const;
 112
 113     // Is OutDev a printer?
 114     bool OutputToPrinter() const { return (OUTDEV_PRINTER == mpOutputDevice->GetOutDevType()); }
 115
 116     // Is OutDev a window?
 117     bool OutputToWindow() const { return mbOutputToWindow; }
 118
 119     void SetOutputToWindow(bool bOutputToWindow) { mbOutputToWindow = bOutputToWindow; }
 120
 121     // Is OutDev a VirtualDevice?
 122     bool OutputIsVirtualDevice() const { return mpOutputDevice->IsVirtual(); }
 123
 124     // Is OutDev a recording MetaFile?
 125     bool OutputToRecordingMetaFile() const;
 126
 127     // prepare PreRendering (evtl.)
 128     void PreparePreRenderDevice();
 129     void DestroyPreRenderDevice();
 130     void OutputPreRenderDevice(const vcl::Region& rExpandedRegion);
 131     SdrPreRenderDevice* GetPreRenderDevice() const { return mpPreRenderDevice.get(); }
 132
 133     // RedrawRegion
 134     const vcl::Region& GetRedrawRegion() const { return maRedrawRegion;}
 135     void SetRedrawRegion(const vcl::Region& rNew);
 136
 137     // #i72889# read/write access to TemporaryTarget
 138     bool getTemporaryTarget() const { return mbTemporaryTarget; }
 139     void setTemporaryTarget(bool bNew) { mbTemporaryTarget = bNew; }
 140
 141     // #i72889# get target output device, take into account output buffering
 142     OutputDevice& GetTargetOutputDevice() { if(mpPreRenderDevice) return mpPreRenderDevice->GetPreRenderDevice(); else return *mpOutputDevice; }
 143 };
 144
 145 #endif // INCLUDED_SVX_SDRPAINTWINDOW_HXX
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */