LibreOffice Module vcl (master)  1
Public Member Functions | Private Attributes | List of all members
vcl::PDFExtOutDevData Class Reference

#include <pdfextoutdevdata.hxx>

Inheritance diagram for vcl::PDFExtOutDevData:
[legend]
Collaboration diagram for vcl::PDFExtOutDevData:
[legend]

Public Member Functions

 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
 
void SetIsExportNotes (const bool bExportNotes)
 
bool GetIsExportNotesPages () const
 
void SetIsExportNotesPages (const bool bExportNotesPages)
 
bool GetIsExportTaggedPDF () const
 
void SetIsExportTaggedPDF (const bool bTaggedPDF)
 
bool GetIsExportTransitionEffects () const
 
void SetIsExportTransitionEffects (const bool bTransitionalEffects)
 
bool GetIsExportFormFields () const
 
void SetIsExportFormFields (const bool bExportFormFields)
 
bool GetIsExportBookmarks () const
 
void SetIsExportBookmarks (const bool bExportBookmarks)
 
bool GetIsExportHiddenSlides () const
 
void SetIsExportHiddenSlides (const bool bExportHiddenSlides)
 
void SetIsSinglePageSheets (const bool bSinglePageSheets)
 
bool GetIsExportNamedDestinations () const
 
void SetIsExportNamedDestinations (const bool bExportNDests)
 
sal_Int32 GetCurrentPageNumber () const
 
void SetCurrentPageNumber (const sal_Int32 nPage)
 
bool GetIsLosslessCompression () const
 
void SetIsLosslessCompression (const bool bLosslessCompression)
 
void SetCompressionQuality (const sal_Int32 nQuality)
 
bool GetIsReduceImageResolution () const
 
void SetIsReduceImageResolution (const bool bReduceImageResolution)
 
const css::lang::Locale & GetDocumentLocale () const
 
void SetDocumentLocale (const css::lang::Locale &rLoc)
 
std::vector< PDFExtOutDevBookmarkEntry > & GetBookmarks ()
 
const std::vector< OUString > & GetChapterNames () const
 
const GraphicGetCurrentGraphic () const
 
void BeginGroup ()
 Start a new group of render output. More...
 
void EndGroup (const Graphic &rGraphic, sal_uInt8 nTransparency, const tools::Rectangle &rOutputRect, const tools::Rectangle &rVisibleOutputRect)
 End render output. More...
 
bool HasAdequateCompression (const Graphic &rGraphic, const tools::Rectangle &rOutputRect, const tools::Rectangle &rVisibleOutputRect) const
 Detect if stream is compressed enough to avoid de-compress / scale & re-compress. More...
 
sal_Int32 CreateNamedDest (const OUString &sDestName, const tools::Rectangle &rRect, sal_Int32 nPageNr=-1)
 Create a new named destination to be used in a link to this document from another PDF document (see PDF spec 1.4, 8.2.1) More...
 
sal_Int32 RegisterDest ()
 registers a destination for which a destination ID needs to be known immediately, instead of later on setting it via SetLinkDest. More...
 
void DescribeRegisteredDest (sal_Int32 nDestId, const tools::Rectangle &rRect, sal_Int32 nPageNr, PDFWriter::DestAreaType eType=PDFWriter::DestAreaType::XYZ)
 provides detailed information about a destination range which previously has been registered using RegisterDest. More...
 
sal_Int32 CreateDest (const tools::Rectangle &rRect, sal_Int32 nPageNr=-1, PDFWriter::DestAreaType eType=PDFWriter::DestAreaType::XYZ)
 Create a new destination to be used in a link. More...
 
sal_Int32 CreateLink (const tools::Rectangle &rRect, sal_Int32 nPageNr=-1)
 Create a new link on a page. More...
 
sal_Int32 CreateScreen (const tools::Rectangle &rRect, sal_Int32 nPageNr)
 Create a Screen annotation. More...
 
void SetLinkDest (sal_Int32 nLinkId, sal_Int32 nDestId)
 Set the destination for a link. More...
 
void SetLinkURL (sal_Int32 nLinkId, const OUString &rURL)
 Set the URL for a link. More...
 
void SetScreenURL (sal_Int32 nScreenId, const OUString &rURL)
 Set URL for a linked Screen annotation. More...
 
void SetScreenStream (sal_Int32 nScreenId, const OUString &rURL)
 Set URL for an embedded Screen annotation. More...
 
sal_Int32 CreateOutlineItem (sal_Int32 nParent, const OUString &rText, sal_Int32 nDestID)
 Create a new outline item. More...
 
void CreateNote (const tools::Rectangle &rRect, const PDFNote &rNote, sal_Int32 nPageNr=-1)
 Create a new note on a page. More...
 
sal_Int32 BeginStructureElement (PDFWriter::StructElement eType, const OUString &rAlias=OUString())
 begin a new logical structure element More...
 
void EndStructureElement ()
 end a logical structure element More...
 
bool SetCurrentStructureElement (sal_Int32 nElement)
 set the current structure element More...
 
sal_Int32 GetCurrentStructureElement () const
 get the current structure element id More...
 
void SetStructureAttribute (PDFWriter::StructAttribute eAttr, PDFWriter::StructAttributeValue eVal)
 set a structure attribute on the current structural element More...
 
void SetStructureAttributeNumerical (PDFWriter::StructAttribute eAttr, sal_Int32 nValue)
 set a structure attribute on the current structural element More...
 
void SetStructureBoundingBox (const tools::Rectangle &rRect)
 set the bounding box of a structural element More...
 
void SetActualText (const OUString &rText)
 set the ActualText attribute of a structural element More...
 
void SetAlternateText (const OUString &rText)
 set the Alt attribute of a strutural element More...
 
void SetPageTransition (PDFWriter::PageTransition eType, sal_uInt32 nMilliSec)
 Sets the transitional effect to be applied when the current page gets shown. More...
 
void CreateControl (const PDFWriter::AnyWidget &rControlType)
 create a new form control More...
 
- Public Member Functions inherited from vcl::ExtOutDevData
virtual ~ExtOutDevData ()
 

Private Attributes

const OutputDevicemrOutDev
 
bool mbTaggedPDF
 
bool mbExportNotes
 
bool mbExportNotesPages
 
bool mbTransitionEffects
 
bool mbUseLosslessCompression
 
bool mbReduceImageResolution
 
bool mbExportFormFields
 
bool mbExportBookmarks
 
bool mbExportHiddenSlides
 
bool mbSinglePageSheets
 
bool mbExportNDests
 
sal_Int32 mnPage
 
sal_Int32 mnCompressionQuality
 
css::lang::Locale maDocLocale
 
std::unique_ptr< PageSyncDatampPageSyncData
 
std::unique_ptr< GlobalSyncDatampGlobalSyncData
 
std::vector< PDFExtOutDevBookmarkEntrymaBookmarks
 
std::vector< OUString > maChapterNames
 

Detailed Description

Definition at line 69 of file pdfextoutdevdata.hxx.

Constructor & Destructor Documentation

vcl::PDFExtOutDevData::PDFExtOutDevData ( const OutputDevice rOutDev)

Definition at line 515 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, mpPageSyncData, and mrOutDev.

vcl::PDFExtOutDevData::~PDFExtOutDevData ( )
overridevirtual

Definition at line 535 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and mpPageSyncData.

Member Function Documentation

void vcl::PDFExtOutDevData::BeginGroup ( )

Start a new group of render output.

Use this method to group render output.

Definition at line 801 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::BeginGroup, mpPageSyncData, and mrOutDev.

sal_Int32 vcl::PDFExtOutDevData::BeginStructureElement ( PDFWriter::StructElement  eType,
const OUString &  rAlias = OUString() 
)

begin a new logical structure element

BeginStructureElement/EndStructureElement calls build the logical structure of the PDF - the basis for tagged PDF. Structural elements are implemented using marked content tags. Each structural element can contain sub elements (e.g. a section can contain a heading and a paragraph). The structure hierarchy is build automatically from the Begin/EndStructureElement calls.

A structural element need not be contained on one page; e.g. paragraphs often run from one page to the next. In this case the corresponding EndStructureElement must be called while drawing the next page.

BeginStructureElement and EndStructureElement must be called only after PDFWriter::NewPage has been called and before PDFWriter::Emit gets called. The current page number is an implicit context parameter for Begin/EndStructureElement.

For pagination artifacts that are not part of the logical structure of the document (like header, footer or page number) the special StructElement NonStructElement exists. To place content outside of the structure tree simply call BeginStructureElement( NonStructElement ) then draw your content and then call EndStructureElement(). Any children of a NonStructElement will not be part of the structure as well.

Parameters
eTypedenotes what kind of element to begin (e.g. a heading or paragraph)
rAliasthe specified alias will be used as structure tag. Also an entry in the PDF's role map will be created mapping alias to regular structure type.
Returns
the id of the newly created structural element

Definition at line 733 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::BeginStructureElement, mpGlobalSyncData, mpPageSyncData, and mrOutDev.

void vcl::PDFExtOutDevData::CreateControl ( const PDFWriter::AnyWidget rControlType)

create a new form control

This function creates a new form control in the PDF and sets its various properties. Do not pass an actual AnyWidget as rControlType will be cast to the type described by the type member.

Parameters
rControlTypea descendant of AnyWidget determining the control's properties

Definition at line 793 of file pdfextoutdevdata.cxx.

References vcl::PDFWriter::AnyWidget::Clone(), vcl::PDFExtOutDevDataSync::CreateControl, mpPageSyncData, and mrOutDev.

sal_Int32 vcl::PDFExtOutDevData::CreateDest ( const tools::Rectangle rRect,
sal_Int32  nPageNr = -1,
PDFWriter::DestAreaType  eType = PDFWriter::DestAreaType::XYZ 
)

Create a new destination to be used in a link.

Parameters
rRecttarget rectangle on page to be displayed if dest is jumped to
nPageNrnumber of page the dest is on (as returned by NewPage) or -1 in which case the current page is used
eTypewhat dest type to use
Returns
the destination id (to be used in SetLinkDest) or -1 if page id does not exist

Definition at line 649 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::CreateDest, OutputDevice::GetMapMode(), mnPage, mpGlobalSyncData, and mrOutDev.

sal_Int32 vcl::PDFExtOutDevData::CreateLink ( const tools::Rectangle rRect,
sal_Int32  nPageNr = -1 
)

Create a new link on a page.

Parameters
rRectactive rectangle of the link (that is the area that has to be hit to activate the link)
nPageNrnumber of page the link is on (as returned by NewPage) or -1 in which case the current page is used
Returns
the link id (to be used in SetLinkDest, SetLinkURL) or -1 if page id does not exist

Definition at line 658 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::CreateLink, OutputDevice::GetMapMode(), mnPage, mpGlobalSyncData, and mrOutDev.

sal_Int32 vcl::PDFExtOutDevData::CreateNamedDest ( const OUString &  sDestName,
const tools::Rectangle rRect,
sal_Int32  nPageNr = -1 
)

Create a new named destination to be used in a link to this document from another PDF document (see PDF spec 1.4, 8.2.1)

Parameters
sDestNamethe name this destination will be addressed with from others PDF document
rRecttarget rectangle on page to be displayed if dest is jumped to
nPageNrnumber of page the dest is on (as returned by NewPage) or -1 in which case the current page is used
Returns
the destination id (to be used in SetLinkDest) or -1 if page id does not exist

Definition at line 619 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::CreateNamedDest, OutputDevice::GetMapMode(), mnPage, mpGlobalSyncData, mrOutDev, and vcl::PDFWriter::XYZ.

void vcl::PDFExtOutDevData::CreateNote ( const tools::Rectangle rRect,
const PDFNote rNote,
sal_Int32  nPageNr = -1 
)

Create a new note on a page.

Parameters
rRectactive rectangle of the note (that is the area that has to be hit to popup the annotation)
rNotespecifies the contents of the note
nPageNrnumber of page the note is on (as returned by NewPage) or -1 in which case the current page is used

Definition at line 715 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::CreateNote, OutputDevice::GetMapMode(), mnPage, mpGlobalSyncData, and mrOutDev.

sal_Int32 vcl::PDFExtOutDevData::CreateOutlineItem ( sal_Int32  nParent,
const OUString &  rText,
sal_Int32  nDestID 
)

Create a new outline item.

Parameters
nParentdeclares the parent of the new item in the outline hierarchy. An invalid value will result in a new toplevel item.
rTextsets the title text of the item
nDestIDdeclares which Dest (created with CreateDest) the outline item will point to
Returns
the outline item id of the new item

Definition at line 703 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::CreateOutlineItem, maChapterNames, and mpGlobalSyncData.

sal_Int32 vcl::PDFExtOutDevData::CreateScreen ( const tools::Rectangle rRect,
sal_Int32  nPageNr 
)

Create a Screen annotation.

Definition at line 667 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::CreateScreen, OutputDevice::GetMapMode(), mpGlobalSyncData, and mrOutDev.

void vcl::PDFExtOutDevData::DescribeRegisteredDest ( sal_Int32  nDestId,
const tools::Rectangle rRect,
sal_Int32  nPageNr,
PDFWriter::DestAreaType  eType = PDFWriter::DestAreaType::XYZ 
)

provides detailed information about a destination range which previously has been registered using RegisterDest.

Definition at line 639 of file pdfextoutdevdata.cxx.

References OutputDevice::GetMapMode(), vcl::PDFLinkDestination::mAreaType, vcl::PDFLinkDestination::mMapMode, mnPage, vcl::PDFLinkDestination::mPageNr, mpGlobalSyncData, vcl::PDFLinkDestination::mRect, and mrOutDev.

void vcl::PDFExtOutDevData::EndGroup ( const Graphic rGraphic,
sal_uInt8  nTransparency,
const tools::Rectangle rOutputRect,
const tools::Rectangle rVisibleOutputRect 
)

End render output.

This method ends grouped render output, that can be represented by a GfxLink. This is typically used for external graphic files, such as JPEGs, EPS files etc. The BeginGroup/EndGroup calls must exactly enclose the relevant OutputDevice calls issued to render the graphic the normal way.

Parameters
rGraphicThe link to the original graphic
nTransparencyEight bit transparency value, with 0 denoting full opacity, and 255 full transparency.
rOutputRectThe output rectangle of the graphic.
rVisibleOutputRectThe visible part of the output. This might be less than rOutputRect, e.g. for cropped graphics.

Definition at line 806 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::EndGroupGfxLink, mpPageSyncData, and mrOutDev.

void vcl::PDFExtOutDevData::EndStructureElement ( )

end a logical structure element

See also
BeginStructureElement

Definition at line 744 of file pdfextoutdevdata.cxx.

References vcl::PDFExtOutDevDataSync::EndStructureElement, mpGlobalSyncData, mpPageSyncData, and mrOutDev.

std::vector< PDFExtOutDevBookmarkEntry >& vcl::PDFExtOutDevData::GetBookmarks ( )
inline

Definition at line 146 of file pdfextoutdevdata.hxx.

const std::vector<OUString>& vcl::PDFExtOutDevData::GetChapterNames ( ) const
inline

Definition at line 147 of file pdfextoutdevdata.hxx.

const Graphic & vcl::PDFExtOutDevData::GetCurrentGraphic ( ) const

Definition at line 541 of file pdfextoutdevdata.cxx.

References mpPageSyncData.

Referenced by vcl::PDFWriterImpl::playMetafile().

sal_Int32 vcl::PDFExtOutDevData::GetCurrentPageNumber ( ) const
inline

Definition at line 132 of file pdfextoutdevdata.hxx.

sal_Int32 vcl::PDFExtOutDevData::GetCurrentStructureElement ( ) const

get the current structure element id

Returns
the id of the current structure element

Definition at line 761 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData.

const css::lang::Locale& vcl::PDFExtOutDevData::GetDocumentLocale ( ) const
inline

Definition at line 143 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportBookmarks ( ) const
inline

Definition at line 120 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportFormFields ( ) const
inline

Definition at line 117 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportHiddenSlides ( ) const
inline

Definition at line 123 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportNamedDestinations ( ) const
inline

Definition at line 128 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportNotes ( ) const
inline

Definition at line 105 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportNotesPages ( ) const
inline

Definition at line 108 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportTaggedPDF ( ) const
inline

Definition at line 111 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsExportTransitionEffects ( ) const
inline

Definition at line 114 of file pdfextoutdevdata.hxx.

bool vcl::PDFExtOutDevData::GetIsLosslessCompression ( ) const
inline

Definition at line 135 of file pdfextoutdevdata.hxx.

Referenced by HasAdequateCompression().

bool vcl::PDFExtOutDevData::GetIsReduceImageResolution ( ) const
inline

Definition at line 140 of file pdfextoutdevdata.hxx.

Referenced by HasAdequateCompression().

bool vcl::PDFExtOutDevData::HasAdequateCompression ( const Graphic rGraphic,
const tools::Rectangle rOutputRect,
const tools::Rectangle rVisibleOutputRect 
) const
void vcl::PDFExtOutDevData::PlayGlobalActions ( PDFWriter rWriter)

Definition at line 610 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData.

bool vcl::PDFExtOutDevData::PlaySyncPageAct ( PDFWriter rWriter,
sal_uInt32 &  rCurGDIMtfAction,
const GDIMetaFile rMtf 
)

Definition at line 606 of file pdfextoutdevdata.cxx.

References mpPageSyncData.

Referenced by vcl::PDFWriterImpl::playMetafile().

sal_Int32 vcl::PDFExtOutDevData::RegisterDest ( )

registers a destination for which a destination ID needs to be known immediately, instead of later on setting it via SetLinkDest.

This is used in contexts where a destination is referenced by means other than a link.

Later in the export process, a call to DescribeRegisteredDest must be made, providing the information about the destination.

Returns
the unique Id of the destination

Definition at line 631 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and vcl::PDFExtOutDevDataSync::RegisterDest.

void vcl::PDFExtOutDevData::ResetSyncData ( )

Definition at line 602 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and mpPageSyncData.

void vcl::PDFExtOutDevData::SetActualText ( const OUString &  rText)

set the ActualText attribute of a structural element

ActualText contains the Unicode text without layout artifacts that is shown by a structural element. For example if a line is ended prematurely with a break in a word and continued on the next line (e.g. "happen-<newline>stance") the corresponding ActualText would contain the unbroken line (e.g. "happenstance").

Parameters
rTextcontains the complete logical text the structural element displays.

Definition at line 782 of file pdfextoutdevdata.cxx.

References mpPageSyncData, mrOutDev, and vcl::PDFExtOutDevDataSync::SetActualText.

void vcl::PDFExtOutDevData::SetAlternateText ( const OUString &  rText)

set the Alt attribute of a strutural element

Alt is s replacement text describing the contents of a structural element. This is mainly used by accessibility applications; e.g. a screen reader would read the Alt replacement text for an image to a visually impaired user.

Parameters
rTextcontains the replacement text for the structural element

Definition at line 787 of file pdfextoutdevdata.cxx.

References mpPageSyncData, mrOutDev, and vcl::PDFExtOutDevDataSync::SetAlternateText.

void vcl::PDFExtOutDevData::SetCompressionQuality ( const sal_Int32  nQuality)

Definition at line 558 of file pdfextoutdevdata.cxx.

References mnCompressionQuality.

void vcl::PDFExtOutDevData::SetCurrentPageNumber ( const sal_Int32  nPage)

Definition at line 550 of file pdfextoutdevdata.cxx.

References mnPage.

bool vcl::PDFExtOutDevData::SetCurrentStructureElement ( sal_Int32  nElement)

set the current structure element

For different purposes it may be useful to paint a structure element's content discontinously. In that case an already existing structure element can be appended to by using SetCurrentStructureElement. The referenced structure element becomes the current structure element with all consequences: all following structure elements are appended as children of the current element.

Parameters
nElementthe id of the new current structure element
Returns
True if the current structure element could be set successfully False if the current structure element could not be changed (e.g. if the passed element id is invalid)

Definition at line 749 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, mpPageSyncData, mrOutDev, and vcl::PDFExtOutDevDataSync::SetCurrentStructureElement.

void vcl::PDFExtOutDevData::SetDocumentLocale ( const css::lang::Locale &  rLoc)

Definition at line 546 of file pdfextoutdevdata.cxx.

References maDocLocale.

void vcl::PDFExtOutDevData::SetIsExportBookmarks ( const bool  bExportBookmarks)

Definition at line 586 of file pdfextoutdevdata.cxx.

References mbExportBookmarks.

void vcl::PDFExtOutDevData::SetIsExportFormFields ( const bool  bExportFormFields)

Definition at line 582 of file pdfextoutdevdata.cxx.

References mbExportFormFields.

void vcl::PDFExtOutDevData::SetIsExportHiddenSlides ( const bool  bExportHiddenSlides)

Definition at line 590 of file pdfextoutdevdata.cxx.

References mbExportHiddenSlides.

void vcl::PDFExtOutDevData::SetIsExportNamedDestinations ( const bool  bExportNDests)

Definition at line 598 of file pdfextoutdevdata.cxx.

References mbExportNDests.

void vcl::PDFExtOutDevData::SetIsExportNotes ( const bool  bExportNotes)

Definition at line 566 of file pdfextoutdevdata.cxx.

References mbExportNotes.

void vcl::PDFExtOutDevData::SetIsExportNotesPages ( const bool  bExportNotesPages)

Definition at line 570 of file pdfextoutdevdata.cxx.

References mbExportNotesPages.

void vcl::PDFExtOutDevData::SetIsExportTaggedPDF ( const bool  bTaggedPDF)

Definition at line 574 of file pdfextoutdevdata.cxx.

References mbTaggedPDF.

void vcl::PDFExtOutDevData::SetIsExportTransitionEffects ( const bool  bTransitionalEffects)

Definition at line 578 of file pdfextoutdevdata.cxx.

References mbTransitionEffects.

void vcl::PDFExtOutDevData::SetIsLosslessCompression ( const bool  bLosslessCompression)

Definition at line 554 of file pdfextoutdevdata.cxx.

References mbUseLosslessCompression.

void vcl::PDFExtOutDevData::SetIsReduceImageResolution ( const bool  bReduceImageResolution)

Definition at line 562 of file pdfextoutdevdata.cxx.

References mbReduceImageResolution.

void vcl::PDFExtOutDevData::SetIsSinglePageSheets ( const bool  bSinglePageSheets)

Definition at line 594 of file pdfextoutdevdata.cxx.

References mbSinglePageSheets.

void vcl::PDFExtOutDevData::SetLinkDest ( sal_Int32  nLinkId,
sal_Int32  nDestId 
)

Set the destination for a link.

will change a URL type link to a dest link if necessary

Parameters
nLinkIdthe link to be changed
nDestIdthe dest the link shall point to

Definition at line 676 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and vcl::PDFExtOutDevDataSync::SetLinkDest.

void vcl::PDFExtOutDevData::SetLinkURL ( sal_Int32  nLinkId,
const OUString &  rURL 
)

Set the URL for a link.

will change a dest type link to a URL type link if necessary

Parameters
nLinkIdthe link to be changed
rURLthe URL the link shall point to. there will be no error checking or any kind of conversion done to this parameter execept this: it will be output as 7bit Ascii. The URL will appear literally in the PDF file produced

Definition at line 682 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and vcl::PDFExtOutDevDataSync::SetLinkURL.

void vcl::PDFExtOutDevData::SetPageTransition ( PDFWriter::PageTransition  eType,
sal_uInt32  nMilliSec 
)

Sets the transitional effect to be applied when the current page gets shown.

Parameters
eTypethe kind of effect to be used; use Regular to disable transitional effects for this page
nMilliSecthe duration of the transitional effect in milliseconds; set 0 to disable transitional effects

Definition at line 723 of file pdfextoutdevdata.cxx.

References mnPage, mpGlobalSyncData, and vcl::PDFExtOutDevDataSync::SetPageTransition.

void vcl::PDFExtOutDevData::SetScreenStream ( sal_Int32  nScreenId,
const OUString &  rURL 
)

Set URL for an embedded Screen annotation.

Definition at line 696 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and vcl::PDFExtOutDevDataSync::SetScreenStream.

void vcl::PDFExtOutDevData::SetScreenURL ( sal_Int32  nScreenId,
const OUString &  rURL 
)

Set URL for a linked Screen annotation.

Definition at line 689 of file pdfextoutdevdata.cxx.

References mpGlobalSyncData, and vcl::PDFExtOutDevDataSync::SetScreenURL.

void vcl::PDFExtOutDevData::SetStructureAttribute ( PDFWriter::StructAttribute  eAttr,
PDFWriter::StructAttributeValue  eVal 
)

set a structure attribute on the current structural element

SetStructureAttribute sets an attribute of the current structural element to a new value. A consistency check is performed before actually setting the value; if the check fails, the function returns False and the attribute remains unchanged.

Parameters
eAttrdenotes what attribute to change
eValthe value to set the attribute to

Definition at line 765 of file pdfextoutdevdata.cxx.

References mpPageSyncData, mrOutDev, and vcl::PDFExtOutDevDataSync::SetStructureAttribute.

void vcl::PDFExtOutDevData::SetStructureAttributeNumerical ( PDFWriter::StructAttribute  eAttr,
sal_Int32  nValue 
)

set a structure attribute on the current structural element

SetStructureAttributeNumerical sets an attribute of the current structural element to a new numerical value. A consistency check is performed before actually setting the value; if the check fails, the function returns False and the attribute remains unchanged.

Parameters
eAttrdenotes what attribute to change
nValuethe value to set the attribute to

Definition at line 771 of file pdfextoutdevdata.cxx.

References mpPageSyncData, mrOutDev, and vcl::PDFExtOutDevDataSync::SetStructureAttributeNumerical.

void vcl::PDFExtOutDevData::SetStructureBoundingBox ( const tools::Rectangle rRect)

set the bounding box of a structural element

SetStructureBoundingBox sets the BBox attribute to a new value. Since the BBox attribute can only be applied to Table, Figure, Form and Formula elements, a call of this function for other element types will be ignored and the BBox attribute not be set.

Parameters
rRectthe new bounding box for the structural element

Definition at line 777 of file pdfextoutdevdata.cxx.

References mpPageSyncData, mrOutDev, and vcl::PDFExtOutDevDataSync::SetStructureBoundingBox.

Member Data Documentation

std::vector< PDFExtOutDevBookmarkEntry > vcl::PDFExtOutDevData::maBookmarks
private

Definition at line 92 of file pdfextoutdevdata.hxx.

std::vector<OUString> vcl::PDFExtOutDevData::maChapterNames
private

Definition at line 93 of file pdfextoutdevdata.hxx.

Referenced by CreateOutlineItem().

css::lang::Locale vcl::PDFExtOutDevData::maDocLocale
private

Definition at line 87 of file pdfextoutdevdata.hxx.

Referenced by SetDocumentLocale().

bool vcl::PDFExtOutDevData::mbExportBookmarks
private

Definition at line 81 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportBookmarks().

bool vcl::PDFExtOutDevData::mbExportFormFields
private

Definition at line 80 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportFormFields().

bool vcl::PDFExtOutDevData::mbExportHiddenSlides
private

Definition at line 82 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportHiddenSlides().

bool vcl::PDFExtOutDevData::mbExportNDests
private

Definition at line 84 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportNamedDestinations().

bool vcl::PDFExtOutDevData::mbExportNotes
private

Definition at line 75 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportNotes().

bool vcl::PDFExtOutDevData::mbExportNotesPages
private

Definition at line 76 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportNotesPages().

bool vcl::PDFExtOutDevData::mbReduceImageResolution
private

Definition at line 79 of file pdfextoutdevdata.hxx.

Referenced by HasAdequateCompression(), and SetIsReduceImageResolution().

bool vcl::PDFExtOutDevData::mbSinglePageSheets
private

Definition at line 83 of file pdfextoutdevdata.hxx.

Referenced by SetIsSinglePageSheets().

bool vcl::PDFExtOutDevData::mbTaggedPDF
private

Definition at line 74 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportTaggedPDF().

bool vcl::PDFExtOutDevData::mbTransitionEffects
private

Definition at line 77 of file pdfextoutdevdata.hxx.

Referenced by SetIsExportTransitionEffects().

bool vcl::PDFExtOutDevData::mbUseLosslessCompression
private

Definition at line 78 of file pdfextoutdevdata.hxx.

Referenced by SetIsLosslessCompression().

sal_Int32 vcl::PDFExtOutDevData::mnCompressionQuality
private

Definition at line 86 of file pdfextoutdevdata.hxx.

Referenced by HasAdequateCompression(), and SetCompressionQuality().

sal_Int32 vcl::PDFExtOutDevData::mnPage
private
std::unique_ptr<GlobalSyncData> vcl::PDFExtOutDevData::mpGlobalSyncData
private
std::unique_ptr<PageSyncData> vcl::PDFExtOutDevData::mpPageSyncData
private
const OutputDevice& vcl::PDFExtOutDevData::mrOutDev
private

The documentation for this class was generated from the following files: