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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
|
//========================================================================
//
// Form.h
//
// This file is licensed under the GPLv2 or later
//
// Copyright 2006 Julien Rebetez <julienr@svn.gnome.org>
// Copyright 2007, 2008, 2011 Carlos Garcia Campos <carlosgc@gnome.org>
// Copyright 2007-2010 Albert Astals Cid <aacid@kde.org>
// Copyright 2010 Mark Riedesel <mark@klowner.com>
// Copyright 2011 Pino Toscano <pino@kde.org>
//
//========================================================================
#ifndef FORM_H
#define FORM_H
#ifdef USE_GCC_PRAGMAS
#pragma interface
#endif
#include "Object.h"
#include <set>
class GooString;
class Array;
class Dict;
class Annot;
class AnnotWidget;
class Annots;
class Catalog;
class LinkAction;
class GfxResources;
enum FormFieldType {
formButton,
formText,
formChoice,
formSignature,
formUndef
};
enum FormButtonType {
formButtonCheck,
formButtonPush,
formButtonRadio
};
enum VariableTextQuadding {
quaddingLeftJustified,
quaddingCentered,
quaddingRightJustified
};
class Form;
class FormField;
class FormFieldButton;
class FormFieldText;
class FormFieldSignature;
class FormFieldChoice;
//------------------------------------------------------------------------
// FormWidget
// A FormWidget represents the graphical part of a field and is "attached"
// to a page.
//------------------------------------------------------------------------
class FormWidget {
public:
virtual ~FormWidget();
// Check if point is inside the field bounding rect
GBool inRect(double x, double y) const;
// Get the field bounding rect
void getRect(double *x1, double *y1, double *x2, double *y2) const;
unsigned getID () { return ID; }
void setID (unsigned int i) { ID=i; }
FormField *getField () { return field; }
FormFieldType getType() { return type; }
Object* getObj() { return &obj; }
Ref getRef() { return ref; }
void setChildNum (unsigned i) { childNum = i; }
unsigned getChildNum () { return childNum; }
double getFontSize() const;
GooString *getPartialName() const;
GooString *getAlternateUiName() const;
GooString *getMappingName() const;
GooString *getFullyQualifiedName();
GBool isModified () const;
bool isReadOnly() const;
LinkAction *getActivationAction();
// return the unique ID corresponding to pageNum/fieldNum
static int encodeID (unsigned pageNum, unsigned fieldNum);
// decode id and retrieve pageNum and fieldNum
static void decodeID (unsigned id, unsigned* pageNum, unsigned* fieldNum);
void createWidgetAnnotation(Catalog *catalog);
AnnotWidget *getWidgetAnnotation() const { return widget; }
#ifdef DEBUG_FORMS
void print(int indent = 0);
#endif
protected:
FormWidget(XRef *xrefA, Object *aobj, unsigned num, Ref aref, FormField *fieldA);
AnnotWidget *widget;
FormField* field;
FormFieldType type;
Object obj;
Ref ref;
XRef *xref;
//index of this field in the parent's child list
unsigned childNum;
/*
Field ID is an (unsigned) integer, calculated as follow :
the first sizeof/2 bits are the field number, relative to the page
the last sizeof/2 bits are the page number
[page number | field number]
(encoding) id = (pageNum << 4*sizeof(unsigned)) + fieldNum;
(decoding) pageNum = id >> 4*sizeof(unsigned); fieldNum = (id << 4*sizeof(unsigned)) >> 4*sizeof(unsigned);
*/
unsigned ID;
};
//------------------------------------------------------------------------
// FormWidgetButton
//------------------------------------------------------------------------
class FormWidgetButton: public FormWidget {
public:
FormWidgetButton(XRef *xrefA, Object *dict, unsigned num, Ref ref, FormField *p);
~FormWidgetButton ();
FormButtonType getButtonType() const;
void setState (GBool state);
GBool getState ();
char* getOnStr();
void setAppearanceState(char *state);
void setNumSiblingsID (int i);
void setSiblingsID (int i, unsigned id) { siblingsID[i] = id; }
//For radio buttons, return the IDs of the other radio buttons in the same group
unsigned* getSiblingsID () const { return siblingsID; }
int getNumSiblingsID () const { return numSiblingsID; }
protected:
unsigned* siblingsID; // IDs of dependent buttons (each button of a radio field has all the others buttons
// of the same field in this array)
int numSiblingsID;
GooString *onStr;
FormFieldButton *parent;
};
//------------------------------------------------------------------------
// FormWidgetText
//------------------------------------------------------------------------
class FormWidgetText: public FormWidget {
public:
FormWidgetText(XRef *xrefA, Object *dict, unsigned num, Ref ref, FormField *p);
//return the field's content (UTF16BE)
GooString* getContent() ;
//return a copy of the field's content (UTF16BE)
GooString* getContentCopy();
//except a UTF16BE string
void setContent(GooString* new_content);
bool isMultiline () const;
bool isPassword () const;
bool isFileSelect () const;
bool noSpellCheck () const;
bool noScroll () const;
bool isComb () const;
bool isRichText () const;
int getMaxLen () const;
protected:
FormFieldText *parent;
};
//------------------------------------------------------------------------
// FormWidgetChoice
//------------------------------------------------------------------------
class FormWidgetChoice: public FormWidget {
public:
FormWidgetChoice(XRef *xrefA, Object *dict, unsigned num, Ref ref, FormField *p);
~FormWidgetChoice();
int getNumChoices();
//return the display name of the i-th choice (UTF16BE)
GooString* getChoice(int i);
//select the i-th choice
void select (int i);
//toggle selection of the i-th choice
void toggle (int i);
//deselect everything
void deselectAll ();
//except a UTF16BE string
//only work for editable combo box, set the user-entered text as the current choice
void setEditChoice(GooString* new_content);
GooString* getEditChoice ();
bool isSelected (int i);
bool isCombo () const;
bool hasEdit () const;
bool isMultiSelect () const;
bool noSpellCheck () const;
bool commitOnSelChange () const;
bool isListBox () const;
protected:
bool _checkRange (int i);
FormFieldChoice *parent;
};
//------------------------------------------------------------------------
// FormWidgetSignature
//------------------------------------------------------------------------
class FormWidgetSignature: public FormWidget {
public:
FormWidgetSignature(XRef *xrefA, Object *dict, unsigned num, Ref ref, FormField *p);
protected:
FormFieldSignature *parent;
};
//------------------------------------------------------------------------
// FormField
// A FormField implements the logical side of a field and is "attached" to
// the Catalog. This is an internal class and client applications should
// only interact with FormWidgets.
//------------------------------------------------------------------------
class FormField {
public:
FormField(XRef* xrefa, Object *aobj, const Ref& aref, FormField *parent, std::set<int> *usedParents, FormFieldType t=formUndef);
virtual ~FormField();
// Accessors.
FormFieldType getType() { return type; }
Object* getObj() { return &obj; }
Ref getRef() { return ref; }
void setReadOnly (bool b) { readOnly = b; }
bool isReadOnly () const { return readOnly; }
GBool isModified () const;
GooString* getDefaultAppearance() const { return defaultAppearance; }
GBool hasTextQuadding() const { return hasQuadding; }
VariableTextQuadding getTextQuadding() const { return quadding; }
GooString *getPartialName() const { return partialName; }
GooString *getAlternateUiName() const { return alternateUiName; }
GooString *getMappingName() const { return mappingName; }
GooString *getFullyQualifiedName();
FormWidget* findWidgetByRef (Ref aref);
FormWidget *getWidget(int i) { return terminal ? widgets[i] : NULL; }
// only implemented in FormFieldButton
virtual void fillChildrenSiblingsID ();
void createWidgetAnnotations(Catalog *catalog);
#ifdef DEBUG_FORMS
void printTree(int indent = 0);
virtual void print(int indent = 0);
#endif
protected:
void _createWidget (Object *obj, Ref aref);
void createChildren(std::set<int> *usedParents);
FormFieldType type; // field type
Ref ref;
bool terminal;
Object obj;
XRef *xref;
FormField **children;
FormField *parent;
int numChildren;
FormWidget **widgets;
bool readOnly;
GBool modified;
GooString *partialName; // T field
GooString *alternateUiName; // TU field
GooString *mappingName; // TM field
GooString *fullyQualifiedName;
// Variable Text
GooString *defaultAppearance;
GBool hasQuadding;
VariableTextQuadding quadding;
private:
FormField() {}
};
//------------------------------------------------------------------------
// FormFieldButton
//------------------------------------------------------------------------
class FormFieldButton: public FormField {
public:
FormFieldButton(XRef *xrefA, Object *dict, const Ref& ref, FormField *parent, std::set<int> *usedParents);
FormButtonType getButtonType () { return btype; }
bool noToggleToOff () const { return noAllOff; }
// returns gTrue if the state modification is accepted
GBool setState (char *state);
GBool getState(char *state);
char *getAppearanceState() { return appearanceState.isName() ? appearanceState.getName() : NULL; }
void fillChildrenSiblingsID ();
#ifdef DEBUG_FORMS
void print(int indent = 0);
#endif
virtual ~FormFieldButton();
protected:
void updateState(char *state);
FormButtonType btype;
int size;
int active_child; //only used for combo box
bool noAllOff;
Object appearanceState; // V
};
//------------------------------------------------------------------------
// FormFieldText
//------------------------------------------------------------------------
class FormFieldText: public FormField {
public:
FormFieldText(XRef *xrefA, Object *dict, const Ref& ref, FormField *parent, std::set<int> *usedParents);
GooString* getContent () { return content; }
GooString* getContentCopy ();
void setContentCopy (GooString* new_content);
virtual ~FormFieldText();
bool isMultiline () const { return multiline; }
bool isPassword () const { return password; }
bool isFileSelect () const { return fileSelect; }
bool noSpellCheck () const { return doNotSpellCheck; }
bool noScroll () const { return doNotScroll; }
bool isComb () const { return comb; }
bool isRichText () const { return richText; }
int getMaxLen () const { return maxLen; }
#ifdef DEBUG_FORMS
void print(int indent = 0);
#endif
protected:
GooString* content;
bool multiline;
bool password;
bool fileSelect;
bool doNotSpellCheck;
bool doNotScroll;
bool comb;
bool richText;
int maxLen;
};
//------------------------------------------------------------------------
// FormFieldChoice
//------------------------------------------------------------------------
class FormFieldChoice: public FormField {
public:
FormFieldChoice(XRef *xrefA, Object *aobj, const Ref& ref, FormField *parent, std::set<int> *usedParents);
virtual ~FormFieldChoice();
int getNumChoices() { return numChoices; }
GooString* getChoice(int i) { return choices ? choices[i].optionName : NULL; }
GooString* getExportVal (int i) { return choices ? choices[i].exportVal : NULL; }
// For multi-select choices it returns the first one
GooString* getSelectedChoice();
//select the i-th choice
void select (int i);
//toggle selection of the i-th choice
void toggle (int i);
//deselect everything
void deselectAll ();
//only work for editable combo box, set the user-entered text as the current choice
void setEditChoice(GooString* new_content);
GooString* getEditChoice ();
bool isSelected (int i) { return choices[i].selected; }
int getNumSelected ();
bool isCombo () const { return combo; }
bool hasEdit () const { return edit; }
bool isMultiSelect () const { return multiselect; }
bool noSpellCheck () const { return doNotSpellCheck; }
bool commitOnSelChange () const { return doCommitOnSelChange; }
bool isListBox () const { return !combo; }
int getTopIndex() const { return topIdx; }
#ifdef DEBUG_FORMS
void print(int indent = 0);
#endif
protected:
void unselectAll();
void updateSelection();
bool combo;
bool edit;
bool multiselect;
bool doNotSpellCheck;
bool doCommitOnSelChange;
struct ChoiceOpt {
GooString* exportVal; //the export value ("internal" name)
GooString* optionName; //displayed name
bool selected; //if this choice is selected
};
int numChoices;
ChoiceOpt* choices;
GooString* editedChoice;
int topIdx; // TI
};
//------------------------------------------------------------------------
// FormFieldSignature
//------------------------------------------------------------------------
class FormFieldSignature: public FormField {
public:
FormFieldSignature(XRef *xrefA, Object *dict, const Ref& ref, FormField *parent, std::set<int> *usedParents);
virtual ~FormFieldSignature();
#ifdef DEBUG_FORMS
void print(int indent = 0);
#endif
};
//------------------------------------------------------------------------
// Form
// This class handle the document-wide part of Form (things in the acroForm
// Catalog entry).
//------------------------------------------------------------------------
class Form {
public:
Form(XRef *xrefA, Object* acroForm);
~Form();
// Look up an inheritable field dictionary entry.
static Object *fieldLookup(Dict *field, char *key, Object *obj);
/* Creates a new Field of the type specified in obj's dict.
used in Form::Form and FormField::FormField */
static FormField *createFieldFromDict (Object* obj, XRef *xref, const Ref& aref, FormField *parent, std::set<int> *usedParents);
Object *getObj () const { return acroForm; }
GBool getNeedAppearances () const { return needAppearances; }
int getNumFields() const { return numFields; }
FormField* getRootField(int i) const { return rootFields[i]; }
GooString* getDefaultAppearance() const { return defaultAppearance; }
VariableTextQuadding getTextQuadding() const { return quadding; }
GfxResources* getDefaultResources() const { return defaultResources; }
Object* getDefaultResourcesObj() { return &resDict; }
FormWidget* findWidgetByRef (Ref aref);
void postWidgetsLoad(Catalog *catalog);
private:
FormField** rootFields;
int numFields;
int size;
XRef* xref;
Object *acroForm;
GBool needAppearances;
GfxResources *defaultResources;
Object resDict;
// Variable Text
GooString *defaultAppearance;
VariableTextQuadding quadding;
};
//------------------------------------------------------------------------
// FormPageWidgets
//------------------------------------------------------------------------
class FormPageWidgets {
public:
FormPageWidgets (Annots* annots, unsigned int page, Form *form);
~FormPageWidgets();
int getNumWidgets() const { return numWidgets; }
FormWidget* getWidget(int i) const { return widgets[i]; }
private:
FormWidget** widgets;
int numWidgets;
int size;
};
#endif
|