File: poppler-form.sip

package info (click to toggle)
python-poppler-qt5 21.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 280 kB
  • sloc: python: 424; makefile: 11
file content (353 lines) | stat: -rw-r--r-- 9,799 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
namespace Poppler {

class FormField {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End

public:
    enum FormType {
        FormButton,
        FormText,
        FormChoice,
        FormSignature,
    };
    virtual ~FormField();
    virtual FormType type() const = 0;
    QRectF rect() const;
    int id() const;
    QString name() const;
%If(POPPLER_V0_51_0 -)
    void setName(const QString &name) const;
%End
%If(POPPLER_V0_20_0 -)
    QString fullyQualifiedName() const;
%End
    QString uiName() const;
%If(POPPLER_V0_79_0 -)
    bool isPrintable () const;
    void setPrintable (bool value);
%End
    bool isReadOnly() const;
    bool isVisible() const;
%If(POPPLER_V0_64_0 -)
    void setReadOnly (bool value);
    void setVisible (bool value);
%End
    Poppler::Link* activationAction() const;
%If(POPPLER_V0_53_0 -)
	enum AdditionalActionType
	{
	    FieldModified,   ///< A JavaScript action to be performed when the user modifies the field
	    FormatField,     ///< A JavaScript action to be performed before the field is formatted to display its value
	    ValidateField,   ///< A JavaScript action to be performed when the field value changes
	    CalculateField,  ///< A JavaScript action to be performed when the field needs to be recalculated
	};
	Link* additionalAction(AdditionalActionType type) const;
%End

private:
    FormField(const Poppler::FormField&);

%ConvertToSubClassCode
    switch (sipCpp->type()) {
        case Poppler::FormField::FormButton:
            sipType = sipType_Poppler_FormFieldButton;
            break;
        case Poppler::FormField::FormText:
            sipType = sipType_Poppler_FormFieldText;
            break;
        case Poppler::FormField::FormChoice:
            sipType = sipType_Poppler_FormFieldChoice;
            break;
        default:
            sipType = sipType_Poppler_FormField;
    }
%End

}; // class FormField


class FormFieldButton : Poppler::FormField {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End

public:
    enum ButtonType {
        Push,
        CheckBox,
        Radio,
    };
//     FormFieldButton(DocumentData *doc, ::Page *p, ::FormWidgetButton *w);
    virtual ~FormFieldButton();
    virtual FormType type() const;
    ButtonType buttonType() const;
    QString caption() const;
%If(POPPLER_V0_79_0 -)
    FormFieldIcon icon () const;
    void setIcon (const FormFieldIcon &icon);
%End
    bool state() const;
    void setState( bool state );
    QList<int> siblings() const;

private:
    FormFieldButton(const Poppler::FormFieldButton&);

}; // class FormFieldButton


class FormFieldText : Poppler::FormField {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End

public:
    enum TextType {
        Normal,
        Multiline,
        FileSelect,
    };
//     FormFieldText(DocumentData *doc, ::Page *p, ::FormWidgetText *w);
    virtual ~FormFieldText();
    virtual FormType type() const;
    TextType textType() const;
    QString text() const;
    void setText( const QString& text );
    bool isPassword() const;
    bool isRichText() const;
    int maximumLength() const;
    Qt::Alignment textAlignment() const;
    bool canBeSpellChecked() const;
    double getFontSize() const;
    void setFontSize(int fontSize);

private:
    FormFieldText(const Poppler::FormFieldText&);

}; // class FormFieldText


class FormFieldChoice : Poppler::FormField {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End

public:
    enum ChoiceType {
        ComboBox,
        ListBox,
    };
//     FormFieldChoice(DocumentData *doc, ::Page *p, ::FormWidgetChoice *w);
    virtual ~FormFieldChoice();
    virtual FormType type() const;
    ChoiceType choiceType() const;
    QStringList choices() const;
%If(POPPLER_V0_87_0 -)
    QVector< QPair< QString, QString > > choicesWithExportValues () const;
%End
    bool isEditable() const;
    bool multiSelect() const;
    QList<int> currentChoices() const;
    void setCurrentChoices( const QList<int> &choice );
%If(POPPLER_V0_22_0 -)
    QString editChoice() const;
    void setEditChoice(const QString& text);
%End
    Qt::Alignment textAlignment() const;
    bool canBeSpellChecked() const;

private:
    FormFieldChoice(const Poppler::FormFieldChoice&);

}; // class FormFieldChoice

%If(POPPLER_V0_51_0 -)
class SignatureValidationInfo {
%TypeHeaderCode
#include <time.h>
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End
    public:
	enum SignatureStatus {
	    SignatureValid,          ///< The signature is cryptographically valid.
	    SignatureInvalid,        ///< The signature is cryptographically invalid.
	    SignatureDigestMismatch, ///< The document content was changed after the signature was applied.
	    SignatureDecodingError,  ///< The signature CMS/PKCS7 structure is malformed.
	    SignatureGenericError,   ///< The signature could not be verified.
	    SignatureNotFound,       ///< The requested signature is not present in the document.
	    SignatureNotVerified     ///< The signature is not yet verified.
	};
	enum CertificateStatus {
	    CertificateTrusted,         ///< The certificate is considered trusted.
	    CertificateUntrustedIssuer, ///< The issuer of this certificate has been marked as untrusted by the user.
	    CertificateUnknownIssuer,   ///< The certificate trust chain has not finished in a trusted root certificate.
	    CertificateRevoked,         ///< The certificate was revoked by the issuing certificate authority.
	    CertificateExpired,         ///< The signing time is outside the validity bounds of this certificate.
	    CertificateGenericError,    ///< The certificate could not be verified.
	    CertificateNotVerified      ///< The certificate is not yet verified.
	};

%If(POPPLER_V0_58_0 -)
	enum HashAlgorithm
	{
	    HashAlgorithmUnknown,
	    HashAlgorithmMd2,
	    HashAlgorithmMd5,
	    HashAlgorithmSha1,
	    HashAlgorithmSha256,
	    HashAlgorithmSha384,
	    HashAlgorithmSha512,
	    HashAlgorithmSha224
	};
%End
%If(POPPLER_V0_74_0 -)
    CertificateInfo certificateInfo () const;
%End
	SignatureStatus signatureStatus() const;
	CertificateStatus certificateStatus() const;
	QString signerName() const;
%If(POPPLER_V0_58_0 -)
	QString signerSubjectDN() const;
	HashAlgorithm hashAlgorithm() const;
    time_t signingTime() const;
    QByteArray signature() const;
    QList<qint64> signedRangeBounds() const;
    bool signsTotalDocument() const;

	private:
    SignatureValidationInfo(const SignatureValidationInfo &other);
    //SignatureValidationInfo &operator=(const SignatureValidationInfo &other);
%End

}; // class SignatureValidationInfo

class FormFieldSignature : Poppler::FormField {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End
    public:

%If(POPPLER_V0_58_0 -)
	enum SignatureType {
	    AdbePkcs7sha1,
	    AdbePkcs7detached,
	    EtsiCAdESdetached
	};
%End
	enum ValidateOptions {
	    ValidateVerifyCertificate = 1, ///< Validate the certificate.
	    ValidateForceRevalidation = 2, ///< Force revalidation of the certificate.
	};

    private:
	//FormFieldSignature(DocumentData *doc, ::Page *p, ::FormWidgetSignature *w);
	//~FormFieldSignature();
    FormFieldSignature(const Poppler::FormFieldSignature&);

	FormType type() const;
%If(POPPLER_V0_58_0 -)
	SignatureType signatureType() const;
%End

	SignatureValidationInfo validate(ValidateOptions opt) const;
%If(POPPLER_V0_58_0 -)
	SignatureValidationInfo validate(int opt, const QDateTime& validationTime) const;
%End
};  // FormFieldSignature

%End // POPPLER_V0_51_0


%If(POPPLER_V0_74_0 -)
class CertificateInfo {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End
    public:

    enum EntityInfoKey {
        CommonName,
        DistinguishedName,
        EmailAddress,
        Organization
    };

    enum KeyUsageExtension {
        KuDigitalSignature = 0x80,
        KuNonRepudiation = 0x40,
        KuKeyEncipherment = 0x20,
        KuDataEncipherment = 0x10,
        KuKeyAgreement = 0x08,
        KuKeyCertSign = 0x04,
        KuClrSign = 0x02,
        KuEncipherOnly = 0x01,
        KuNone = 0x00
    };
    // next line is how to convert Q_DECLARE_FLAGS for enums to sip :-)
    typedef QFlags<Poppler::CertificateInfo::KeyUsageExtension> KeyUsageExtensions;

    enum PublicKeyType {
        RsaKey,
        DsaKey,
        EcKey,
        OtherKey
    };
    QByteArray certificateData () const;
%If(POPPLER_V21_01_0 -)
    bool checkPassword (const QString &password) const;
%End
    bool isNull () const;
    bool isSelfSigned () const;
    QString issuerInfo (EntityInfoKey key) const;
    KeyUsageExtensions keyUsageExtensions () const;
%If(POPPLER_V21_01_0 -)
    QString nickName () const;
%End
    //CertificateInfo & operator= (const CertificateInfo &other);  // XXX Syntax error
    QByteArray publicKey () const;
    int publicKeyStrength () const;
    PublicKeyType publicKeyType () const;
    QByteArray serialNumber () const;
    QString subjectInfo (EntityInfoKey key) const;
    QDateTime validityEnd () const;
    QDateTime validityStart () const;
    int version () const;

    // copy constructor
    CertificateInfo (const CertificateInfo &other);


}; // class CertificateInfo
%End // POPPLER_V0_74_0 -


%If(POPPLER_V0_79_0 -)
class FormFieldIcon {
%TypeHeaderCode
#include <qt5/poppler-qt5.h>
#include <qt5/poppler-form.h>
%End
    public:
    FormFieldIcon (const FormFieldIcon &ffIcon);
    //FormFieldIcon (FormFieldIconData *data);
    //FormFieldIcon & operator= (const FormFieldIcon &ffIcon);  // XXX Syntax error

}; // FormFieldIcon
%End // POPPLER_V0_79_0 -





}; // namespace Poppler

/* kate: indent-width 4; space-indent on; hl c++; indent-mode cstyle; */