include/vcl/gfxlink.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_GFXLINK_HXX
  21 #define INCLUDED_VCL_GFXLINK_HXX
  22
  23 #include <tools/gen.hxx>
  24 #include <vcl/dllapi.h>
  25 #include <vcl/mapmod.hxx>
  26 #include <vcl/BinaryDataContainer.hxx>
  27
  28 class SvStream;
  29
  30 /** GfxLink graphic types that are supported by GfxLink.
  31  *
  32  * It is important that the numbers for native types stay the same, because
  33  * they are used in serialization to MTF.
  34  */
  35 enum class GfxLinkType
  36 {
  37     NONE         = 0,
  38     EpsBuffer    = 1,
  39     NativeGif    = 2,
  40     NativeJpg    = 3,
  41     NativePng    = 4,
  42     NativeTif    = 5,
  43     NativeWmf    = 6,
  44     NativeMet    = 7,
  45     NativePct    = 8,
  46     NativeSvg    = 9,
  47     NativeMov    = 10,
  48     NativeBmp    = 11,
  49     NativePdf    = 12,
  50     NativeWebp   = 13, // If a new type is added, make sure to change NativeLast too
  51
  52     // Alias for when the first native type starts and last native
  53     // type ends.
  54     NativeFirst  = NativeGif,
  55     NativeLast   = NativeWebp,
  56 };
  57
  58 class Graphic;
  59
  60 class VCL_DLLPUBLIC GfxLink
  61 {
  62 private:
  63     GfxLinkType     meType;
  64     sal_uInt32      mnUserId;
  65     BinaryDataContainer maDataContainer;
  66     mutable size_t  maHash;
  67     MapMode         maPrefMapMode;
  68     Size            maPrefSize;
  69     bool            mbPrefMapModeValid;
  70     bool            mbPrefSizeValid;
  71
  72 public:
  73     GfxLink();
  74     explicit GfxLink(BinaryDataContainer aDataConainer, GfxLinkType nType);
  75
  76     bool                operator==( const GfxLink& ) const;
  77
  78     GfxLinkType         GetType() const { return meType;}
  79
  80     size_t              GetHash() const;
  81
  82     void                SetUserId( sal_uInt32 nUserId ) { mnUserId = nUserId; }
  83     sal_uInt32          GetUserId() const { return mnUserId; }
  84
  85     sal_uInt32          GetDataSize() const { return maDataContainer.getSize(); }
  86     const sal_uInt8*    GetData() const;
  87
  88     /// return the in-memory size as of now.
  89     size_t              getSizeBytes() const { return maDataContainer.getSizeBytes(); }
  90
  91     const BinaryDataContainer& getDataContainer() const
  92     {
  93         return maDataContainer;
  94     }
  95
  96     const Size&         GetPrefSize() const { return maPrefSize;}
  97     void                SetPrefSize( const Size& rPrefSize );
  98     bool                IsPrefSizeValid() const { return mbPrefSizeValid;}
  99
 100     const MapMode&      GetPrefMapMode() const { return maPrefMapMode;}
 101     void                SetPrefMapMode( const MapMode& rPrefMapMode );
 102     bool                IsPrefMapModeValid() const { return mbPrefMapModeValid;}
 103
 104     bool                IsNative() const;
 105
 106     bool                LoadNative( Graphic& rGraphic ) const;
 107
 108     bool                ExportNative( SvStream& rOStream ) const;
 109
 110     bool                IsEMF() const; // WMF & EMF stored under the same type (NativeWmf)
 111 };
 112
 113 #endif
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */