Poppler::LinkRendition Class Reference

#include <poppler-link.h>

Inheritance diagram for Poppler::LinkRendition:

Collaboration diagram for Poppler::LinkRendition:

Public Types
enum	RenditionAction {   NoRendition , PlayRendition , StopRendition , PauseRendition ,   ResumeRendition }
Public Types inherited from Poppler::Link
enum	LinkType {   None , Goto , Execute , Browse ,   Action , Sound , Movie , Rendition ,   JavaScript , OCGState , Hide , ResetForm ,   SubmitForm }

Public Member Functions
RenditionAction	action () const
bool	isReferencedAnnotation (const ScreenAnnotation *annotation) const
	LinkRendition (const QRectF &linkArea, ::MediaRendition *rendition, int operation, const QString &script, const Ref &annotationReference)
	LinkRendition (const QRectF &linkArea, std::unique_ptr<::MediaRendition > &&rendition, int operation, const QString &script, const Ref annotationReference)
LinkType	linkType () const override
MediaRendition *	rendition () const
QString	script () const
	~LinkRendition () override
Public Member Functions inherited from Poppler::Link
QRectF	linkArea () const
QVector< Link * >	nextLinks () const
virtual	~Link ()

Detailed Description

Rendition: Rendition link.

Since

0.20

Member Enumeration Documentation

RenditionAction

enum Poppler::LinkRendition::RenditionAction

Describes the possible rendition actions.

Since

0.22

Constructor & Destructor Documentation

LinkRendition() [1/2]

Poppler::LinkRendition::LinkRendition	(	const QRectF &	linkArea,
		::MediaRendition *	rendition,
		int	operation,
		const QString &	script,
		const Ref &	annotationReference )

Create a new rendition link.

Parameters

linkArea	the active area of the link
rendition	the media rendition object. Ownership is taken
operation	the numeric operation (action) (

See also

::LinkRendition::RenditionOperation)

Parameters

script	the java script code
annotationReference	the object reference of the screen annotation associated with this rendition action

Since

0.22

References Poppler::Link::linkArea(), rendition(), and script().

Referenced by isReferencedAnnotation().

LinkRendition() [2/2]

Poppler::LinkRendition::LinkRendition	(	const QRectF &	linkArea,
		std::unique_ptr<::MediaRendition > &&	rendition,
		int	operation,
		const QString &	script,
		const Ref	annotationReference )

Create a new rendition link.

Parameters

linkArea	the active area of the link
rendition	the media rendition object.
operation	the numeric operation (action) (

See also

::LinkRendition::RenditionOperation)

Parameters

script	the java script code
annotationReference	the object reference of the screen annotation associated with this rendition action

References Poppler::Link::linkArea(), rendition(), and script().

Member Function Documentation

action()

RenditionAction Poppler::LinkRendition::action

(

)

const

Returns the action that should be executed if a rendition object is provided.

Since

0.22

isReferencedAnnotation()

bool Poppler::LinkRendition::isReferencedAnnotation

(

const ScreenAnnotation *

annotation

)

const

Returns whether the given annotation is the referenced screen annotation for this rendition link.

Since

0.22

References LinkRendition().

linkType()

LinkType Poppler::LinkRendition::linkType ( ) const

overridevirtual

The type of this link.

Reimplemented from Poppler::Link.

script()

QString Poppler::LinkRendition::script

(

)

const

The JS code that shall be executed or an empty string.

Since

0.22

Referenced by LinkRendition(), and LinkRendition().

---

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

• poppler-link.h