Avoid potential negative array index access to cached text.
[LibreOffice.git] / vcl / inc / image.h
blobcb75b45b837d330b358262b4d6dedc075f695470
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_VCL_INC_IMAGE_H
21 #define INCLUDED_VCL_INC_IMAGE_H
23 #include <vcl/bitmapex.hxx>
24 #include <vcl/gdimtf.hxx>
26 class SalGraphics;
28 class ImplImage
30 private:
31 BitmapChecksum maBitmapChecksum;
32 /// if non-empty: cached original size of maStockName else Size of maBitmap
33 Size maSizePixel;
34 /// If set - defines the bitmap via images.zip*
35 OUString maStockName;
36 /// rare case of dynamically created Image contents
37 std::unique_ptr<GDIMetaFile> mxMetaFile;
39 /// Original bitmap - or cache of a potentially scaled bitmap
40 BitmapEx maBitmapEx;
41 BitmapEx maDisabledBitmapEx;
43 bool loadStockAtScale(SalGraphics* pGraphics, BitmapEx &rBitmapEx);
45 public:
46 ImplImage(const BitmapEx& rBitmapEx);
47 ImplImage(const GDIMetaFile& rMetaFile);
48 ImplImage(OUString aStockName);
50 bool isStock() const
52 return maStockName.getLength() > 0;
55 const OUString & getStock() const
57 return maStockName;
60 /// get size in co-ordinates not scaled for HiDPI
61 Size getSizePixel();
62 /// Legacy - the original bitmap
63 BitmapEx const & getBitmapEx(bool bDisabled = false);
64 /// Taking account of HiDPI scaling
65 BitmapEx const & getBitmapExForHiDPI(bool bDisabled, SalGraphics* pGraphics);
67 bool isEqual(const ImplImage &ref) const;
68 bool isSizeEmpty() const
70 return maSizePixel == Size();
74 #endif // INCLUDED_VCL_INC_IMAGE_H
76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */