blob: 945545f4ba55c861829d9d6e335374a065e603ce [file] [log] [blame]
// 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.
#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/retain_ptr.h"
#include "core/fxcrt/unowned_ptr.h"
class CPDF_Dictionary;
class CPDF_Font;
class CPDF_FormControl;
class CPDF_InteractiveForm;
class CPDF_Object;
class CPDF_String;
enum class NotificationOption : bool { kDoNotNotify = false, kNotify = true };
enum class FormFieldType : uint8_t {
kUnknown = 0,
kPushButton = 1,
kCheckBox = 2,
kRadioButton = 3,
kComboBox = 4,
kListBox = 5,
kTextField = 6,
kSignature = 7,
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
// If values are added to FormFieldType, these will need to be updated.
constexpr size_t kFormFieldTypeCount = 16;
constexpr size_t kFormFieldTypeCount = 8;
#endif // PDF_ENABLE_XFA
class CPDF_FormField {
enum Type {
CPDF_FormField(CPDF_InteractiveForm* pForm, CPDF_Dictionary* pDict);
static Optional<FormFieldType> IntToFormFieldType(int value);
static const CPDF_Object* GetFieldAttr(const CPDF_Dictionary* pFieldDict,
const ByteString& name);
static CPDF_Object* GetFieldAttr(CPDF_Dictionary* pFieldDict,
const ByteString& name);
static WideString GetFullNameForDict(CPDF_Dictionary* pFieldDict);
WideString GetFullName() const;
Type GetType() const { return m_Type; }
CPDF_Dictionary* GetFieldDict() const { return m_pDict.Get(); }
bool ResetField();
int CountControls() const;
CPDF_FormControl* GetControl(int index) const;
int GetControlIndex(const CPDF_FormControl* pControl) const;
FormFieldType GetFieldType() const;
CPDF_AAction GetAdditionalAction() const;
WideString GetAlternateName() const;
WideString GetMappingName() const;
uint32_t GetFieldFlags() const;
void SetFieldFlags(uint32_t dwFlags);
ByteString GetDefaultStyle() const;
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, 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(const WideString& csOptValue) const;
bool CheckControl(int iControlIndex,
bool bChecked,
NotificationOption notify);
int GetTopVisibleIndex() const;
int CountSelectedOptions() const;
int GetSelectedOptionIndex(int index) const;
bool IsSelectedOption(const WideString& wsOptValue) const;
bool IsSelectedIndex(int iOptIndex) const;
void SelectOption(int iOptIndex);
// Verifies if there is a valid selected indicies (/I) object and whether its
// entries are consistent with the value (/V) object.
bool UseSelectedIndicesObject() const;
float GetFontSize() const { return m_FontSize; }
CPDF_Font* GetFont() const { return m_pFont.Get(); }
CPDF_Dictionary* GetDict() const { return m_pDict.Get(); }
CPDF_InteractiveForm* GetForm() const { return m_pForm.Get(); }
WideString GetCheckValue(bool bDefault) const;
void SetOpt(RetainPtr<CPDF_Object> pOpt);
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);
void SetItemSelectionSelected(int index, const WideString& opt_value);
bool NotifyBeforeSelectionChange(const WideString& value);
void NotifyAfterSelectionChange();
bool NotifyBeforeValueChange(const WideString& value);
void NotifyAfterValueChange();
bool NotifyListOrComboBoxBeforeChange(const WideString& value);
void NotifyListOrComboBoxAfterChange();
const CPDF_Object* GetDefaultValueObject() const;
const CPDF_Object* GetValueObject() const;
// For choice fields.
const CPDF_Object* GetSelectedIndicesObject() const;
// For choice fields.
// Value object takes precedence over selected indices object.
const CPDF_Object* GetValueOrSelectedIndicesObject() const;
const std::vector<UnownedPtr<CPDF_FormControl>>& GetControls() const;
CPDF_FormField::Type m_Type = kUnknown;
bool m_bRequired = false;
bool m_bNoExport = false;
bool m_bIsMultiSelectListBox = false;
bool m_bIsUnison = false;
bool m_bUseSelectedIndices = false;
float m_FontSize = 0;
UnownedPtr<CPDF_InteractiveForm> const m_pForm;
RetainPtr<CPDF_Dictionary> const m_pDict;
RetainPtr<CPDF_Font> m_pFont;