Poppler Qt5  0.73.0
Public Types | Public Member Functions | List of all members
Poppler::LinkRendition Class Reference

#include <poppler-link.h>

Inheritance diagram for Poppler::LinkRendition:
Inheritance graph
[legend]
Collaboration diagram for Poppler::LinkRendition:
Collaboration graph
[legend]

Public Types

enum  RenditionAction {
  NoRendition, PlayRendition, StopRendition, PauseRendition,
  ResumeRendition
}
 

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)
 
LinkType linkType () const override
 
MediaRendition * rendition () const
 
QString script () const
 
 ~LinkRendition ()
 

Detailed Description

Rendition: Rendition link.

Since
0.20

Member Enumeration Documentation

◆ RenditionAction

Describes the possible rendition actions.

Since
0.22

Constructor & Destructor Documentation

◆ LinkRendition()

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

Create a new rendition link.

Parameters
linkAreathe active area of the link
renditionthe media rendition object. Ownership is taken
operationthe numeric operation (action) (
See also
::LinkRendition::RenditionOperation)
Parameters
scriptthe java script code
annotationReferencethe object reference of the screen annotation associated with this rendition action
Since
0.22

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

◆ script()

QString Poppler::LinkRendition::script ( ) const

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

Since
0.22

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