include/vcl/cairo.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_CAIRO_HXX
  21 #define INCLUDED_VCL_CAIRO_HXX
  22
  23 #include <sal/config.h>
  24 #include <vcl/vclptr.hxx>
  25 #include <memory>
  26
  27 typedef struct _cairo_surface cairo_surface_t;
  28 typedef struct _cairo cairo_t;
  29
  30 class VirtualDevice;
  31
  32 namespace cairo {
  33
  34     typedef std::shared_ptr<cairo_surface_t> CairoSurfaceSharedPtr;
  35     typedef std::shared_ptr<cairo_t>         CairoSharedPtr;
  36     struct Surface;
  37     typedef std::shared_ptr<Surface>         SurfaceSharedPtr;
  38
  39     /** Cairo surface interface
  40
  41         For each cairo-supported platform, there's an implementation of
  42         this interface
  43      */
  44     struct Surface
  45     {
  46     public:
  47         virtual ~Surface() {}
  48
  49         // Query methods
  50         virtual CairoSharedPtr getCairo() const = 0;
  51         virtual CairoSurfaceSharedPtr getCairoSurface() const = 0;
  52         virtual SurfaceSharedPtr getSimilar(int cairo_content_type, int width, int height) const = 0;
  53
  54         /// factory for VirDev on this surface
  55         virtual VclPtr<VirtualDevice> createVirtualDevice() const = 0;
  56
  57         /// Resize the surface (possibly destroying content), only possible for X11 typically
  58         /// so on failure caller must create a new surface instead
  59         virtual bool Resize( int /*width*/, int /*height*/ ) { return false; }
  60
  61         /// Flush all pending output to surface
  62         virtual void flush() const = 0;
  63     };
  64
  65 }
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */