vcl/inc/salvd.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_VCL_INC_SALVD_HXX
  21 #define INCLUDED_VCL_INC_SALVD_HXX
  22
  23 #include "salgeom.hxx"
  24
  25 class SalGraphics;
  26
  27 /// A non-visible drawable/buffer (e.g. an X11 Pixmap).
  28 class VCL_PLUGIN_PUBLIC SalVirtualDevice
  29         : public SalGeometryProvider
  30 {
  31 public:
  32     SalVirtualDevice() {}
  33     virtual ~SalVirtualDevice() override;
  34
  35     // SalGeometryProvider
  36     virtual bool IsOffScreen() const override { return true; }
  37
  38     // SalGraphics or NULL, but two Graphics for all SalVirtualDevices
  39     // must be returned
  40     virtual SalGraphics*    AcquireGraphics() = 0;
  41     virtual void            ReleaseGraphics( SalGraphics* pGraphics ) = 0;
  42
  43     // Set new size, without saving the old contents
  44     virtual bool            SetSize( tools::Long nNewDX, tools::Long nNewDY ) = 0;
  45
  46     // Set new size using a buffer at the given address
  47     virtual bool            SetSizeUsingBuffer( tools::Long nNewDX, tools::Long nNewDY,
  48                                                 sal_uInt8 * /* pBuffer */)
  49         {
  50             // Only the headless virtual device has an implementation that uses
  51             // pBuffer (and bTopDown).
  52             return SetSize( nNewDX, nNewDY );
  53         }
  54 };
  55
  56 #endif // INCLUDED_VCL_INC_SALVD_HXX
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */