pdfextoutdevdata.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice 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 .
 */
 
#ifndef INCLUDED_VCL_PDFEXTOUTDEVDATA_HXX
#define INCLUDED_VCL_PDFEXTOUTDEVDATA_HXX
 
#include <vcl/dllapi.h>
 
#include <vcl/pdfwriter.hxx>
#include <vcl/extoutdevdata.hxx>
#include <vector>
#include <map>
#include <memory>
 
class Graphic;
class GDIMetaFile;
class SdrObject;
 
namespace vcl
{
 
/*
    A PDFExtOutDevBookmarkEntry is being created by the EditEngine if
    a bookmark URL has been parsed. The Application is requested to take
    care of each bookmark entry by emptying out the bookmark vector.
*/
struct PDFExtOutDevBookmarkEntry
{
    sal_Int32       nLinkId;
 
    sal_Int32       nDestId;
 
    OUString   aBookmark;
 
    PDFExtOutDevBookmarkEntry()
        :nLinkId( -1 )
        ,nDestId( -1 )
    {
    }
};
 
/*
 Class that is being set at the OutputDevice allowing the
 application to send enhanced PDF commands like CreateLink
*/
struct PageSyncData;
struct GlobalSyncData;
class VCL_DLLPUBLIC PDFExtOutDevData final : public ExtOutDevData
{
 
    const OutputDevice&         mrOutDev;
 
    bool                        mbTaggedPDF;
    bool                        mbExportNotes;
    bool                        mbExportNotesInMargin;
    bool                        mbExportNotesPages;
    bool                        mbTransitionEffects;
    bool                        mbUseLosslessCompression;
    bool                        mbReduceImageResolution;
    bool                        mbExportFormFields;
    bool                        mbExportBookmarks;
    bool                        mbExportHiddenSlides;
    bool                        mbSinglePageSheets;
    bool                        mbExportNDests; //i56629
    sal_Int32                   mnPage;
    sal_Int32                   mnCompressionQuality;
    css::lang::Locale           maDocLocale;
 
    std::unique_ptr<PageSyncData> mpPageSyncData;
    std::unique_ptr<GlobalSyncData> mpGlobalSyncData;
 
    std::vector< PDFExtOutDevBookmarkEntry > maBookmarks;
    std::vector<OUString> maChapterNames;
    // map from annotation SdrObject to annotation index
    ::std::map<SdrObject const*, ::std::vector<sal_Int32>> m_ScreenAnnotations;
 
public:
 
    PDFExtOutDevData( const OutputDevice& rOutDev );
    virtual ~PDFExtOutDevData() override;
 
    bool PlaySyncPageAct( PDFWriter& rWriter, sal_uInt32& rCurGDIMtfAction, const GDIMetaFile& rMtf );
    void ResetSyncData();
 
    void PlayGlobalActions( PDFWriter& rWriter );
 
    bool    GetIsExportNotes() const { return mbExportNotes;}
    void        SetIsExportNotes( const bool bExportNotes );
 
    bool    GetIsExportNotesInMargin() const { return mbExportNotesInMargin;}
    void        SetIsExportNotesInMargin( const bool bExportNotesInMargin );
 
    bool    GetIsExportNotesPages() const { return mbExportNotesPages;}
    void        SetIsExportNotesPages( const bool bExportNotesPages );
 
    bool    GetIsExportTaggedPDF() const { return mbTaggedPDF;}
    void        SetIsExportTaggedPDF( const bool bTaggedPDF );
 
    bool    GetIsExportTransitionEffects() const { return mbTransitionEffects;}
    void        SetIsExportTransitionEffects( const bool bTransitionalEffects );
 
    bool    GetIsExportFormFields() const { return mbExportFormFields;}
    void        SetIsExportFormFields( const bool bExportFormFields );
 
    bool    GetIsExportBookmarks() const { return mbExportBookmarks;}
    void        SetIsExportBookmarks( const bool bExportBookmarks );
 
    bool    GetIsExportHiddenSlides() const { return mbExportHiddenSlides;}
    void        SetIsExportHiddenSlides( const bool bExportHiddenSlides );
 
    void        SetIsSinglePageSheets( const bool bSinglePageSheets );
 
    bool    GetIsExportNamedDestinations() const { return mbExportNDests;} //i56629
    void        SetIsExportNamedDestinations( const bool bExportNDests ); //i56629
 
