action.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_ACTION_H_INCLUDED_
#define PDFSDK_CXX_PDF_ACTION_H_INCLUDED_
 
#include <string>
#include <vector>
 
#include <pdfsdk/core/actions.h>
 
#include "forward_declarations.h"
#include "wrapper_base.h"
 
namespace PDF {
 
class Action : public detail::RefCountedHandle<PDAction> {
public:
    static Action CreateFromPdfObject(const Object& object);
 
    Object GetPdfObject() const;
 
    bool Equals(const Action& that) const;
 
    PDAtom GetActionType() const;
 
    void SetNext(const Action& next);
 
    void SetNextArray(const std::vector<Action>& next);
 
    size_t GetNextLength() const;
 
    Action GetNext(size_t index);
 
    Dest GetGoToDest() const;
 
    void SetGoToDest(const Dest& destination);
 
    FileSpec GetGoToRFileSpec() const;
 
    void SetGoToRFileSpec(const FileSpec& filespec);
 
    Dest GetGoToRDest() const;
 
    void SetGoToRDest(const Dest& destination);
 
    bool GetGoToRNewWindow() const;
 
    void SetGoToRNewWindow(bool newWindow);
 
    std::wstring GetGoToEFileName() const;
 
    void SetGoToEFileName(const std::wstring& filename);
 
    Object GetGoToETarget() const;
 
    void SetGoToETarget(const Object& target);
 
    FileSpec GetGoToEFileSpec() const;
 
    void SetGoToEFileSpec(const FileSpec& filespec);
 
    Dest GetGoToEDest() const;
 
    void SetGoToEDest(const Dest& destination);
 
    bool GetGoToENewWindow() const;
 
    void SetGoToENewWindow(bool newWindow);
 
    FileSpec GetLaunchFileSpec() const;
 
    void SetLaunchFileSpec(const FileSpec& filespec);
 
    bool GetLaunchNewWindow() const;
 
    void SetLaunchNewWindow(bool newWindow);
 
    std::string GetURIURI() const;
 
    void SetURIURI(const std::string& uri);
 
    bool GetURIIsMap() const;
 
    void SetURIIsMap(bool isMap);
 
    size_t GetHideNumItems() const;
 
    void RemoveHideItem(size_t index);
 
    PDActionHideItemType GetHideItemType(size_t index) const;
 
    Annot GetHideItemAnnot(size_t index) const;
 
    std::wstring GetHideItemFieldName(size_t index) const;
 
    void AddHideItemAnnot(Annot annot);
 
    void AddHideItemFieldName(const std::wstring& name);
 
    bool IsHideHiding() const;
 
    void SetHideHiding(bool isHiding);
 
    PDAtom GetNamedName() const;
 
    void SetNamedName(PDAtom name);
 
    std::wstring GetJavaScriptScript() const;
 
    void SetJavaScriptScript(const std::wstring& script);
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Action, PDAction)
};
 
}  // namespace PDF
 
#include "action_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_ACTION_H_INCLUDED_