include/vcl/filter/PngImageReader.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  */
  10
  11 #ifndef INCLUDED_VCL_FILTER_PNGIMAGEREADER_HXX
  12 #define INCLUDED_VCL_FILTER_PNGIMAGEREADER_HXX
  13
  14 #include <sal/config.h>
  15
  16 #include <memory>
  17 #include <vector>
  18
  19 #include <vcl/dllapi.h>
  20 #include <vcl/BinaryDataContainer.hxx>
  21
  22 #include <com/sun/star/uno/Reference.hxx>
  23
  24 namespace com::sun::star::task
  25 {
  26 class XStatusIndicator;
  27 }
  28
  29 class BitmapEx;
  30 class SvStream;
  31
  32 namespace vcl
  33 {
  34 class VCL_DLLPUBLIC PngImageReader
  35 {
  36     SvStream& mrStream;
  37     css::uno::Reference<css::task::XStatusIndicator> mxStatusIndicator;
  38
  39 public:
  40     PngImageReader(SvStream& rStream);
  41
  42     // Returns true if image was successfully read without errors.
  43     // A usable bitmap may be returned even if there were errors (e.g. incomplete image).
  44     bool read(BitmapEx& rBitmap);
  45     // Returns a bitmap without indicating if there were errors.
  46     BitmapEx read();
  47
  48     // Returns the contents of the msOG chunk (containing a Gif image), if it exists.
  49     // Does not change position in the stream.
  50     static BinaryDataContainer getMicrosoftGifChunk(SvStream& rStream);
  51 };
  52
  53 } // namespace vcl
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */