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
|
// Copyright 2016 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
#ifndef CORE_FPDFDOC_CPDF_FORMFIELD_H_
#define CORE_FPDFDOC_CPDF_FORMFIELD_H_
#include <memory>
#include <utility>
#include <vector>
#include "core/fpdfdoc/cpdf_aaction.h"
#include "core/fxcrt/fx_string.h"
#include "core/fxcrt/fx_system.h"
#include "core/fxcrt/unowned_ptr.h"
#include "third_party/base/stl_util.h"
class CPDF_Dictionary;
class CPDF_Font;
class CPDF_FormControl;
class CPDF_InterForm;
class CPDF_Object;
class CPDF_String;
enum class NotificationOption { kDoNotNotify = 0, kNotify };
enum class FormFieldType : uint8_t {
kUnknown = 0,
kPushButton = 1,
kCheckBox = 2,
kRadioButton = 3,
kComboBox = 4,
kListBox = 5,
kTextField = 6,
kSignature = 7,
#ifdef PDF_ENABLE_XFA
kXFA = 8, // Generic XFA field, should use value below if possible.
kXFA_CheckBox = 9,
kXFA_ComboBox = 10,
kXFA_ImageField = 11,
kXFA_ListBox = 12,
kXFA_PushButton = 13,
kXFA_Signature = 14,
kXFA_TextField = 15
#endif // PDF_ENABLE_XFA
};
Optional<FormFieldType> IntToFormFieldType(int value);
// If values are added to FormFieldType, these will need to be updated.
#ifdef PDF_ENABLE_XFA
constexpr size_t kFormFieldTypeCount = 16;
#else // PDF_ENABLE_XFA
constexpr size_t kFormFieldTypeCount = 8;
#endif // PDF_ENABLE_XFA
constexpr FormFieldType kFormFieldTypes[kFormFieldTypeCount] = {
FormFieldType::kUnknown,
FormFieldType::kPushButton,
FormFieldType::kCheckBox,
FormFieldType::kRadioButton,
FormFieldType::kComboBox,
FormFieldType::kListBox,
FormFieldType::kTextField,
FormFieldType::kSignature,
#ifdef PDF_ENABLE_XFA
FormFieldType::kXFA,
FormFieldType::kXFA_CheckBox,
FormFieldType::kXFA_ComboBox,
FormFieldType::kXFA_ImageField,
FormFieldType::kXFA_ListBox,
FormFieldType::kXFA_PushButton,
FormFieldType::kXFA_Signature,
FormFieldType::kXFA_TextField
#endif // PDF_ENABLE_XFA
};
const CPDF_Object* FPDF_GetFieldAttr(const CPDF_Dictionary* pFieldDict,
const char* name);
CPDF_Object* FPDF_GetFieldAttr(CPDF_Dictionary* pFieldDict, const char* name);
WideString FPDF_GetFullName(CPDF_Dictionary* pFieldDict);
class CPDF_FormField {
public:
enum Type {
Unknown,
PushButton,
RadioButton,
CheckBox,
Text,
RichText,
File,
ListBox,
ComboBox,
Sign
};
CPDF_FormField(CPDF_InterForm* pForm, CPDF_Dictionary* pDict);
~CPDF_FormField();
WideString GetFullName() const;
Type GetType() const { return m_Type; }
uint32_t GetFlags() const { return m_Flags; }
CPDF_Dictionary* GetFieldDict() const { return m_pDict.Get(); }
bool ResetField(NotificationOption notify);
int CountControls() const {
return pdfium::CollectionSize<int>(m_ControlList);
}
CPDF_FormControl* GetControl(int index) const {
return m_ControlList[index].Get();
}
int GetControlIndex(const CPDF_FormControl* pControl) const;
FormFieldType GetFieldType() const;
CPDF_AAction GetAdditionalAction() const;
WideString GetAlternateName() const;
WideString GetMappingName() const;
uint32_t GetFieldFlags() const;
ByteString GetDefaultStyle() const;
// TODO(thestig): Figure out what to do with unused methods here.
bool IsReadOnly() const { return m_bReadOnly; }
bool IsRequired() const { return m_bRequired; }
bool IsNoExport() const { return m_bNoExport; }
WideString GetValue() const;
WideString GetDefaultValue() const;
bool SetValue(const WideString& value, NotificationOption notify);
int GetMaxLen() const;
int CountSelectedItems() const;
int GetSelectedIndex(int index) const;
bool ClearSelection(NotificationOption notify);
bool IsItemSelected(int index) const;
bool SetItemSelection(int index, bool bSelected, NotificationOption notify);
bool IsItemDefaultSelected(int index) const;
int GetDefaultSelectedItem() const;
int CountOptions() const;
WideString GetOptionLabel(int index) const;
WideString GetOptionValue(int index) const;
int FindOption(WideString csOptLabel) const;
int FindOptionValue(const WideString& csOptValue) const;
bool CheckControl(int iControlIndex,
bool bChecked,
NotificationOption notify);
int GetTopVisibleIndex() const;
int CountSelectedOptions() const;
int GetSelectedOptionIndex(int index) const;
bool IsOptionSelected(int iOptIndex) const;
bool SelectOption(int iOptIndex, bool bSelected, NotificationOption notify);
float GetFontSize() const { return m_FontSize; }
CPDF_Font* GetFont() const { return m_pFont.Get(); }
CPDF_Dictionary* GetDict() const { return m_pDict.Get(); }
CPDF_InterForm* GetForm() const { return m_pForm.Get(); }
WideString GetCheckValue(bool bDefault) const;
void AddFormControl(CPDF_FormControl* pFormControl) {
m_ControlList.emplace_back(pFormControl);
}
void SetOpt(std::unique_ptr<CPDF_Object> pOpt);
private:
WideString GetValue(bool bDefault) const;
bool SetValue(const WideString& value,
bool bDefault,
NotificationOption notify);
void InitFieldFlags();
int FindListSel(CPDF_String* str);
WideString GetOptionText(int index, int sub_index) const;
void LoadDA();
bool SetCheckValue(const WideString& value,
bool bDefault,
NotificationOption notify);
bool NotifyBeforeSelectionChange(const WideString& value);
void NotifyAfterSelectionChange();
bool NotifyBeforeValueChange(const WideString& value);
void NotifyAfterValueChange();
bool NotifyListOrComboBoxBeforeChange(const WideString& value);
void NotifyListOrComboBoxAfterChange();
CPDF_FormField::Type m_Type = Unknown;
uint32_t m_Flags = 0;
bool m_bReadOnly = false;
bool m_bRequired = false;
bool m_bNoExport = false;
UnownedPtr<CPDF_InterForm> const m_pForm;
UnownedPtr<CPDF_Dictionary> const m_pDict;
// Owned by InterForm parent.
std::vector<UnownedPtr<CPDF_FormControl>> m_ControlList;
float m_FontSize = 0;
UnownedPtr<CPDF_Font> m_pFont;
};
#endif // CORE_FPDFDOC_CPDF_FORMFIELD_H_
|
