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

#include <poppler-link.h>

Inheritance diagram for Poppler::Link:
Inheritance graph
[legend]

Public Types

enum  LinkType {
  None, Goto, Execute, Browse,
  Action, Sound, Movie, Rendition,
  JavaScript, OCGState, Hide
}
 

Public Member Functions

QRectF linkArea () const
 
virtual LinkType linkType () const
 
QVector< Link * > nextLinks () const
 
virtual ~Link ()
 

Detailed Description

Encapsulates data that describes a link.

This is the base class for links. It makes mandatory for inherited kind of links to reimplement the linkType() method and return the type of the link described by the reimplemented class.

Member Enumeration Documentation

◆ LinkType

The possible kinds of link.

Inherited classes must return an unique identifier

Enumerator
None 

Unknown link.

Goto 

A "Go To" link.

Execute 

A command to be executed.

Browse 

An URL to be browsed (eg "http://poppler.freedesktop.org")

Action 

A "standard" action to be executed in the viewer.

Sound 

A link representing a sound to be played.

Movie 

An action to be executed on a movie.

Rendition 

A rendition link.

Since
0.20
JavaScript 

A JavaScript code to be interpreted.

Since
0.10
OCGState 

An Optional Content Group state change.

Since
0.50
Hide 

An action to hide a field.

Since
0.64

Member Function Documentation

◆ linkArea()

QRectF Poppler::Link::linkArea ( ) const

The area of a Page where the link should be active.

Note
this can be a null rect, in this case the link represents a general action. The area is given in 0..1 range

◆ nextLinks()

QVector<Link *> Poppler::Link::nextLinks ( ) const

Get the next links to be activated / executed after this link.

Since
0.64

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