Okular::FormFieldSignature

Search for usage in LXR

Okular::FormFieldSignature Class Referenceabstract

#include <form.h>

Inheritance diagram for Okular::FormFieldSignature:

Public Types

enum  SignatureType {
  AdbePkcs7sha1 , AdbePkcs7detached , EtsiCAdESdetached , UnknownType ,
  UnsignedSignature
}
 
using SubscriptionHandle = uint64_t
 
- Public Types inherited from Okular::FormField
enum  AdditionalActionType { FieldModified , FormatField , ValidateField , CalculateField }
 
enum  FieldType { FormButton , FormText , FormChoice , FormSignature }
 

Public Member Functions

virtual bool sign (const NewSignatureData &data, const QString &newPath) const =0
 
virtual SignatureInfo signatureInfo () const =0
 
virtual SignatureType signatureType () const =0
 
virtual SubscriptionHandle subscribeUpdates (const std::function< void()> &callback) const =0
 
virtual bool unsubscribeUpdates (const SubscriptionHandle &) const =0
 
- Public Member Functions inherited from Okular::FormField
ActionactivationAction () const
 
ActionadditionalAction (AdditionalActionType type) const
 
ActionadditionalAction (Annotation::AdditionalActionType type) const
 
QList< Action * > additionalActions () const
 
void commitFormattedValue (const QString &value)
 
QString committedFormattedValue () const
 
QString committedValue () const
 
void commitValue (const QString &value)
 
virtual QString fullyQualifiedName () const =0
 
virtual int id () const =0
 
virtual bool isPrintable () const
 
virtual bool isReadOnly () const
 
virtual bool isVisible () const
 
virtual QString name () const =0
 
Pagepage () const
 
virtual NormalizedRect rect () const =0
 
virtual void setAppearanceValue (const QVariant &value)
 
virtual void setPrintable (bool value)
 
virtual void setReadOnly (bool value)
 
virtual void setValue (const QVariant &value)
 
virtual void setVisible (bool value)
 
FieldType type () const
 
virtual QString uiName () const =0
 
virtual QVariant value () const
 

Additional Inherited Members

- Protected Member Functions inherited from Okular::FormField
void setActivationAction (Action *action)
 
void setAdditionalAction (AdditionalActionType type, Action *action)
 
void setAdditionalAction (Annotation::AdditionalActionType type, Action *action)
 

Detailed Description

Interface of a signature form field.

This is the base interface to reimplement to represent a signature field.

Definition at line 527 of file form.h.

Member Typedef Documentation

◆ SubscriptionHandle

using Okular::FormFieldSignature::SubscriptionHandle = uint64_t

Definition at line 561 of file form.h.

Member Enumeration Documentation

◆ SignatureType

The types of signature.

Enumerator
UnsignedSignature 

The signature field has not been signed yet.

Since
22.04

Definition at line 533 of file form.h.

Constructor & Destructor Documentation

◆ ~FormFieldSignature()

FormFieldSignature::~FormFieldSignature ( )
override

Definition at line 407 of file form.cpp.

◆ FormFieldSignature()

FormFieldSignature::FormFieldSignature ( )
protected

Definition at line 402 of file form.cpp.

Member Function Documentation

◆ sign()

virtual bool Okular::FormFieldSignature::sign ( const NewSignatureData & data,
const QString & newPath ) const
pure virtual

Signs a field of UnsignedSignature type.

Since
22.04

◆ signatureInfo()

virtual SignatureInfo Okular::FormFieldSignature::signatureInfo ( ) const
pure virtual

The signature info.

Since
23.08

◆ signatureType()

virtual SignatureType Okular::FormFieldSignature::signatureType ( ) const
pure virtual

The signature type.

◆ subscribeUpdates()

virtual SubscriptionHandle Okular::FormFieldSignature::subscribeUpdates ( const std::function< void()> & callback) const
pure virtual

Subscribes to updates to signatureInfo.

Especially certificate validation can be a slow task and the underlying infrastructure might offload it to a background job.

Whenever those background jobs finished, the callback(s) will be invoked

Returns
handle to be able to be put back into unsubscribeUpdates
Since
24.08

◆ unsubscribeUpdates()

virtual bool Okular::FormFieldSignature::unsubscribeUpdates ( const SubscriptionHandle & ) const
pure virtual

Unsubscribes a handle for updates.

Handle must be acquired by the subscribeUpdates function

Returns
true if subscription succeeded and false if failed. The most likely reason for for failure is if the handle was already unsubscribed or for other reasons not existing
Since
24.08

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:58:25 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.