| // 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" |
| |
| 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 |
| }; |
| |
| class CPDF_Dictionary; |
| class CPDF_Font; |
| class CPDF_FormControl; |
| class CPDF_InterForm; |
| class CPDF_String; |
| |
| 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) { |
| m_pDict->SetFor("Opt", std::move(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_ |