    // PageNumber, Compression is being set by the PDFExport
    sal_Int32   GetCurrentPageNumber() const { return mnPage;}
    void        SetCurrentPageNumber( const sal_Int32 nPage );
 
    bool        GetIsLosslessCompression() const { return mbUseLosslessCompression;}
    void        SetIsLosslessCompression( const bool bLosslessCompression );
 
    void        SetCompressionQuality( const sal_Int32 nQuality );
 
    bool        GetIsReduceImageResolution() const { return mbReduceImageResolution;}
    void        SetIsReduceImageResolution( const bool bReduceImageResolution );
 
    const css::lang::Locale& GetDocumentLocale() const { return maDocLocale;}
    void        SetDocumentLocale( const css::lang::Locale& rLoc );
 
    std::vector< PDFExtOutDevBookmarkEntry >& GetBookmarks() { return maBookmarks;}
    const std::vector<OUString>& GetChapterNames() const { return maChapterNames; }
 
    const Graphic& GetCurrentGraphic() const;
 
    void        BeginGroup();
 
    void        EndGroup( const Graphic&    rGraphic,
                          sal_uInt8         nTransparency,
                          const tools::Rectangle&  rOutputRect,
                          const tools::Rectangle&  rVisibleOutputRect );
 
    bool        HasAdequateCompression( const Graphic &rGraphic,
                                        const tools::Rectangle &rOutputRect,
                                        const tools::Rectangle &rVisibleOutputRect ) const;
 
//--->i56629
    sal_Int32 CreateNamedDest( const OUString& sDestName,  const tools::Rectangle& rRect, sal_Int32 nPageNr = -1 );
 
    sal_Int32   RegisterDest();
 
    void        DescribeRegisteredDest( sal_Int32 nDestId, const tools::Rectangle& rRect, sal_Int32 nPageNr, PDFWriter::DestAreaType eType = PDFWriter::DestAreaType::XYZ );
 
//<---i56629
 
    sal_Int32 CreateDest( const tools::Rectangle& rRect, sal_Int32 nPageNr = -1, PDFWriter::DestAreaType eType = PDFWriter::DestAreaType::XYZ );
    sal_Int32 CreateLink(const tools::Rectangle& rRect, OUString const& rAltText, sal_Int32 nPageNr = -1);
 
    sal_Int32 CreateScreen(const tools::Rectangle& rRect, OUString const& rAltText, OUString const& rMimeType, sal_Int32 nPageNr, SdrObject const* pObj);
 
    ::std::vector<sal_Int32> const& GetScreenAnnotIds(SdrObject const* pObj) const;
 
    void SetLinkDest( sal_Int32 nLinkId, sal_Int32 nDestId );
    void SetLinkURL( sal_Int32 nLinkId, const OUString& rURL );
 
    void SetScreenURL(sal_Int32 nScreenId, const OUString& rURL);
    void SetScreenStream(sal_Int32 nScreenId, const OUString& rURL);
 
    sal_Int32 CreateOutlineItem( sal_Int32 nParent, const OUString& rText, sal_Int32 nDestID );
 
    void CreateNote( const tools::Rectangle& rRect, const PDFNote& rNote, sal_Int32 nPageNr = -1 );
 
    sal_Int32 WrapBeginStructureElement(PDFWriter::StructElement eType, const OUString& rAlias = OUString());
    sal_Int32 EnsureStructureElement(void const* key);
    void InitStructureElement(sal_Int32 id, PDFWriter::StructElement eType, const OUString& rAlias);
    void BeginStructureElement(sal_Int32 id);
 
    void EndStructureElement();
    bool SetCurrentStructureElement( sal_Int32 nElement );
    sal_Int32 GetCurrentStructureElement() const;
 
    void SetStructureAttribute( PDFWriter::StructAttribute eAttr, PDFWriter::StructAttributeValue eVal );
    void SetStructureAttributeNumerical( PDFWriter::StructAttribute eAttr, sal_Int32 nValue );
    void SetStructureBoundingBox( const tools::Rectangle& rRect );
 
    void SetStructureAnnotIds(::std::vector<sal_Int32> const& rAnnotIds);
 
    void SetActualText( const OUString& rText );
 
    void SetAlternateText( const OUString& rText );
 
    void SetPageTransition( PDFWriter::PageTransition eType, sal_uInt32 nMilliSec );
 
    void    CreateControl( const PDFWriter::AnyWidget& rControlType );
};
 
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */