include/vcl/image.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_IMAGE_HXX
  21 #define INCLUDED_VCL_IMAGE_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <tools/gen.hxx>
  25 #include <vcl/bitmapex.hxx>
  26 #include <vcl/vclenum.hxx>
  27 #include <vcl/outdev.hxx>
  28
  29 #include <memory>
  30
  31 class ImplImage;
  32
  33 namespace com::sun::star::graphic { class XGraphic; }
  34 namespace com::sun::star::uno { template <class interface_type> class Reference; }
  35
  36 #define IMAGELIST_IMAGE_NOTFOUND (sal_uInt16(0xFFFF))
  37
  38 enum class StockImage { Yes };
  39
  40 class SAL_WARN_UNUSED VCL_DLLPUBLIC Image
  41 {
  42     friend class ::OutputDevice;
  43 public:
  44     Image();
  45     explicit Image(BitmapEx const & rBitmapEx);
  46     explicit Image(css::uno::Reference<css::graphic::XGraphic> const & rxGraphic);
  47     explicit Image(OUString const & rPNGFileUrl);
  48     explicit Image(StockImage, OUString const & rPNGFilePath, Size aSpecificSize = Size());
  49
  50     Size GetSizePixel() const;
  51     BitmapEx GetBitmapEx() const;
  52
  53     bool operator!() const
  54     {
  55         return !mpImplData;
  56     }
  57     bool operator==(const Image& rImage) const;
  58     bool operator!=(const Image& rImage) const
  59     {
  60         return !(Image::operator==(rImage));
  61     }
  62
  63     OUString GetStock() const;
  64
  65     void Draw(OutputDevice* pOutDev, const Point& rPos, DrawImageFlags nStyle, const Size* pSize = nullptr);
  66
  67 private:
  68
  69     std::shared_ptr<ImplImage> mpImplData;
  70
  71     SAL_DLLPRIVATE void ImplInit(BitmapEx const & rBmpEx);
  72 };
  73
  74 #endif // INCLUDED_VCL_IMAGE_HXX
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */