Field.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2012 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------

#ifndef   H_CPPPDFField
#define   H_CPPPDFField

#include <Common/UString.h>
#include <SDF/Obj.h>
#include <PDF/GState.h>
#include <C/PDF/TRN_Field.h>

namespace pdftron { 
        namespace PDF {

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();

         void SetValue(const UString& value);
         void SetValue(SDF::Obj value);
         void SetValue(const char* value);
                
         void SetValue(bool value);


         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);

        /* 
        * Enumeration specifying the form of quadding (justification) to be used
        * in displaying the text fields. 
        */ 
        enum TextJustification 
        {
                e_left_justified,
                e_centered,
                e_right_justified
        };

         TextJustification GetJustification();

         void SetJustification(TextJustification j);

        void SetMaxLen(int max_len);

        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();


#ifndef SWIGHIDDEN
        TRN_Field mp_field;
        Field ();
#endif

};



        };      // namespace PDF
};      // namespace pdftron


#include <Impl/Page.inl>
#endif

---

© 2002-2012 PDFTron Systems Inc.