Field.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFField
#define PDFTRON_H_CPPPDFField
 
#include <Common/UString.h>
#include <SDF/Obj.h>
#include <PDF/GState.h>
#include <C/PDF/TRN_Field.h>
#include <SDF/SignatureHandler.h>
#include <PDF/ViewChangeCollection.h>
 
namespace pdftron { 
    namespace PDF {
 
class Page;

class Field
{
public: 
 
     Field (SDF::Obj field_dict);
 
     Field (const Field& p);
     Field& operator= (const Field& p);
     ~Field();
     
     bool IsValid() const;

    enum Type
    {
        e_button,       // Pushbutton field
        e_check,        // Check box field
        e_radio,        // Radio button field
        e_text,         // Text field
        e_choice,       // Choice field
        e_signature,    // Digital signature field
        e_null            // Unknown field type
    };

     Type GetType() const;

     SDF::Obj GetValue();
     UString GetValueAsString();
       
     bool GetValueAsBool();

     ViewChangeCollection SetValue(const UString& value);
     ViewChangeCollection SetValue(SDF::Obj value);
     ViewChangeCollection SetValue(const char* value);
        
     enum ActionTriggerEvent
     {
         e_action_trigger_keystroke = 13, //Triggered when user modifies text, or selection, in a text, combo or list field
         e_action_trigger_format = 14, //Triggered before a field value is displayed. 
         e_action_trigger_validate = 15, //Triggered when a field value is changed
         e_action_trigger_calculate = 16 //Triggered when field is recalculated due to a change in another field
     };
     
     ViewChangeCollection SetValue(bool value);

     SDF::Obj GetTriggerAction(Field::ActionTriggerEvent trigger);
 
     void RefreshAppearance();
 
     void EraseAppearance();

     SDF::Obj GetDefaultValue();
     UString GetDefaultValueAsString();

     UString GetName();

     UString GetPartialName();

     void Rename(const UString& field_name);

     bool IsAnnot() const;

    enum Flag
    {        
        e_read_only,                // Common flags
        e_required,
        e_no_export,
        
        e_pushbutton_flag,          // Pushbutton flags
        
        e_radio_flag,               // Radio buttons flags
        e_toggle_to_off,            
        e_radios_in_unison,
        
        e_multiline,                // Text fields flags
        e_password,
        e_file_select,
        e_no_spellcheck,
        e_no_scroll,
        e_comb,
        e_rich_text,
         
        e_combo,                    // Choice fields flags
        e_edit,
        e_sort,
        e_multiselect,
        e_commit_on_sel_change
    };

     bool GetFlag(Flag flag) const;
    
     void SetFlag(Flag flag, bool value);
 
    enum TextJustification 
    {
        e_left_justified,
        e_centered,
        e_right_justified
    };

     TextJustification GetJustification();

     void SetJustification(TextJustification j);

    void SetMaxLen(int max_len);

    int GetOptCount() const;

    UString GetOpt(int index);
    
    int GetMaxLen() const;

    GState GetDefaultAppearance();

     void Flatten(class Page page);

     Rect GetUpdateRect() const;

     SDF::Obj FindInheritedAttribute (const char* attrib) const;

     SDF::Obj GetSDFObj () const;
 
     operator bool () { return IsValid();}

     void Destroy();

    SDF::Obj UseSignatureHandler(const SDF::SignatureHandlerId signature_handler_id);

    bool IsLockedByDigitalSignature() const;
    
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    TRN_Field mp_field;
    Field ();
#endif
// @endcond
 
};
 
 
 
    };  // namespace PDF
};  // namespace pdftron
 
 
#include <Impl/Page.inl>
 
#endif // PDFTRON_H_CPPPDFField