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