Poppler Qt6 24.10.0
Public Types | Public Member Functions | List of all members
Poppler::SignatureAnnotation Class Reference

#include <poppler-annotation.h>

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

Public Types

enum  SigningResult { SigningSuccess , FieldAlreadySigned , GenericSigningError }
 
- Public Types inherited from Poppler::Annotation
enum  AdditionalActionType {
  CursorEnteringAction , CursorLeavingAction , MousePressedAction , MouseReleasedAction ,
  FocusInAction , FocusOutAction , PageOpeningAction , PageClosingAction ,
  PageVisibleAction , PageInvisibleAction
}
 
enum  Flag {
  Hidden = 1 , FixedSize = 2 , FixedRotation = 4 , DenyPrint = 8 ,
  DenyWrite = 16 , DenyDelete = 32 , ToggleHidingOnMouse = 64 , External = 128
}
 
enum  LineEffect { NoEffect = 1 , Cloudy = 2 }
 
enum  LineStyle {
  Solid = 1 , Dashed = 2 , Beveled = 4 , Inset = 8 ,
  Underline = 16
}
 
enum  RevScope { Root = 0 , Reply = 1 , Group = 2 , Delete = 4 }
 
enum  RevType {
  None = 1 , Marked = 2 , Unmarked = 4 , Accepted = 8 ,
  Rejected = 16 , Cancelled = 32 , Completed = 64
}
 
enum  SubType {
  AText = 1 , ALine = 2 , AGeom = 3 , AHighlight = 4 ,
  AStamp = 5 , AInk = 6 , ALink = 7 , ACaret = 8 ,
  AFileAttachment = 9 , ASound = 10 , AMovie = 11 , AScreen = 12 ,
  AWidget = 13 , ARichMedia = 14
}
 

Public Member Functions

QColor backgroundColor () const
 
QColor borderColor () const
 
double borderWidth () const
 
QString fieldPartialName () const
 
QColor fontColor () const
 
double fontSize () const
 
QString imagePath () const
 
double leftFontSize () const
 
void setBackgroundColor (const QColor &color)
 
void setBorderColor (const QColor &color)
 
void setBorderWidth (double width)
 
void setFieldPartialName (const QString &fieldPartialName)
 
void setFontColor (const QColor &color)
 
void setFontSize (double fontSize)
 
void setImagePath (const QString &imagePath)
 
void setLeftFontSize (double fontSize)
 
void setLeftText (const QString &text)
 
void setText (const QString &text)
 
SigningResult sign (const QString &outputFileName, const PDFConverter::NewSignatureData &data)
 
SubType subType () const override
 
- Public Member Functions inherited from Poppler::Annotation
std::unique_ptr< AnnotationAppearanceannotationAppearance () const
 
QString author () const
 
QRectF boundary () const
 
QString contents () const
 
QDateTime creationDate () const
 
Flags flags () const
 
QDateTime modificationDate () const
 
Popup popup () const
 
std::vector< std::unique_ptr< Annotation > > revisions () const
 
RevScope revisionScope () const
 
RevType revisionType () const
 
void setAnnotationAppearance (const AnnotationAppearance &annotationAppearance)
 
void setAuthor (const QString &author)
 
void setBoundary (const QRectF &boundary)
 
void setContents (const QString &contents)
 
void setCreationDate (const QDateTime &date)
 
void setFlags (Flags flags)
 
void setModificationDate (const QDateTime &date)
 
void setPopup (const Popup &popup)
 
void setStyle (const Style &style)
 
void setUniqueName (const QString &uniqueName)
 
Style style () const
 
QString uniqueName () const
 
virtual ~Annotation ()
 

Detailed Description

Signature annotation.

A signature annotation. By creating one and adding it to the page you can create an unsigned signature field.

To read existing signature fields use FormFieldSignature.

Since
24.10

Member Enumeration Documentation

◆ SigningResult

Since
24.10
Enumerator
FieldAlreadySigned 

Trying to sign a field that is already signed.

Member Function Documentation

◆ borderWidth()

double Poppler::SignatureAnnotation::borderWidth ( ) const

border width in points

Default: 1.5

◆ subType()

SubType Poppler::SignatureAnnotation::subType ( ) const
overridevirtual

The type of the annotation.

Implements Poppler::Annotation.


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