Okular::FormFieldSignature
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 | |
Action * | activationAction () const |
Action * | additionalAction (AdditionalActionType type) const |
Action * | additionalAction (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 |
Page * | page () 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.
Member Typedef Documentation
◆ SubscriptionHandle
using Okular::FormFieldSignature::SubscriptionHandle = uint64_t |
Member Enumeration Documentation
◆ SignatureType
Constructor & Destructor Documentation
◆ ~FormFieldSignature()
◆ FormFieldSignature()
Member Function Documentation
◆ sign()
|
pure virtual |
Signs a field of UnsignedSignature type.
- Since
- 22.04
◆ signatureInfo()
|
pure virtual |
The signature info.
- Since
- 23.08
◆ signatureType()
|
pure virtual |
The signature type.
◆ subscribeUpdates()
|
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()
|
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 Sat Dec 21 2024 16:58:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:58:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.