/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#ifndef INCLUDED_SVX_SDRPAINTWINDOW_HXX

#define INCLUDED_SVX_SDRPAINTWINDOW_HXX

#include <rtl/ref.hxx>

#include <vcl/virdev.hxx>

#include <svx/svxdllapi.h>

#include <memory>

class SdrPaintView;

namespace sdr::overlay { class OverlayManager; }

#ifdef _MSC_VER // broken msvc template instantiation

#include <svx/sdr/overlay/overlaymanager.hxx>

#endif

/// paint the transparent children of rWin that overlap rPixelRect

/// (for example, transparent form controls like check boxes)

void SVXCORE_DLLPUBLIC

PaintTransparentChildren(vcl::Window const & rWindow, tools::Rectangle const& rPixelRect);

class SdrPreRenderDevice

{

    // The original OutputDevice

    VclPtr<OutputDevice>   mpOutputDevice;

    // The VirtualDevice for PreRendering

    VclPtr<VirtualDevice>  mpPreRenderDevice;

public:

    explicit SdrPreRenderDevice(OutputDevice& rOriginal);

    ~SdrPreRenderDevice();

    void PreparePreRenderDevice();

    void OutputPreRenderDevice(const vcl::Region& rExpandedRegion);

    OutputDevice& GetPreRenderDevice() { return *mpPreRenderDevice; }

};

class SVXCORE_DLLPUBLIC SdrPaintWindow

{

private:

    // the OutputDevice this window represents

    VclPtr<OutputDevice>                                mpOutputDevice;

    /// In case mrOutputDevice is a buffer for a vcl::Window, this is the window.

    VclPtr<vcl::Window>                                 mpWindow;

    // the SdrPaintView this window belongs to

    SdrPaintView&                                       mrPaintView;

    // the new OverlayManager for the new OverlayObjects. Test add here, will

    // replace the IAOManager as soon as it works.

    rtl::Reference< sdr::overlay::OverlayManager >    mxOverlayManager;

    // The PreRenderDevice for PreRendering

    std::unique_ptr<SdrPreRenderDevice>               mpPreRenderDevice;

    // The RedrawRegion used for rendering

    vcl::Region                                              maRedrawRegion;

    // #i72889# flag if this is only a temporary target for repaint, default is false

    bool                                                mbTemporaryTarget : 1;

    bool                                                mbOutputToWindow : 1;

    // ref to patched

    SdrPaintWindow*                                     mpPatched;

    // helpers

    void impCreateOverlayManager();

public:

    SdrPaintWindow(SdrPaintView& rNewPaintView, OutputDevice& rOut, vcl::Window* pWindow = nullptr);

    ~SdrPaintWindow();

    // allow reference to patched, see patchPaintWindow/unpatchPaintWindow

    void setPatched(SdrPaintWindow* pPaintWindow) { mpPatched = pPaintWindow; }

    SdrPaintWindow* getPatched() const { return mpPatched; }

    // data read accesses

    OutputDevice& GetOutputDevice() const { return *mpOutputDevice; }

    vcl::Window* GetWindow() const { return mpWindow; }

    // OVERLAYMANAGER

    rtl::Reference< sdr::overlay::OverlayManager > const & GetOverlayManager() const;

    // #i73602# add flag if buffer shall be used

    void DrawOverlay(const vcl::Region& rRegion);

    // calculate visible area and return

    tools::Rectangle GetVisibleArea() const;

    // Is OutDev a printer?

    bool OutputToPrinter() const { return (OUTDEV_PRINTER == mpOutputDevice->GetOutDevType()); }

    // Is OutDev a window?

    bool OutputToWindow() const { return mbOutputToWindow; }

    void SetOutputToWindow(bool bOutputToWindow) { mbOutputToWindow = bOutputToWindow; }

    // Is OutDev a recording MetaFile?

    bool OutputToRecordingMetaFile() const;

    // prepare PreRendering (evtl.)

    void PreparePreRenderDevice();

    void OutputPreRenderDevice(const vcl::Region& rExpandedRegion);

    SdrPreRenderDevice* GetPreRenderDevice() const { return mpPreRenderDevice.get(); }

    // RedrawRegion

    const vcl::Region& GetRedrawRegion() const { return maRedrawRegion;}

    void SetRedrawRegion(const vcl::Region& rNew);

    // #i72889# read/write access to TemporaryTarget

    bool getTemporaryTarget() const { return mbTemporaryTarget; }

    void setTemporaryTarget(bool bNew) { mbTemporaryTarget = bNew; }

    // #i72889# get target output device, take into account output buffering

    OutputDevice& GetTargetOutputDevice() { if(mpPreRenderDevice) return mpPreRenderDevice->GetPreRenderDevice(); else return *mpOutputDevice; }

};

#endif // INCLUDED_SVX_SDRPAINTWINDOW_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */