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
CXFA_FFApp::CallbackIface Class Referenceabstract

#include <cxfa_ffapp.h>

Inheritance diagram for CXFA_FFApp::CallbackIface:
Collaboration diagram for CXFA_FFApp::CallbackIface:

Public Member Functions

virtual ~CallbackIface ()=default
virtual WideString GetLanguage ()=0
virtual WideString GetPlatform ()=0
virtual WideString GetAppName ()=0
virtual WideString GetAppTitle () const =0
virtual void Beep (uint32_t dwType)=0
virtual int32_t MsgBox (const WideString &wsMessage, const WideString &wsTitle, uint32_t dwIconType, uint32_t dwButtonType)=0
virtual WideString Response (const WideString &wsQuestion, const WideString &wsTitle, const WideString &wsDefaultAnswer, bool bMask)=0
virtual RetainPtr< IFX_SeekableReadStream > DownloadURL (const WideString &wsURL)=0
virtual bool PostRequestURL (const WideString &wsURL, const WideString &wsData, const WideString &wsContentType, const WideString &wsEncode, const WideString &wsHeader, WideString &wsResponse)=0
virtual bool PutRequestURL (const WideString &wsURL, const WideString &wsData, const WideString &wsEncode)=0
virtual CFX_Timer::HandlerIface * GetTimerHandler () const =0
virtual cppgc::Heap * GetGCHeap () const =0

Detailed Description

Definition at line 29 of file cxfa_ffapp.h.

Constructor & Destructor Documentation

◆ ~CallbackIface()

virtual CXFA_FFApp::CallbackIface::~CallbackIface ( )
virtualdefault

Member Function Documentation

◆ Beep()

virtual void CXFA_FFApp::CallbackIface::Beep ( uint32_t dwType)
pure virtual

Causes the system to play a sound.

Parameters
[in]dwTypeThe system code for the appropriate sound.0 (Error)1 (Warning)2 (Question)3 (Status)4 (Default)

Implemented in CPDFXFA_Context.

◆ DownloadURL()

virtual RetainPtr< IFX_SeekableReadStream > CXFA_FFApp::CallbackIface::DownloadURL ( const WideString & wsURL)
pure virtual

Download something from somewhere.

Parameters
[in]wsURL- http, ftp, such as "http://www.w3.org/TR/REC-xml-names/".

Implemented in CPDFXFA_Context.

◆ GetAppName()

virtual WideString CXFA_FFApp::CallbackIface::GetAppName ( )
pure virtual

Get application name, such as Phantom.

Implemented in CPDFXFA_Context.

◆ GetAppTitle()

virtual WideString CXFA_FFApp::CallbackIface::GetAppTitle ( ) const
pure virtual

Get application message box title.

Implemented in CPDFXFA_Context.

◆ GetGCHeap()

virtual cppgc::Heap * CXFA_FFApp::CallbackIface::GetGCHeap ( ) const
pure virtual

Implemented in CPDFXFA_Context.

◆ GetLanguage()

virtual WideString CXFA_FFApp::CallbackIface::GetLanguage ( )
pure virtual

Returns the language of the running host application. Such as zh_CN

Implemented in CPDFXFA_Context.

◆ GetPlatform()

virtual WideString CXFA_FFApp::CallbackIface::GetPlatform ( )
pure virtual

Returns the platform of the machine running the script. Such as WIN

Implemented in CPDFXFA_Context.

◆ GetTimerHandler()

virtual CFX_Timer::HandlerIface * CXFA_FFApp::CallbackIface::GetTimerHandler ( ) const
pure virtual

Implemented in CPDFXFA_Context.

◆ MsgBox()

virtual int32_t CXFA_FFApp::CallbackIface::MsgBox ( const WideString & wsMessage,
const WideString & wsTitle,
uint32_t dwIconType,
uint32_t dwButtonType )
pure virtual

Displays a message box.

Parameters
[in]wsMessage- Message string to display in box.
[in]wsTitle- Title string for box.
[in]dwIconType- Icon type, refer to XFA_MBICON.
[in]dwButtonType- Button type, refer to XFA_MESSAGEBUTTON.
Returns
A valid integer representing the value of the button pressed by the user, refer to XFA_ID.

Implemented in CPDFXFA_Context.

Referenced by CXFA_FFField::CalculateNode().

Here is the caller graph for this function:

◆ PostRequestURL()

virtual bool CXFA_FFApp::CallbackIface::PostRequestURL ( const WideString & wsURL,
const WideString & wsData,
const WideString & wsContentType,
const WideString & wsEncode,
const WideString & wsHeader,
WideString & wsResponse )
pure virtual

POST data to the given url.

Parameters
[in]wsURLthe URL being uploaded.
[in]wsDatathe data being uploaded.
[in]wsContentTypethe content type of data including text/html, text/xml, text/plain, multipart/form-data, application/x-www-form-urlencoded, application/octet-stream, any valid MIME type.
[in]wsEncodethe encode of data including UTF-8, UTF-16, ISO8859-1, any recognized [IANA]character encoding
[in]wsHeaderany additional HTTP headers to be included in the post.
[out]wsResponsedecoded response from server.
Returns
true Server permitted the post request, false otherwise.

Implemented in CPDFXFA_Context.

Referenced by CFXJSE_FormCalcContext::Post().

Here is the caller graph for this function:

◆ PutRequestURL()

virtual bool CXFA_FFApp::CallbackIface::PutRequestURL ( const WideString & wsURL,
const WideString & wsData,
const WideString & wsEncode )
pure virtual

PUT data to the given url.

Parameters
[in]wsURLthe URL being uploaded.
[in]wsDatathe data being uploaded.
[in]wsEncodethe encode of data including UTF-8, UTF-16, ISO8859-1, any recognized [IANA]character encoding
Returns
true Server permitted the post request, false otherwise.

Implemented in CPDFXFA_Context.

Referenced by CFXJSE_FormCalcContext::Put().

Here is the caller graph for this function:

◆ Response()

virtual WideString CXFA_FFApp::CallbackIface::Response ( const WideString & wsQuestion,
const WideString & wsTitle,
const WideString & wsDefaultAnswer,
bool bMask )
pure virtual

Get a response from the user.

Parameters
[in]wsQuestion- Message string to display in box.
[in]wsTitle- Title string for box.
[in]wsDefaultAnswer- Initial contents for answer.
[in]bMask- Mask the user input with asterisks when true,
Returns
A string containing the user's response.

Implemented in CPDFXFA_Context.

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