vcl/inc/image.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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 .
 */

#pragma once

#include <vcl/bitmap.hxx>
#include <vcl/gdimtf.hxx>

class SalGraphics;

class ImplImage
{
private:
    BitmapChecksum maBitmapChecksum;
    /// if non-empty: cached original size of maStockName else Size of maBitmap
    Size maSizePixel;
    /// If set - defines the bitmap via images.zip*
    OUString maStockName;
    /// rare case of dynamically created Image contents
    std::unique_ptr<GDIMetaFile> mxMetaFile;

    /// Original bitmap - or cache of a potentially scaled bitmap
    Bitmap maBitmap;
    Bitmap maDisabledBitmap;

    bool bOptional = false;

    bool loadStockAtScale(SalGraphics* pGraphics, Bitmap &rBitmap);

public:
    ImplImage(const Bitmap& rBitmap);
    ImplImage(const GDIMetaFile& rMetaFile);
    ImplImage(OUString aStockName);

    bool isStock() const
    {
        return maStockName.getLength() > 0;
    }

    const OUString & getStock() const
    {
        return maStockName;
    }

    /// get size in co-ordinates not scaled for HiDPI
    Size getSizePixel();
    /// Legacy - the original bitmap
    Bitmap const & getBitmap(bool bDisabled = false);
    /// Taking account of HiDPI scaling
    Bitmap const & getBitmapForHiDPI(bool bDisabled, SalGraphics* pGraphics);

    void SetOptional(bool bValue);

    bool isEqual(const ImplImage &ref) const;
    bool isSizeEmpty() const
    {
        return maSizePixel == Size();
    }
};

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