PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
action.h
1// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
2
3#ifndef PDFSDK_CXX_PDF_ACTION_H_INCLUDED_
4#define PDFSDK_CXX_PDF_ACTION_H_INCLUDED_
5
6#include <string>
7#include <vector>
8
10
11#include "forward_declarations.h"
12#include "wrapper_base.h"
13
14namespace PDF {
15
21class Action : public detail::RefCountedHandle<PDAction> {
22public:
28 static Action CreateFromPdfObject(const Object& object);
29
35
41 bool Equals(const Action& that) const;
42
47 PDAtom GetActionType() const;
48
53 void SetNext(const Action& next);
54
59 void SetNextArray(const std::vector<Action>& next);
60
65 size_t GetNextLength() const;
66
72 Action GetNext(size_t index);
73
79
84 void SetGoToDest(const Dest& destination);
85
91
96 void SetGoToRFileSpec(const FileSpec& filespec);
97
103
108 void SetGoToRDest(const Dest& destination);
109
114 bool GetGoToRNewWindow() const;
115
120 void SetGoToRNewWindow(bool newWindow);
121
126 std::wstring GetGoToEFileName() const;
127
132 void SetGoToEFileName(const std::wstring& filename);
133
139
144 void SetGoToETarget(const Object& target);
145
151
156 void SetGoToEFileSpec(const FileSpec& filespec);
157
163
168 void SetGoToEDest(const Dest& destination);
169
174 bool GetGoToENewWindow() const;
175
180 void SetGoToENewWindow(bool newWindow);
181
187
192 void SetLaunchFileSpec(const FileSpec& filespec);
193
198 bool GetLaunchNewWindow() const;
199
204 void SetLaunchNewWindow(bool newWindow);
205
210 std::string GetURIURI() const;
211
216 void SetURIURI(const std::string& uri);
217
222 bool GetURIIsMap() const;
223
228 void SetURIIsMap(bool isMap);
229
234 size_t GetHideNumItems() const;
235
240 void RemoveHideItem(size_t index);
241
248
254 Annot GetHideItemAnnot(size_t index) const;
255
261 std::wstring GetHideItemFieldName(size_t index) const;
262
268
273 void AddHideItemFieldName(const std::wstring& name);
274
279 bool IsHideHiding() const;
280
285 void SetHideHiding(bool isHiding);
286
291 PDAtom GetNamedName() const;
292
297 void SetNamedName(PDAtom name);
298
303 std::wstring GetJavaScriptScript() const;
304
309 void SetJavaScriptScript(const std::wstring& script);
310
311 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Action, PDAction)
312};
313
314} // namespace PDF
315
316#include "action_impl.inl"
317
318#endif // PDFSDK_CXX_PDF_ACTION_H_INCLUDED_
Action API.
PDActionHideItemType
Defines actions that can hide or show specific elements within a PDF document.
Definition actions.h:47
Represents an action in a PDF document.
Definition action.h:21
void SetURIURI(const std::string &uri)
void SetGoToDest(const Dest &destination)
bool GetLaunchNewWindow() const
void SetGoToENewWindow(bool newWindow)
void SetNamedName(PDAtom name)
FileSpec GetGoToRFileSpec() const
void SetGoToRNewWindow(bool newWindow)
bool IsHideHiding() const
void AddHideItemAnnot(Annot annot)
Annot GetHideItemAnnot(size_t index) const
void SetGoToEFileSpec(const FileSpec &filespec)
void SetLaunchNewWindow(bool newWindow)
void SetGoToRFileSpec(const FileSpec &filespec)
PDAtom GetActionType() const
void SetURIIsMap(bool isMap)
Object GetGoToETarget() const
Object GetPdfObject() const
static Action CreateFromPdfObject(const Object &object)
void AddHideItemFieldName(const std::wstring &name)
bool GetURIIsMap() const
std::wstring GetJavaScriptScript() const
bool Equals(const Action &that) const
FileSpec GetGoToEFileSpec() const
Dest GetGoToRDest() const
bool GetGoToRNewWindow() const
void SetHideHiding(bool isHiding)
FileSpec GetLaunchFileSpec() const
void SetGoToRDest(const Dest &destination)
PDAtom GetNamedName() const
std::wstring GetGoToEFileName() const
std::string GetURIURI() const
size_t GetNextLength() const
Dest GetGoToDest() const
void SetNextArray(const std::vector< Action > &next)
void SetGoToETarget(const Object &target)
void SetNext(const Action &next)
Dest GetGoToEDest() const
void SetGoToEDest(const Dest &destination)
Action GetNext(size_t index)
void RemoveHideItem(size_t index)
void SetLaunchFileSpec(const FileSpec &filespec)
std::wstring GetHideItemFieldName(size_t index) const
void SetGoToEFileName(const std::wstring &filename)
void SetJavaScriptScript(const std::wstring &script)
size_t GetHideNumItems() const
PDActionHideItemType GetHideItemType(size_t index) const
bool GetGoToENewWindow() const
Represents an annotation in a PDF document.
Definition annot.h:19
Represents a destination in a PDF document.
Definition dest.h:23
Represents a file specification in a PDF document.
Definition filespec.h:21
Represents a PDF object.
Definition object.h:20