vcl::PDFWriter Class Reference

#include <pdfwriter.hxx>

Collaboration diagram for vcl::PDFWriter:

Classes
struct	AnyWidget
struct	CheckBoxWidget
struct	ComboBoxWidget
struct	EditWidget
struct	ExtLineInfo
struct	ListBoxWidget
struct	PDFDocInfo
struct	PDFEncryptionProperties
struct	PDFWriterContext
struct	PlayMetafileContext
	Play a metafile like an outputdevice would do. More...
struct	PushButtonWidget
struct	RadioButtonWidget
struct	SignatureWidget

Public Types
enum	CapType {   capButt ,   capRound ,   capSquare }
enum	JoinType {   joinMiter ,   joinRound ,   joinBevel }
enum class	Orientation {   Portrait ,   Inherit }
enum class	PDFVersion {   PDF_1_4 ,   PDF_1_5 ,   PDF_1_6 ,   PDF_1_7 ,   PDF_A_1 ,   PDF_A_2 ,   PDF_A_3 }
enum class	DestAreaType {   XYZ ,   FitRectangle }
enum	StructElement {   NonStructElement ,   Document ,   Part ,   Article ,   Section ,   Division ,   BlockQuote ,   Caption ,   TOC ,   TOCI ,   Index ,   Paragraph ,   Heading ,   H1 ,   H2 ,   H3 ,   H4 ,   H5 ,   H6 ,   List ,   ListItem ,   LILabel ,   LIBody ,   Table ,   TableRow ,   TableHeader ,   TableData ,   Span ,   Quote ,   Note ,   Reference ,   BibEntry ,   Code ,   Link ,   Annot ,   Figure ,   Formula ,   Form }
enum	StructAttribute {   Type ,   Subtype ,   Placement ,   WritingMode ,   SpaceBefore ,   SpaceAfter ,   StartIndent ,   EndIndent ,   TextIndent ,   TextAlign ,   Width ,   Height ,   BlockAlign ,   InlineAlign ,   LineHeight ,   BaselineShift ,   TextDecorationType ,   ListNumbering ,   RowSpan ,   ColSpan ,   Scope ,   Role ,   LinkAnnotation ,   Language }
enum	StructAttributeValue {   Invalid ,   NONE ,   Pagination ,   Layout ,   Page ,   Background ,   Header ,   Footer ,   Watermark ,   Block ,   Inline ,   Before ,   After ,   Start ,   End ,   LrTb ,   RlTb ,   TbRl ,   Center ,   Justify ,   Auto ,   Middle ,   Normal ,   Underline ,   Overline ,   LineThrough ,   Row ,   Column ,   Both ,   Rb ,   Cb ,   Pb ,   Tv ,   Disc ,   Circle ,   Square ,   Decimal ,   UpperRoman ,   LowerRoman ,   UpperAlpha ,   LowerAlpha }
enum class	PageTransition {   Regular ,   SplitHorizontalInward ,   SplitHorizontalOutward ,   SplitVerticalInward ,   SplitVerticalOutward ,   BlindsHorizontal ,   BlindsVertical ,   BoxInward ,   BoxOutward ,   WipeLeftToRight ,   WipeBottomToTop ,   WipeRightToLeft ,   WipeTopToBottom ,   Dissolve }
enum	WidgetType {   PushButton ,   RadioButton ,   CheckBox ,   Edit ,   ListBox ,   ComboBox ,   Hierarchy ,   Signature }
enum	FormatType {   Text ,   Number ,   Time ,   Date }
enum	ErrorCode {   Warning_Transparency_Omitted_PDFA ,   Warning_Transparency_Omitted_PDF13 ,   Warning_FormAction_Omitted_PDFA ,   Warning_Transparency_Converted ,   Error_Signature_Failed }
enum	ExportDataFormat {   HTML ,   XML ,   FDF ,   PDF }
enum	PDFViewerPageMode {   ModeDefault ,   UseOutlines ,   UseThumbs }
enum	PDFViewerAction {   ActionDefault ,   FitInWindow ,   FitWidth ,   FitVisible ,   ActionZoom }
enum	PDFPageLayout {   DefaultLayout ,   SinglePage ,   Continuous ,   ContinuousFacing }
enum	PDFLinkDefaultAction {   URIAction ,   URIActionDestination ,   LaunchAction }
enum	ColorMode {   DrawColor ,   DrawGreyscale }

Public Member Functions
	PDFWriter (const PDFWriterContext &rContext, const css::uno::Reference< css::beans::XMaterialHolder > &)
	~PDFWriter ()
OutputDevice *	GetReferenceDevice ()
	Returns an OutputDevice for formatting This Output device is guaranteed to use the same font metrics as the resulting PDF file. More...
void	NewPage (double nPageWidth, double nPageHeight, Orientation eOrientation=Orientation::Inherit)
	Creates a new page to fill If width and height are not set the page size is inherited from the page tree other effects: resets the graphics state: MapMode, Font Colors and other state information MUST be set again or are undefined. More...
void	PlayMetafile (const GDIMetaFile &, const PlayMetafileContext &, vcl::PDFExtOutDevData *pDevDat=nullptr)
void	SetDocumentLocale (const css::lang::Locale &rDocLocale)
bool	Emit ()
std::set< ErrorCode > const &	GetErrors () const
void	Push (PushFlags nFlags=PushFlags::ALL)
void	Pop ()
void	SetClipRegion ()
void	SetClipRegion (const basegfx::B2DPolyPolygon &rRegion)
void	MoveClipRegion (tools::Long nHorzMove, tools::Long nVertMove)
void	IntersectClipRegion (const tools::Rectangle &rRect)
void	IntersectClipRegion (const basegfx::B2DPolyPolygon &rRegion)
void	SetLayoutMode (vcl::text::ComplexTextLayoutFlags nMode)
void	SetDigitLanguage (LanguageType eLang)
void	SetLineColor (const Color &rColor)
void	SetLineColor ()
void	SetFillColor (const Color &rColor)
void	SetFillColor ()
void	SetFont (const vcl::Font &rNewFont)
void	SetTextColor (const Color &rColor)
void	SetTextFillColor ()
void	SetTextFillColor (const Color &rColor)
void	SetTextLineColor ()
void	SetTextLineColor (const Color &rColor)
void	SetOverlineColor ()
void	SetOverlineColor (const Color &rColor)
void	SetTextAlign (::TextAlign eAlign)
void	SetMapMode (const MapMode &rNewMapMode)
void	DrawText (const Point &rPos, const OUString &rText)
void	DrawTextLine (const Point &rPos, tools::Long nWidth, FontStrikeout eStrikeout, FontLineStyle eUnderline, FontLineStyle eOverline)
void	DrawTextArray (const Point &rStartPt, const OUString &rStr, KernArraySpan aKernArray, o3tl::span< const sal_Bool > pKashidaAry, sal_Int32 nIndex, sal_Int32 nLen)
void	DrawStretchText (const Point &rStartPt, sal_Int32 nWidth, const OUString &rStr, sal_Int32 nIndex, sal_Int32 nLen)
void	DrawText (const tools::Rectangle &rRect, const OUString &rStr, DrawTextFlags nStyle)
void	DrawPixel (const Point &rPt, const Color &rColor)
void	DrawPixel (const Point &rPt)
void	DrawLine (const Point &rStartPt, const Point &rEndPt)
void	DrawLine (const Point &rStartPt, const Point &rEndPt, const LineInfo &rLineInfo)
void	DrawPolyLine (const tools::Polygon &rPoly)
void	DrawPolyLine (const tools::Polygon &rPoly, const LineInfo &rLineInfo)
void	DrawPolyLine (const tools::Polygon &rPoly, const ExtLineInfo &rInfo)
void	DrawPolygon (const tools::Polygon &rPoly)
void	DrawPolyPolygon (const tools::PolyPolygon &rPolyPoly)
void	DrawRect (const tools::Rectangle &rRect)
void	DrawRect (const tools::Rectangle &rRect, sal_uInt32 nHorzRount, sal_uInt32 nVertRound)
void	DrawEllipse (const tools::Rectangle &rRect)
void	DrawArc (const tools::Rectangle &rRect, const Point &rStartPt, const Point &rEndPt)
void	DrawPie (const tools::Rectangle &rRect, const Point &rStartPt, const Point &rEndPt)
void	DrawChord (const tools::Rectangle &rRect, const Point &rStartPt, const Point &rEndPt)
void	DrawBitmap (const Point &rDestPt, const Size &rDestSize, const Bitmap &rBitmap, const Graphic &rGraphic)
void	DrawBitmapEx (const Point &rDestPt, const Size &rDestSize, const BitmapEx &rBitmapEx)
void	DrawGradient (const tools::Rectangle &rRect, const Gradient &rGradient)
void	DrawGradient (const tools::PolyPolygon &rPolyPoly, const Gradient &rGradient)
void	DrawHatch (const tools::PolyPolygon &rPolyPoly, const Hatch &rHatch)
void	DrawWallpaper (const tools::Rectangle &rRect, const Wallpaper &rWallpaper)
void	DrawTransparent (const tools::PolyPolygon &rPolyPoly, sal_uInt16 nTransparencePercent)
void	BeginTransparencyGroup ()
	Start a transparency group. More...
void	EndTransparencyGroup (const tools::Rectangle &rBoundRect, sal_uInt16 nTransparencePercent)
	End a transparency group with constant transparency factor. More...
void	DrawJPGBitmap (SvStream &rJPGData, bool bIsTrueColor, const Size &rSrcSizePixel, const tools::Rectangle &rTargetArea, const AlphaMask &rAlphaMask, const Graphic &rGraphic)
	Insert a JPG encoded image (optionally with mask) More...
sal_Int32	CreateNamedDest (const OUString &sDestName, const tools::Rectangle &rRect, sal_Int32 nPageNr, DestAreaType eType)
	Create a new named destination to be used in a link from another PDF document. More...
sal_Int32	CreateDest (const tools::Rectangle &rRect, sal_Int32 nPageNr, DestAreaType eType)
	Create a new destination to be used in a link. More...
sal_Int32	CreateLink (const tools::Rectangle &rRect, sal_Int32 nPageNr, OUString const &rAltText)
	Create a new link on a page. More...
sal_Int32	CreateScreen (const tools::Rectangle &rRect, sal_Int32 nPageNr, OUString const &rAltText, OUString const &rMimeType)
	Creates a screen annotation. More...
sal_Int32	RegisterDestReference (sal_Int32 nDestId, const tools::Rectangle &rRect, sal_Int32 nPageNr, DestAreaType eType)
	creates a destination which is not intended to be referred to by a link, but by a public destination Id. More...
void	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. More...
void	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. More...
void	SetScreenURL (sal_Int32 nScreenId, const OUString &rURL)
	Sets the URL of a linked screen annotation. More...
void	SetScreenStream (sal_Int32 nScreenId, const OUString &rURL)
	Sets the URL of an embedded screen annotation. More...
void	SetLinkPropertyID (sal_Int32 nLinkId, sal_Int32 nPropertyID)
	Resolve link in logical structure. More...
sal_Int32	CreateOutlineItem (sal_Int32 nParent, std::u16string_view rText, sal_Int32 nDestID)
	Create a new outline item. More...
void	CreateNote (const tools::Rectangle &rRect, const PDFNote &rNote, sal_Int32 nPageNr)
	Create a new note on a page. More...
void	BeginStructureElement (sal_Int32 id)
	begin a new logical structure element More...
sal_Int32	EnsureStructureElement ()
void	InitStructureElement (sal_Int32 id, PDFWriter::StructElement eType, std::u16string_view rAlias)
void	EndStructureElement ()
	end the current logical structure element More...
void	SetCurrentStructureElement (sal_Int32 nElement)
	set the current structure element More...
void	SetStructureAttribute (enum StructAttribute eAttr, enum StructAttributeValue eVal)
	set a structure attribute on the current structural element More...
void	SetStructureAttributeNumerical (enum 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	SetStructureAnnotIds (::std::vector< sal_Int32 > const &rAnnotIds)
	set the annotations that should be referenced as children of the current 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 (PageTransition eType, sal_uInt32 nMilliSec, sal_Int32 nPageNr)
	Sets the transitional effect to be applied when the current page gets shown. More...
sal_Int32	CreateControl (const AnyWidget &rControlType)
	create a new form control More...
void	AddAttachedFile (OUString const &rFileName, OUString const &rMimeType, OUString const &rDescription, std::unique_ptr< PDFOutputStream > pStream)
	Attaches an additional file to the PDF file. More...

Static Public Member Functions
static css::uno::Reference< css::beans::XMaterialHolder >	InitEncryption (const OUString &i_rOwnerPassword, const OUString &i_rUserPassword)
static void	AppendUnicodeTextString (const OUString &rString, OStringBuffer &rBuffer)
	Write rString as a PDF hex string into rBuffer. More...
static OString	GetDateTime ()
	Get current date/time in PDF D:YYYYMMDDHHMMSS form. More...

Private Member Functions
	PDFWriter (const PDFWriter &)=delete
PDFWriter &	operator= (const PDFWriter &)=delete

Private Attributes
ScopedVclPtr< PDFWriterImpl >	xImplementation

Detailed Description

Definition at line 82 of file pdfwriter.hxx.

Member Enumeration Documentation

CapType

enum vcl::PDFWriter::CapType

Enumerator
capButt
capRound
capSquare

Definition at line 91 of file pdfwriter.hxx.

ColorMode

enum vcl::PDFWriter::ColorMode

Enumerator
DrawColor
DrawGreyscale

Definition at line 566 of file pdfwriter.hxx.

DestAreaType

enum class vcl::PDFWriter::DestAreaType

strong

Enumerator
XYZ
FitRectangle

Definition at line 116 of file pdfwriter.hxx.

ErrorCode

enum vcl::PDFWriter::ErrorCode

Enumerator
Warning_Transparency_Omitted_PDFA
Warning_Transparency_Omitted_PDF13
Warning_FormAction_Omitted_PDFA
Warning_Transparency_Converted
Error_Signature_Failed

Definition at line 215 of file pdfwriter.hxx.

ExportDataFormat

enum vcl::PDFWriter::ExportDataFormat

Enumerator
HTML
XML
FDF
PDF

Definition at line 475 of file pdfwriter.hxx.

FormatType

enum vcl::PDFWriter::FormatType

Enumerator
Text
Number
Time
Date

Definition at line 210 of file pdfwriter.hxx.

JoinType

enum vcl::PDFWriter::JoinType

Enumerator
joinMiter
joinRound
joinBevel

Definition at line 92 of file pdfwriter.hxx.

Orientation

enum class vcl::PDFWriter::Orientation

strong

Enumerator
Portrait
Inherit

Definition at line 110 of file pdfwriter.hxx.

PageTransition

enum class vcl::PDFWriter::PageTransition

strong

Enumerator
Regular
SplitHorizontalInward
SplitHorizontalOutward
SplitVerticalInward
SplitVerticalOutward
BlindsHorizontal
BlindsVertical
BoxInward
BoxOutward
WipeLeftToRight
WipeBottomToTop
WipeRightToLeft
WipeTopToBottom
Dissolve

Definition at line 193 of file pdfwriter.hxx.

PDFLinkDefaultAction

enum vcl::PDFWriter::PDFLinkDefaultAction

Enumerator
URIAction
URIActionDestination
LaunchAction

Definition at line 504 of file pdfwriter.hxx.

PDFPageLayout

enum vcl::PDFWriter::PDFPageLayout

Enumerator
DefaultLayout
SinglePage
Continuous
ContinuousFacing

Definition at line 494 of file pdfwriter.hxx.

PDFVersion

enum class vcl::PDFWriter::PDFVersion

strong

Enumerator
PDF_1_4
PDF_1_5
PDF_1_6
PDF_1_7
PDF_A_1
PDF_A_2
PDF_A_3

Definition at line 113 of file pdfwriter.hxx.

PDFViewerAction

enum vcl::PDFWriter::PDFViewerAction

Enumerator
ActionDefault
FitInWindow
FitWidth
FitVisible
ActionZoom

Definition at line 485 of file pdfwriter.hxx.

PDFViewerPageMode

enum vcl::PDFWriter::PDFViewerPageMode

Enumerator
ModeDefault
UseOutlines
UseThumbs

Definition at line 478 of file pdfwriter.hxx.

StructAttribute

enum vcl::PDFWriter::StructAttribute

Enumerator
Type
Subtype
Placement
WritingMode
SpaceBefore
SpaceAfter
StartIndent
EndIndent
TextIndent
TextAlign
Width
Height
BlockAlign
InlineAlign
LineHeight
BaselineShift
TextDecorationType
ListNumbering
RowSpan
ColSpan
Scope
Role
LinkAnnotation
Language

Definition at line 140 of file pdfwriter.hxx.

StructAttributeValue

enum vcl::PDFWriter::StructAttributeValue

Enumerator
Invalid
NONE
Pagination
Layout
Page
Background
Header
Footer
Watermark
Block
Inline
Before
After
Start
End
LrTb
RlTb
TbRl
Center
Justify
Auto
Middle
Normal
Underline
Overline
LineThrough
Row
Column
Both
Rb
Cb
Pb
Tv
Disc
Circle
Square
Decimal
UpperRoman
LowerRoman
UpperAlpha
LowerAlpha

Definition at line 164 of file pdfwriter.hxx.

StructElement

enum vcl::PDFWriter::StructElement

Enumerator
NonStructElement
Document
Part
Article
Section
Division
BlockQuote
Caption
TOC
TOCI
Index
Paragraph
Heading
H1
H2
H3
H4
H5
H6
List
ListItem
LILabel
LIBody
Table
TableRow
TableHeader
TableData
Span
Quote
Note
Reference
BibEntry
Code
Link
Annot
Figure
Formula
Form

Definition at line 120 of file pdfwriter.hxx.

WidgetType

enum vcl::PDFWriter::WidgetType

Enumerator
PushButton
RadioButton
CheckBox
Edit
ListBox
ComboBox
Hierarchy
Signature

Definition at line 204 of file pdfwriter.hxx.

Constructor & Destructor Documentation

PDFWriter() [1/2]

vcl::PDFWriter::PDFWriter ( const PDFWriter &  )

privatedelete

PDFWriter() [2/2]

PDFWriter::PDFWriter	(	const PDFWriterContext &	rContext,
		const css::uno::Reference< css::beans::XMaterialHolder > &	xEnc
	)

Definition at line 30 of file pdfwriter.cxx.

References Create().

~PDFWriter()

PDFWriter::~PDFWriter

(

)

Definition at line 36 of file pdfwriter.cxx.

References xImplementation.

Member Function Documentation

AddAttachedFile()

void PDFWriter::AddAttachedFile	(	OUString const &	rFileName,
		OUString const &	rMimeType,
		OUString const &	rDescription,
		std::unique_ptr< PDFOutputStream >	pStream
	)

Attaches an additional file to the PDF file.

This function adds an arbitrary stream that represents an attached file in the PDF file.

This also adds an additional stream array entry (with the mimetype) in the trailer dictionary for backwards compatibility.

Parameters

rFileName	the filename of the additional file as presented in the stream
rMimeType	the mimetype of the stream
pStream	the interface to the additional stream

Definition at line 462 of file pdfwriter.cxx.

References xImplementation.

AppendUnicodeTextString()

void vcl::PDFWriter::AppendUnicodeTextString ( const OUString &  rString, OStringBuffer &  rBuffer  )

static

Write rString as a PDF hex string into rBuffer.

Definition at line 307 of file pdfwriter_impl.cxx.

References i.

Referenced by vcl::PDFWriterImpl::appendUnicodeTextStringEncrypt(), vcl::PDFWriterImpl::computeDocumentIdentifier(), vcl::PDFWriterImpl::emitCatalog(), and vcl::filter::PDFDocument::WriteSignatureObject().

BeginStructureElement()

void PDFWriter::BeginStructureElement

(

sal_Int32

id

)

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.

The easy way is to call WrapBeginStructureElement, but it's also possible to call EnsureStructureElement/InitStructureElement/BeginStructureElement (its 3 parts) manually for more control; this way a placeholder SE can be inserted and initialised later.

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(). All children of a NonStructElement will not be part of the structure. Nonetheless if you add a child structural element to a NonStructElement you will still have to call EndStructureElement for it. Best think of the structure tree as a stack.

Note: there is always one structural element in existence without having called BeginStructureElement; this is the root of the structure tree (called StructTreeRoot). The StructTreeRoot has always the id 0.

Parameters

eType	denotes what kind of element to begin (e.g. a heading or paragraph)
rAlias	the 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 new structure element's id for use in SetCurrentStructureElement

Definition at line 403 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

BeginTransparencyGroup()

void PDFWriter::BeginTransparencyGroup

(

)

Start a transparency group.

Drawing operations can be grouped together to acquire a common transparency behaviour; after calling BeginTransparencyGroup all drawing operations will be grouped together into a transparent object.

The transparency behaviour is set with one of the EndTransparencyGroup calls and can be either a constant transparency factor or a transparent soft mask in form of an 8 bit gray scale bitmap.

It is permissible to nest transparency group.

Transparency groups MUST NOT span multiple pages

Transparency is a feature introduced in PDF1.4, so transparency group will be ignored if the produced PDF has a lower version. The drawing operations will be emitted normally.

Definition at line 218 of file pdfwriter.cxx.

References xImplementation.

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

CreateControl()

sal_Int32 PDFWriter::CreateControl

(

const 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

rControlType

a descendant of AnyWidget determining the control's properties

Returns

the new control's id for reference purposes

Definition at line 453 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

CreateDest()

sal_Int32 PDFWriter::CreateDest	(	const tools::Rectangle &	rRect,
		sal_Int32	nPageNr,
		PDFWriter::DestAreaType	eType
	)

Create a new destination to be used in a link.

Parameters

rRect	target rectangle on page to be displayed if dest is jumped to
nPageNr	number of page the dest is on (as returned by NewPage) or -1 in which case the current page is used
eType	what dest type to use

Returns

the destination id (to be used in SetLinkDest) or -1 if page id does not exist

Definition at line 352 of file pdfwriter.cxx.

References eType, and xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

CreateLink()

sal_Int32 PDFWriter::CreateLink	(	const tools::Rectangle &	rRect,
		sal_Int32	nPageNr,
		OUString const &	rAltText
	)

Create a new link on a page.

Parameters

rRect	active rectangle of the link (that is the area that has to be hit to activate the link)
nPageNr	number 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 333 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

CreateNamedDest()

sal_Int32 PDFWriter::CreateNamedDest	(	const OUString &	sDestName,
		const tools::Rectangle &	rRect,
		sal_Int32	nPageNr,
		PDFWriter::DestAreaType	eType
	)

Create a new named destination to be used in a link from another PDF document.

Parameters

sDestName	the name (label) of the bookmark, to be used to jump to
rRect	target rectangle on page to be displayed if dest is jumped to
nPageNr	number of page the dest is on (as returned by NewPage) or -1 in which case the current page is used
eType	what dest type to use

Returns

the destination id (to be used in SetLinkDest) or -1 if page id does not exist

Definition at line 348 of file pdfwriter.cxx.

References eType, and xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

CreateNote()

void PDFWriter::CreateNote	(	const tools::Rectangle &	rRect,
		const PDFNote &	rNote,
		sal_Int32	nPageNr
	)

Create a new note on a page.

Parameters

rRect	active rectangle of the note (that is the area that has to be hit to popup the annotation)
rNote	specifies the contents of the note
nPageNr	number of page the note is on (as returned by NewPage) or -1 in which case the current page is used

Definition at line 387 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

CreateOutlineItem()

sal_Int32 PDFWriter::CreateOutlineItem	(	sal_Int32	nParent,
		std::u16string_view	rText,
		sal_Int32	nDestID
	)

Create a new outline item.

Parameters

nParent	declares the parent of the new item in the outline hierarchy. An invalid value will result in a new toplevel item.
rText	sets the title text of the item
nDestID	declares which Dest (created with CreateDest) the outline item will point to

Returns

the outline item id of the new item

Definition at line 382 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

CreateScreen()

sal_Int32 PDFWriter::CreateScreen	(	const tools::Rectangle &	rRect,
		sal_Int32	nPageNr,
		OUString const &	rAltText,
		OUString const &	rMimeType
	)

Creates a screen annotation.

Definition at line 338 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

DrawArc()

void PDFWriter::DrawArc	(	const tools::Rectangle &	rRect,
		const Point &	rStartPt,
		const Point &	rEndPt
	)

Definition at line 145 of file pdfwriter.cxx.

References xImplementation.

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

DrawBitmap()

void PDFWriter::DrawBitmap	(	const Point &	rDestPt,
		const Size &	rDestSize,
		const Bitmap &	rBitmap,
		const Graphic &	rGraphic
	)

Definition at line 180 of file pdfwriter.cxx.

References xImplementation.

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

DrawBitmapEx()

void PDFWriter::DrawBitmapEx	(	const Point &	rDestPt,
		const Size &	rDestSize,
		const BitmapEx &	rBitmapEx
	)

Definition at line 185 of file pdfwriter.cxx.

References xImplementation.

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

DrawChord()

void PDFWriter::DrawChord	(	const tools::Rectangle &	rRect,
		const Point &	rStartPt,
		const Point &	rEndPt
	)

Definition at line 155 of file pdfwriter.cxx.

References xImplementation.

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

DrawEllipse()

void PDFWriter::DrawEllipse

(

const tools::Rectangle &

rRect

)

Definition at line 140 of file pdfwriter.cxx.

References xImplementation.

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

DrawGradient() [1/2]

void PDFWriter::DrawGradient	(	const tools::PolyPolygon &	rPolyPoly,
		const Gradient &	rGradient
	)

Definition at line 200 of file pdfwriter.cxx.

References vcl::CLIPREGION, tools::PolyPolygon::getB2DPolyPolygon(), tools::PolyPolygon::GetBoundRect(), and xImplementation.

DrawGradient() [2/2]

void PDFWriter::DrawGradient	(	const tools::Rectangle &	rRect,
		const Gradient &	rGradient
	)

Definition at line 195 of file pdfwriter.cxx.

References xImplementation.

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

DrawHatch()

void PDFWriter::DrawHatch	(	const tools::PolyPolygon &	rPolyPoly,
		const Hatch &	rHatch
	)

Definition at line 190 of file pdfwriter.cxx.

References xImplementation.

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

DrawJPGBitmap()

void PDFWriter::DrawJPGBitmap	(	SvStream &	rJPGData,
		bool	bIsTrueColor,
		const Size &	rSrcSizePixel,
		const tools::Rectangle &	rTargetArea,
		const AlphaMask &	rAlphaMask,
		const Graphic &	rGraphic
	)

Insert a JPG encoded image (optionally with mask)

Parameters

rJPGData	a Stream containing the encoded image
bIsTrueColor	true: jpeg is 24 bit true color, false: jpeg is 8 bit greyscale
rSrcSizePixel	size in pixel of the image
rTargetArea	where to put the image
rMask	optional mask; if not empty it must have the same pixel size as the image and be either 1 bit black&white or 8 bit grey

Definition at line 328 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PDFWriterImpl::implWriteBitmapEx(), and vcl::PageSyncData::PlaySyncPageAct().

DrawLine() [1/2]

void PDFWriter::DrawLine	(	const Point &	rStartPt,
		const Point &	rEndPt
	)

Definition at line 110 of file pdfwriter.cxx.

References xImplementation.

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

DrawLine() [2/2]

void PDFWriter::DrawLine	(	const Point &	rStartPt,
		const Point &	rEndPt,
		const LineInfo &	rLineInfo
	)

Definition at line 115 of file pdfwriter.cxx.

References xImplementation.

DrawPie()

void PDFWriter::DrawPie	(	const tools::Rectangle &	rRect,
		const Point &	rStartPt,
		const Point &	rEndPt
	)

Definition at line 150 of file pdfwriter.cxx.

References xImplementation.

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

DrawPixel() [1/2]

void vcl::PDFWriter::DrawPixel ( const Point &  rPt )

inline

Definition at line 791 of file pdfwriter.hxx.

References COL_TRANSPARENT().

DrawPixel() [2/2]

void PDFWriter::DrawPixel	(	const Point &	rPt,
		const Color &	rColor
	)

Definition at line 175 of file pdfwriter.cxx.

References xImplementation.

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

DrawPolygon()

void PDFWriter::DrawPolygon

(

const tools::Polygon &

rPoly

)

Definition at line 120 of file pdfwriter.cxx.

References xImplementation.

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

DrawPolyLine() [1/3]

void PDFWriter::DrawPolyLine

(

const tools::Polygon &

rPoly

)

Definition at line 125 of file pdfwriter.cxx.

References xImplementation.

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

DrawPolyLine() [2/3]

void PDFWriter::DrawPolyLine	(	const tools::Polygon &	rPoly,
		const ExtLineInfo &	rInfo
	)

Definition at line 165 of file pdfwriter.cxx.

References xImplementation.

DrawPolyLine() [3/3]

void PDFWriter::DrawPolyLine	(	const tools::Polygon &	rPoly,
		const LineInfo &	rLineInfo
	)

Definition at line 160 of file pdfwriter.cxx.

References xImplementation.

DrawPolyPolygon()

void PDFWriter::DrawPolyPolygon

(

const tools::PolyPolygon &

rPolyPoly

)

Definition at line 170 of file pdfwriter.cxx.

References xImplementation.

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

DrawRect() [1/2]

void PDFWriter::DrawRect

(

const tools::Rectangle &

rRect

)

Definition at line 130 of file pdfwriter.cxx.

References xImplementation.

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

DrawRect() [2/2]

void PDFWriter::DrawRect	(	const tools::Rectangle &	rRect,
		sal_uInt32	nHorzRount,
		sal_uInt32	nVertRound
	)

Definition at line 135 of file pdfwriter.cxx.

References xImplementation.

DrawStretchText()

void PDFWriter::DrawStretchText	(	const Point &	rStartPt,
		sal_Int32	nWidth,
		const OUString &	rStr,
		sal_Int32	nIndex,
		sal_Int32	nLen
	)

Definition at line 92 of file pdfwriter.cxx.

References nIndex, and xImplementation.

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

DrawText() [1/2]

void PDFWriter::DrawText	(	const Point &	rPos,
		const OUString &	rText
	)

Definition at line 66 of file pdfwriter.cxx.

References xImplementation.

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

DrawText() [2/2]

void PDFWriter::DrawText	(	const tools::Rectangle &	rRect,
		const OUString &	rStr,
		DrawTextFlags	nStyle
	)

Definition at line 102 of file pdfwriter.cxx.

References xImplementation.

DrawTextArray()

void PDFWriter::DrawTextArray	(	const Point &	rStartPt,
		const OUString &	rStr,
		KernArraySpan	aKernArray,
		o3tl::span< const sal_Bool >	pKashidaAry,
		sal_Int32	nIndex,
		sal_Int32	nLen
	)

Definition at line 81 of file pdfwriter.cxx.

References nIndex, and xImplementation.

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

DrawTextLine()

void PDFWriter::DrawTextLine	(	const Point &	rPos,
		tools::Long	nWidth,
		FontStrikeout	eStrikeout,
		FontLineStyle	eUnderline,
		FontLineStyle	eOverline
	)

Definition at line 71 of file pdfwriter.cxx.

References xImplementation.

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

DrawTransparent()

void PDFWriter::DrawTransparent	(	const tools::PolyPolygon &	rPolyPoly,
		sal_uInt16	nTransparencePercent
	)

Definition at line 213 of file pdfwriter.cxx.

References xImplementation.

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

DrawWallpaper()

void PDFWriter::DrawWallpaper	(	const tools::Rectangle &	rRect,
		const Wallpaper &	rWallpaper
	)

Definition at line 208 of file pdfwriter.cxx.

References xImplementation.

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

Emit()

bool PDFWriter::Emit

(

)

Definition at line 51 of file pdfwriter.cxx.

References xImplementation.

EndStructureElement()

void PDFWriter::EndStructureElement

(

)

end the current logical structure element

Close the current structure element. The current element's parent becomes the current structure element again.

See also

BeginStructureElement

Definition at line 408 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

EndTransparencyGroup()

void PDFWriter::EndTransparencyGroup	(	const tools::Rectangle &	rBoundRect,
		sal_uInt16	nTransparencePercent
	)

End a transparency group with constant transparency factor.

This ends a transparency group and inserts it on the current page. The coordinates of the group result out of the grouped drawing operations.

Parameters

rBoundRect	The bounding rectangle of the group
nTransparencePercent	The transparency factor

Definition at line 223 of file pdfwriter.cxx.

References xImplementation.

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

EnsureStructureElement()

sal_Int32 PDFWriter::EnsureStructureElement

(

)

Definition at line 392 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

GetDateTime()

OString vcl::PDFWriter::GetDateTime ( )

static

Get current date/time in PDF D:YYYYMMDDHHMMSS form.

Definition at line 1383 of file pdfwriter_impl.cxx.

Referenced by vcl::PDFWriterImpl::setupDocInfo(), and vcl::filter::PDFDocument::WriteSignatureObject().

GetErrors()

std::set< PDFWriter::ErrorCode > const & PDFWriter::GetErrors

(

)

const

Definition at line 467 of file pdfwriter.cxx.

References xImplementation.

GetReferenceDevice()

OutputDevice * PDFWriter::GetReferenceDevice

(

)

Returns an OutputDevice for formatting This Output device is guaranteed to use the same font metrics as the resulting PDF file.

Returns

the reference output device

Definition at line 41 of file pdfwriter.cxx.

References xImplementation.

InitEncryption()

css::uno::Reference< css::beans::XMaterialHolder > PDFWriter::InitEncryption ( const OUString &  i_rOwnerPassword, const OUString &  i_rUserPassword  )

static

Definition at line 473 of file pdfwriter.cxx.

References vcl::PDFWriterImpl::initEncryption().

InitStructureElement()

void PDFWriter::InitStructureElement	(	sal_Int32	id,
		PDFWriter::StructElement	eType,
		std::u16string_view	rAlias
	)

Definition at line 397 of file pdfwriter.cxx.

References eType, and xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

IntersectClipRegion() [1/2]

void PDFWriter::IntersectClipRegion

(

const basegfx::B2DPolyPolygon &

rRegion

)

Definition at line 268 of file pdfwriter.cxx.

References xImplementation.

IntersectClipRegion() [2/2]

void PDFWriter::IntersectClipRegion

(

const tools::Rectangle &

rRect

)

Definition at line 273 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PDFWriterImpl::implWriteGradient(), and vcl::PDFWriterImpl::playMetafile().

MoveClipRegion()

void PDFWriter::MoveClipRegion	(	tools::Long	nHorzMove,
		tools::Long	nVertMove
	)

Definition at line 263 of file pdfwriter.cxx.

References xImplementation.

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

NewPage()

void PDFWriter::NewPage	(	double	nPageWidth,
		double	nPageHeight,
		Orientation	eOrientation = Orientation::Inherit
	)

Creates a new page to fill If width and height are not set the page size is inherited from the page tree other effects: resets the graphics state: MapMode, Font Colors and other state information MUST be set again or are undefined.

Definition at line 46 of file pdfwriter.cxx.

References xImplementation.

operator=()

PDFWriter & vcl::PDFWriter::operator= ( const PDFWriter &  )

privatedelete

PlayMetafile()

void PDFWriter::PlayMetafile	(	const GDIMetaFile &	i_rMTF,
		const PlayMetafileContext &	i_rPlayContext,
		vcl::PDFExtOutDevData *	pDevDat = nullptr
	)

Definition at line 480 of file pdfwriter.cxx.

References xImplementation.

Pop()

void PDFWriter::Pop

(

)

Definition at line 233 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PDFWriterImpl::implWriteGradient(), vcl::GlobalSyncData::PlayGlobalActions(), vcl::PDFWriterImpl::playMetafile(), and vcl::PageSyncData::PlaySyncPageAct().

Push()

void PDFWriter::Push

(

PushFlags

nFlags = PushFlags::ALL

)

Definition at line 228 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PDFWriterImpl::implWriteGradient(), vcl::GlobalSyncData::PlayGlobalActions(), vcl::PDFWriterImpl::playMetafile(), and vcl::PageSyncData::PlaySyncPageAct().

RegisterDestReference()

sal_Int32 PDFWriter::RegisterDestReference	(	sal_Int32	nDestId,
		const tools::Rectangle &	rRect,
		sal_Int32	nPageNr,
		DestAreaType	eType
	)

creates a destination which is not intended to be referred to by a link, but by a public destination Id.

Form widgets, for instance, might refer to a destination, without ever actually creating a source link to point to this destination. In such cases, a public destination Id will be assigned to the form widget, and later on, the concrete destination data for this public Id will be registered using RegisterDestReference.

Parameters

nDestId	destination ID
rRect	target rectangle on page to be displayed if dest is jumped to
nPageNr	number of page the dest is on (as returned by NewPage) or -1 in which case the current page is used
eType	what dest type to use

Returns

the internal destination Id.

Definition at line 343 of file pdfwriter.cxx.

References eType, and xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

SetActualText()

void PDFWriter::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

rText

contains the complete logical text the structural element displays.

Definition at line 438 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetAlternateText()

void PDFWriter::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

rText

contains the replacement text for the structural element

Definition at line 443 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetClipRegion() [1/2]

void PDFWriter::SetClipRegion

(

)

Definition at line 253 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PDFWriterImpl::playMetafile(), and vcl::PageSyncData::PlaySyncPageAct().

SetClipRegion() [2/2]

void PDFWriter::SetClipRegion

(

const basegfx::B2DPolyPolygon &

rRegion

)

Definition at line 258 of file pdfwriter.cxx.

References xImplementation.

SetCurrentStructureElement()

void PDFWriter::SetCurrentStructureElement

(

sal_Int32

nElement

)

set the current structure element

For different purposes it may be useful to paint a structure element's content discontinuously. 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

nElement

the id of the new current structure element

Definition at line 413 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetDigitLanguage()

void PDFWriter::SetDigitLanguage

(

LanguageType

eLang

)

Definition at line 283 of file pdfwriter.cxx.

References xImplementation.

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

SetDocumentLocale()

void PDFWriter::SetDocumentLocale

(

const css::lang::Locale &

rDocLocale

)

Definition at line 56 of file pdfwriter.cxx.

References xImplementation.

SetFillColor() [1/2]

void vcl::PDFWriter::SetFillColor ( )

inline

Definition at line 756 of file pdfwriter.hxx.

References COL_TRANSPARENT(), and SetFillColor().

Referenced by SetFillColor().

SetFillColor() [2/2]

void PDFWriter::SetFillColor

(

const Color &

rColor

)

Definition at line 248 of file pdfwriter.cxx.

References xImplementation.

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

SetFont()

void PDFWriter::SetFont

(

const vcl::Font &

rNewFont

)

Definition at line 61 of file pdfwriter.cxx.

References xImplementation.

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

SetLayoutMode()

void PDFWriter::SetLayoutMode

(

vcl::text::ComplexTextLayoutFlags

nMode

)

Definition at line 278 of file pdfwriter.cxx.

References xImplementation.

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

SetLineColor() [1/2]

void vcl::PDFWriter::SetLineColor ( )

inline

Definition at line 753 of file pdfwriter.hxx.

References COL_TRANSPARENT(), and SetLineColor().

Referenced by SetLineColor().

SetLineColor() [2/2]

void PDFWriter::SetLineColor

(

const Color &

rColor

)

Definition at line 243 of file pdfwriter.cxx.

References xImplementation.

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

SetLinkDest()

void PDFWriter::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

nLinkId	the link to be changed
nDestId	the dest the link shall point to

Definition at line 357 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

SetLinkPropertyID()

void PDFWriter::SetLinkPropertyID	(	sal_Int32	nLinkId,
		sal_Int32	nPropertyID
	)

Resolve link in logical structure.

If a link is created after the corresponding visual appearance was drawn it is not possible to set the link id as a property attribute to the link structure item that should be created in tagged PDF around the visual appearance of a link.

For this reason an arbitrary id can be given to SetStructureAttributeNumerical at the time the text for the link is drawn. To resolve this arbitrary id again when the actual link annotation is created use SetLinkPropertyID. When Emit finally gets called all LinkAnnotation type structure attributes will be replaced with the correct link id.

CAUTION: this technique must be used either for all or none of the links in a document since the link id space and arbitrary property id space could overlap and it would be impossible to resolve whether a Link structure attribute value was arbitrary or already a real id.

Parameters

nLinkId	the link to be mapped
nPropertyID	the arbitrary id set in a Link structure element to address the link with real id nLinkId

Definition at line 377 of file pdfwriter.cxx.

References nPropertyId, and xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions(), and vcl::PageSyncData::PlaySyncPageAct().

SetLinkURL()

void PDFWriter::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

nLinkId	the link to be changed
rURL	the URL the link shall point to. The URL will be parsed (and corrected) by the com.sun.star.util.URLTransformer service; the result will then appear literally in the PDF file produced

Definition at line 362 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

SetMapMode()

void PDFWriter::SetMapMode

(

const MapMode &

rNewMapMode

)

Definition at line 238 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions(), and vcl::PDFWriterImpl::playMetafile().

SetOverlineColor() [1/2]

void PDFWriter::SetOverlineColor

(

)

Definition at line 313 of file pdfwriter.cxx.

References xImplementation.

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

SetOverlineColor() [2/2]

void PDFWriter::SetOverlineColor

(

const Color &

rColor

)

Definition at line 318 of file pdfwriter.cxx.

References xImplementation.

SetPageTransition()

void PDFWriter::SetPageTransition	(	PDFWriter::PageTransition	eType,
		sal_uInt32	nMilliSec,
		sal_Int32	nPageNr
	)

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

Parameters

eType	the kind of effect to be used; use Regular to disable transitional effects for this page
nMilliSec	the duration of the transitional effect in milliseconds; set 0 to disable transitional effects
nPageNr	the page number to apply the effect to; -1 denotes the current page

Definition at line 448 of file pdfwriter.cxx.

References eType, and xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

SetScreenStream()

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

Sets the URL of an embedded screen annotation.

Definition at line 372 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

SetScreenURL()

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

Sets the URL of a linked screen annotation.

Definition at line 367 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::GlobalSyncData::PlayGlobalActions().

SetStructureAnnotIds()

void PDFWriter::SetStructureAnnotIds

(

::std::vector< sal_Int32 > const &

rAnnotIds

)

set the annotations that should be referenced as children of the current structural element.

Definition at line 433 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetStructureAttribute()

void PDFWriter::SetStructureAttribute	(	enum StructAttribute	eAttr,
		enum 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

eAttr	denotes what attribute to change
eVal	the value to set the attribute to

Definition at line 418 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetStructureAttributeNumerical()

void PDFWriter::SetStructureAttributeNumerical	(	enum 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

eAttr	denotes what attribute to change
nValue	the value to set the attribute to

Definition at line 423 of file pdfwriter.cxx.

References nValue, and xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetStructureBoundingBox()

void PDFWriter::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

rRect

the new bounding box for the structural element

Definition at line 428 of file pdfwriter.cxx.

References xImplementation.

Referenced by vcl::PageSyncData::PlaySyncPageAct().

SetTextAlign()

void PDFWriter::SetTextAlign

(

::TextAlign

eAlign

)

Definition at line 323 of file pdfwriter.cxx.

References xImplementation.

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

SetTextColor()

void PDFWriter::SetTextColor

(

const Color &

rColor

)

Definition at line 288 of file pdfwriter.cxx.

References xImplementation.

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

SetTextFillColor() [1/2]

void PDFWriter::SetTextFillColor

(

)

Definition at line 293 of file pdfwriter.cxx.

References xImplementation.

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

SetTextFillColor() [2/2]

void PDFWriter::SetTextFillColor

(

const Color &

rColor

)

Definition at line 298 of file pdfwriter.cxx.

References xImplementation.

SetTextLineColor() [1/2]

void PDFWriter::SetTextLineColor

(

)

Definition at line 303 of file pdfwriter.cxx.

References xImplementation.

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

SetTextLineColor() [2/2]

void PDFWriter::SetTextLineColor

(

const Color &

rColor

)

Definition at line 308 of file pdfwriter.cxx.

References xImplementation.

Member Data Documentation

xImplementation

ScopedVclPtr<PDFWriterImpl> vcl::PDFWriter::xImplementation

private

Definition at line 84 of file pdfwriter.hxx.

Referenced by AddAttachedFile(), BeginStructureElement(), BeginTransparencyGroup(), CreateControl(), CreateDest(), CreateLink(), CreateNamedDest(), CreateNote(), CreateOutlineItem(), CreateScreen(), DrawArc(), DrawBitmap(), DrawBitmapEx(), DrawChord(), DrawEllipse(), DrawGradient(), DrawHatch(), DrawJPGBitmap(), DrawLine(), DrawPie(), DrawPixel(), DrawPolygon(), DrawPolyLine(), DrawPolyPolygon(), DrawRect(), DrawStretchText(), DrawText(), DrawTextArray(), DrawTextLine(), DrawTransparent(), DrawWallpaper(), Emit(), EndStructureElement(), EndTransparencyGroup(), EnsureStructureElement(), GetErrors(), GetReferenceDevice(), InitStructureElement(), IntersectClipRegion(), MoveClipRegion(), NewPage(), PlayMetafile(), Pop(), Push(), RegisterDestReference(), SetActualText(), SetAlternateText(), SetClipRegion(), SetCurrentStructureElement(), SetDigitLanguage(), SetDocumentLocale(), SetFillColor(), SetFont(), SetLayoutMode(), SetLineColor(), SetLinkDest(), SetLinkPropertyID(), SetLinkURL(), SetMapMode(), SetOverlineColor(), SetPageTransition(), SetScreenStream(), SetScreenURL(), SetStructureAnnotIds(), SetStructureAttribute(), SetStructureAttributeNumerical(), SetStructureBoundingBox(), SetTextAlign(), SetTextColor(), SetTextFillColor(), SetTextLineColor(), and ~PDFWriter().

---

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

• pdfwriter.hxx
• pdfwriter.cxx
• pdfwriter_impl.cxx