Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
CPDF_Action Class Reference

#include <cpdf_action.h>

Collaboration diagram for CPDF_Action:

Public Types

enum class  Type {
  kUnknown = 0 , kGoTo , kGoToR , kGoToE ,
  kLaunch , kThread , kURI , kSound ,
  kMovie , kHide , kNamed , kSubmitForm ,
  kResetForm , kImportData , kJavaScript , kSetOCGState ,
  kRendition , kTrans , kGoTo3DView , kLast = kGoTo3DView
}

Public Member Functions

 CPDF_Action (RetainPtr< const CPDF_Dictionary > pDict)
 CPDF_Action (const CPDF_Action &that)
 ~CPDF_Action ()
bool HasDict () const
const CPDF_Dictionary * GetDict () const
Type GetType () const
CPDF_Dest GetDest (CPDF_Document *pDoc) const
WideString GetFilePath () const
ByteString GetURI (const CPDF_Document *pDoc) const
bool GetHideStatus () const
ByteString GetNamedAction () const
uint32_t GetFlags () const
bool HasFields () const
std::vector< RetainPtr< const CPDF_Object > > GetAllFields () const
std::optional< WideString > MaybeGetJavaScript () const
WideString GetJavaScript () const
size_t GetSubActionsCount () const
CPDF_Action GetSubAction (size_t iIndex) const

Detailed Description

Definition at line 21 of file cpdf_action.h.

Member Enumeration Documentation

◆ Type

enum class CPDF_Action::Type
strong
Enumerator
kUnknown 
kGoTo 
kGoToR 
kGoToE 
kLaunch 
kThread 
kURI 
kSound 
kMovie 
kHide 
kNamed 
kSubmitForm 
kResetForm 
kImportData 
kJavaScript 
kSetOCGState 
kRendition 
kTrans 
kGoTo3DView 
kLast 

Definition at line 23 of file cpdf_action.h.

Constructor & Destructor Documentation

◆ CPDF_Action() [1/2]

CPDF_Action::CPDF_Action ( RetainPtr< const CPDF_Dictionary > pDict)
explicit

Definition at line 47 of file cpdf_action.cpp.

References CPDF_Action().

Referenced by CPDF_Action().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CPDF_Action() [2/2]

CPDF_Action::CPDF_Action ( const CPDF_Action & that)
default

◆ ~CPDF_Action()

CPDF_Action::~CPDF_Action ( )
default

Member Function Documentation

◆ GetAllFields()

std::vector< RetainPtr< const CPDF_Object > > CPDF_Action::GetAllFields ( ) const

Definition at line 137 of file cpdf_action.cpp.

◆ GetDest()

CPDF_Dest CPDF_Action::GetDest ( CPDF_Document * pDoc) const

Definition at line 73 of file cpdf_action.cpp.

References GetType(), kGoTo, kGoToE, and kGoToR.

Referenced by CPDFSDK_FormFillEnvironment::DoActionGoTo(), FPDFAction_GetDest(), FPDFBookmark_GetDest(), and FPDFLink_GetDest().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetDict()

const CPDF_Dictionary * CPDF_Action::GetDict ( ) const
inline

Definition at line 51 of file cpdf_action.h.

Referenced by FPDF_GetPageAAction(), FPDFBookmark_GetAction(), and FPDFLink_GetAction().

Here is the caller graph for this function:

◆ GetFilePath()

WideString CPDF_Action::GetFilePath ( ) const

Definition at line 81 of file cpdf_action.cpp.

References fxcrt::WideString::WideString(), fxcrt::WideString::FromDefANSI(), CPDF_FileSpec::GetFileName(), GetType(), pdfium::stream::kF, kGoToE, kGoToR, kImportData, kLaunch, and kSubmitForm.

Referenced by CPDFSDK_InteractiveForm::DoAction_SubmitForm(), and FPDFAction_GetFilePath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetFlags()

uint32_t CPDF_Action::GetFlags ( ) const

Definition at line 129 of file cpdf_action.cpp.

Referenced by CPDFSDK_InteractiveForm::DoAction_ResetForm(), and CPDFSDK_InteractiveForm::DoAction_SubmitForm().

Here is the caller graph for this function:

◆ GetHideStatus()

bool CPDF_Action::GetHideStatus ( ) const

Definition at line 121 of file cpdf_action.cpp.

Referenced by CPDFSDK_InteractiveForm::DoAction_Hide().

Here is the caller graph for this function:

◆ GetJavaScript()

WideString CPDF_Action::GetJavaScript ( ) const

Definition at line 173 of file cpdf_action.cpp.

References fxcrt::WideString::WideString().

Referenced by CPDFSDK_FormFillEnvironment::DoActionFieldJavaScript(), CPDFSDK_FormFillEnvironment::DoActionJavaScript(), CPDFSDK_InteractiveForm::OnCalculate(), and CPDFSDK_InteractiveForm::OnFormat().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNamedAction()

ByteString CPDF_Action::GetNamedAction ( ) const

Definition at line 125 of file cpdf_action.cpp.

Referenced by CPDFSDK_FormFillEnvironment::DoActionNamed().

Here is the caller graph for this function:

◆ GetSubAction()

CPDF_Action CPDF_Action::GetSubAction ( size_t iIndex) const

Definition at line 191 of file cpdf_action.cpp.

◆ GetSubActionsCount()

size_t CPDF_Action::GetSubActionsCount ( ) const

Definition at line 178 of file cpdf_action.cpp.

◆ GetType()

CPDF_Action::Type CPDF_Action::GetType ( ) const

Definition at line 54 of file cpdf_action.cpp.

References kLast, and kUnknown.

Referenced by CPDFSDK_FormFillEnvironment::DoActionFieldJavaScript(), CPDFSDK_FormFillEnvironment::DoActionJavaScript(), CPDFSDK_FormFillEnvironment::DoActionLink(), CPDFSDK_FormFillEnvironment::DoActionNoJs(), FPDFAction_GetType(), FPDFDoc_GetJavaScriptAction(), GetDest(), GetFilePath(), GetURI(), CPDFSDK_Widget::OnAAction(), and TEST().

Here is the caller graph for this function:

◆ GetURI()

ByteString CPDF_Action::GetURI ( const CPDF_Document * pDoc) const

Definition at line 104 of file cpdf_action.cpp.

References fxcrt::ByteString::ByteString(), GetType(), and kURI.

Referenced by CPDFSDK_FormFillEnvironment::DoActionURI(), and FPDFAction_GetURIPath().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HasDict()

bool CPDF_Action::HasDict ( ) const
inline

Definition at line 50 of file cpdf_action.h.

Referenced by FPDFBookmark_GetDest(), FPDFLink_GetDest(), CPDFSDK_InteractiveForm::OnCalculate(), CPDFSDK_InteractiveForm::OnFormat(), CPDFSDK_BAAnnot::OnKeyDown(), CPDFSDK_InteractiveForm::OnKeyStrokeCommit(), and CPDFSDK_InteractiveForm::OnValidate().

Here is the caller graph for this function:

◆ HasFields()

bool CPDF_Action::HasFields ( ) const

Definition at line 133 of file cpdf_action.cpp.

Referenced by CPDFSDK_InteractiveForm::DoAction_ResetForm(), and CPDFSDK_InteractiveForm::DoAction_SubmitForm().

Here is the caller graph for this function:

◆ MaybeGetJavaScript()

std::optional< WideString > CPDF_Action::MaybeGetJavaScript ( ) const

Definition at line 166 of file cpdf_action.cpp.

The documentation for this class was generated from the following files: