include/vcl/pdfread.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 #ifndef INCLUDED_VCL_SOURCE_FILTER_IPDF_PDFREAD_HXX
  11 #define INCLUDED_VCL_SOURCE_FILTER_IPDF_PDFREAD_HXX
  12
  13 #include <vector>
  14 #include <tools/gen.hxx>
  15 #include <tools/stream.hxx>
  16 #include <tools/color.hxx>
  17 #include <vcl/graph.hxx>
  18 #include <basegfx/range/b2drectangle.hxx>
  19 #include <com/sun/star/util/DateTime.hpp>
  20
  21 #include <vcl/pdf/PDFAnnotationSubType.hxx>
  22 #include <vcl/pdf/PDFAnnotationMarker.hxx>
  23
  24 namespace com::sun::star::uno
  25 {
  26 template <typename> class Sequence;
  27 }
  28 class Bitmap;
  29
  30 namespace vcl
  31 {
  32 /// Fills the rBitmaps vector with rendered pages.
  33 VCL_DLLPUBLIC size_t RenderPDFBitmaps(const void* pBuffer, int nSize,
  34                                       std::vector<BitmapEx>& rBitmaps, size_t nFirstPage = 0,
  35                                       int nPages = 1, const basegfx::B2DTuple* pSizeHint = nullptr);
  36
  37 /// Imports a PDF stream into rGraphic as VectorGraphicData.
  38 VCL_DLLPUBLIC bool ImportPDF(SvStream& rStream, Graphic& rGraphic);
  39
  40 struct PDFGraphicAnnotation
  41 {
  42     OUString maAuthor;
  43     OUString maText;
  44
  45     basegfx::B2DRectangle maRectangle; // In HMM
  46     css::util::DateTime maDateTime;
  47
  48     Color maColor;
  49
  50     pdf::PDFAnnotationSubType meSubType;
  51     std::shared_ptr<pdf::PDFAnnotationMarker> mpMarker;
  52 };
  53
  54 class PDFGraphicResult
  55 {
  56     Graphic maGraphic;
  57     // Size in HMM
  58     Size maSize;
  59
  60     std::vector<PDFGraphicAnnotation> maAnnotations;
  61
  62 public:
  63     PDFGraphicResult(Graphic aGraphic, Size const& rSize,
  64                      std::vector<PDFGraphicAnnotation> aAnnotations)
  65         : maGraphic(std::move(aGraphic))
  66         , maSize(rSize)
  67         , maAnnotations(std::move(aAnnotations))
  68     {
  69     }
  70
  71     const Graphic& GetGraphic() const { return maGraphic; }
  72     const Size& GetSize() const { return maSize; }
  73     const std::vector<PDFGraphicAnnotation>& GetAnnotations() const { return maAnnotations; }
  74 };
  75
  76 /// Import PDF as Graphic images (1 per page), but not loaded yet.
  77 /// Returns the number of pages read.
  78 VCL_DLLPUBLIC size_t ImportPDFUnloaded(const OUString& rURL,
  79                                        std::vector<PDFGraphicResult>& rGraphics);
  80 }
  81
  82 #endif // INCLUDED_VCL_SOURCE_FILTER_IPDF_PDFREAD_HXX
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */