#include <poppler-link.h>

Inheritance diagram for Poppler::Link:

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

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

enum Poppler::Link::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.
JavaScript	A JavaScript code to be interpreted.
OCGState	An Optional Content Group state change.
Hide	An action to hide a field.
ResetForm	An action to reset the form. Since 24.07
SubmitForm	An action to submit a form. Since 24.10

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

◆ linkType()

virtual LinkType Poppler::Link::linkType ( ) const

virtual

The type of this link.

Reimplemented in Poppler::LinkGoto, Poppler::LinkExecute, Poppler::LinkBrowse, Poppler::LinkAction, Poppler::LinkSound, Poppler::LinkRendition, Poppler::LinkJavaScript, Poppler::LinkMovie, Poppler::LinkOCGState, Poppler::LinkHide, Poppler::LinkResetForm, and Poppler::LinkSubmitForm.

◆ nextLinks()

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

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

Note: The caller does not get ownership of the returned objects.

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

poppler-link.h

Public Types