Action.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_CPPPDFAction
#define PDFTRON_H_CPPPDFAction
 
#include <PDF/FileSpec.h>
#include <SDF/Obj.h>
#include <C/PDF/TRN_Action.h>
#include <PDF/KeyStrokeActionResult.h>
#include <PDF/KeyStrokeEventData.h>
 
namespace pdftron { 
    namespace PDF {
 
class Destination;

class Action
{
public:

     static Action CreateGoto(class Destination dest);

     static Action CreateGoto(const UChar* key, int key_sz, class Destination dest);

     static Action CreateGotoRemote(const FileSpec& file, int page_num);

     static Action CreateGotoRemote(const FileSpec& file, int page_num, bool new_window);

     static Action CreateURI(SDF::SDFDoc& doc, const char* uri);

     static Action CreateURI(SDF::SDFDoc& doc, UString& uri);

     static Action CreateSubmitForm(const FileSpec& url);

    static Action CreateLaunch(SDF::SDFDoc& doc, const char* path);

#ifndef SWIG
    static Action CreateHideField(SDF::SDFDoc& sdfdoc, int list_length, const char** field);
#endif
    static Action CreateHideField(SDF::SDFDoc& sdfdoc, const std::vector<std::string>& field);

    static Action CreateImportData(SDF::SDFDoc& doc, const char* path);

    static Action CreateResetForm(SDF::SDFDoc& doc);

    static Action CreateJavaScript(SDF::SDFDoc& doc, const char* script);

     Action (SDF::Obj in_obj = 0);

     Action (const Action& in_action);

     Action& operator=(const Action& in_action);

     bool operator==(const Action& in_action);
     
     bool IsValid() const;
 
 
    enum Type 
    {
        e_GoTo,         
        e_GoToR,        
        e_GoToE,        
        e_Launch,       
        e_Thread,       
        e_URI,          
        e_Sound,        
        e_Movie,        
        e_Hide,         
        e_Named,        
        e_SubmitForm,   
        e_ResetForm,    
        e_ImportData,   
        e_JavaScript,   
        e_SetOCGState,  
        e_Rendition,    
        e_Trans,        
        e_GoTo3DView,   
        e_RichMediaExecute, 
        e_Unknown       
    };
 
     Type GetType() const;

    void Execute();

    KeyStrokeActionResult ExecuteKeyStrokeAction(const KeyStrokeEventData& data);

    bool NeedsWriteLock();

    SDF::Obj GetNext() const;

     class Destination GetDest();
 

    enum FormActionFlag
    {
        e_exclude = 0,
        e_include_no_value_fields  = 1,
        e_export_format = 2,         // submit in HTML format if set, FDF format if clear
        e_get_method = 3,
        e_submit_coordinates = 4,
        e_xfdf = 5,
        e_include_append_saves = 6,
        e_include_annotations = 7,
        e_submit_pdf = 8,
        e_canonical_format = 9,
        e_excl_non_user_annots = 10,
        e_excl_F_key = 11,
        // bit 12 is unused by PDF standard
        e_embed_form = 13
    };

    bool GetFormActionFlag( FormActionFlag flag ) const ;

    void SetFormActionFlag( FormActionFlag flag, bool value );
 

     SDF::Obj GetSDFObj () const;
 
     
     //for xamarin use only
     static Action* CreateInternal(ptrdiff_t impl);
     ptrdiff_t GetHandleInternal();
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
     Action(TRN_Action impl);
     TRN_Action mp_action;
#endif
// @endcond
};
 
    }   // namespace PDF
}   // namespace pdftron
 
 
#include <Impl/Page.inl>
 
#endif // PDFTRON_H_CPPPDFAction