LOKInteractionHandler Class Reference

InteractionHandler is an interface that provides the user with various dialogs / error messages. More...

#include <lokinteractionhandler.hxx>

Inheritance diagram for LOKInteractionHandler:

Collaboration diagram for LOKInteractionHandler:

Public Member Functions
void	SetPassword (char const *pPassword)
	LOKInteractionHandler (OString command, desktop::LibLibreOffice_Impl *, desktop::LibLODocument_Impl *pLOKDocumt=nullptr)
virtual	~LOKInteractionHandler () override
virtual OUString SAL_CALL	getImplementationName () override
virtual sal_Bool SAL_CALL	supportsService (OUString const &rServiceName) override
virtual com::sun::star::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override
virtual void SAL_CALL	initialize (com::sun::star::uno::Sequence< com::sun::star::uno::Any > const &rArguments) override
virtual void SAL_CALL	handle (com::sun::star::uno::Reference< com::sun::star::task::XInteractionRequest > const &rRequest) override
virtual sal_Bool SAL_CALL	handleInteractionRequest (const ::com::sun::star::uno::Reference<::com::sun::star::task::XInteractionRequest > &Request) override

Private Member Functions
	LOKInteractionHandler (const LOKInteractionHandler &)=delete
LOKInteractionHandler &	operator= (const LOKInteractionHandler &)=delete
void	postError (css::task::InteractionClassification classif, const char *kind, ErrCode code, const OUString &message)
	Call the LOK_CALLBACK_ERROR on the LOK document (if available) or LOK lib. More...
bool	handleIOException (const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &rContinuations, const css::uno::Any &rRequest)
bool	handleNetworkException (const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &rContinuations, const css::uno::Any &rRequest)
bool	handlePasswordRequest (const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &rContinuations, const css::uno::Any &rRequest)

Static Private Member Functions
static bool	handleMacroConfirmationRequest (const css::uno::Reference< css::task::XInteractionRequest > &xRequest)
static bool	handleFilterOptionsRequest (const ::com::sun::star::uno::Reference<::com::sun::star::task::XInteractionRequest > &Request)

Private Attributes
desktop::LibLibreOffice_Impl *	m_pLOKit
desktop::LibLODocument_Impl *	m_pLOKDocument
OString	m_command
	Command for which we use this interaction handler (like "load", "save", "saveas", ...) More...
OUString	m_Password
bool	m_usePassword
osl::Condition	m_havePassword

Detailed Description

InteractionHandler is an interface that provides the user with various dialogs / error messages.

We need an own implementation for the LibreOfficeKit so that we can route the information easily via callbacks.

TODO: the callbacks are not implemented yet, we just approve any interaction that we get.

Definition at line 44 of file lokinteractionhandler.hxx.

Constructor & Destructor Documentation

LOKInteractionHandler() [1/2]

LOKInteractionHandler::LOKInteractionHandler ( const LOKInteractionHandler &  )

privatedelete

LOKInteractionHandler() [2/2]

LOKInteractionHandler::LOKInteractionHandler ( OString  command, desktop::LibLibreOffice_Impl *  pLOKit, desktop::LibLODocument_Impl *  pLOKDocumt = nullptr  )

explicit

Definition at line 55 of file lokinteractionhandler.cxx.

References m_pLOKit.

~LOKInteractionHandler()

LOKInteractionHandler::~LOKInteractionHandler ( )

overridevirtual

Definition at line 67 of file lokinteractionhandler.cxx.

Member Function Documentation

getImplementationName()

OUString SAL_CALL LOKInteractionHandler::getImplementationName ( )

overridevirtual

Definition at line 71 of file lokinteractionhandler.cxx.

getSupportedServiceNames()

uno::Sequence< OUString > SAL_CALL LOKInteractionHandler::getSupportedServiceNames ( )

overridevirtual

Definition at line 81 of file lokinteractionhandler.cxx.

handle()

void SAL_CALL LOKInteractionHandler::handle ( com::sun::star::uno::Reference< com::sun::star::task::XInteractionRequest > const &  rRequest )

overridevirtual

Definition at line 94 of file lokinteractionhandler.cxx.

References handleInteractionRequest().

handleFilterOptionsRequest()

bool LOKInteractionHandler::handleFilterOptionsRequest ( const ::com::sun::star::uno::Reference<::com::sun::star::task::XInteractionRequest > &  Request )

staticprivate

Definition at line 353 of file lokinteractionhandler.cxx.

Referenced by handleInteractionRequest().

handleInteractionRequest()

sal_Bool SAL_CALL LOKInteractionHandler::handleInteractionRequest ( const ::com::sun::star::uno::Reference<::com::sun::star::task::XInteractionRequest > &  Request )

overridevirtual

Definition at line 371 of file lokinteractionhandler.cxx.

References handleFilterOptionsRequest(), handleIOException(), handleMacroConfirmationRequest(), handleNetworkException(), and handlePasswordRequest().

Referenced by handle().

handleIOException()

bool LOKInteractionHandler::handleIOException ( const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &  rContinuations, const css::uno::Any &  rRequest  )

private

Definition at line 143 of file lokinteractionhandler.cxx.

References ERRCODE_IO_ABORT, ERRCODE_IO_ACCESSDENIED, ERRCODE_IO_ALREADYEXISTS, ERRCODE_IO_BADCRC, ERRCODE_IO_CANTCREATE, ERRCODE_IO_CANTREAD, ERRCODE_IO_CANTSEEK, ERRCODE_IO_CANTTELL, ERRCODE_IO_CANTWRITE, ERRCODE_IO_CURRENTDIR, ERRCODE_IO_DEVICENOTREADY, ERRCODE_IO_GENERAL, ERRCODE_IO_INVALIDACCESS, ERRCODE_IO_INVALIDCHAR, ERRCODE_IO_INVALIDDEVICE, ERRCODE_IO_INVALIDLENGTH, ERRCODE_IO_INVALIDPARAMETER, ERRCODE_IO_ISWILDCARD, ERRCODE_IO_LOCKVIOLATION, ERRCODE_IO_MISPLACEDCHAR, ERRCODE_IO_NAMETOOLONG, ERRCODE_IO_NOTADIRECTORY, ERRCODE_IO_NOTAFILE, ERRCODE_IO_NOTEXISTS, ERRCODE_IO_NOTEXISTSPATH, ERRCODE_IO_NOTSAMEDEVICE, ERRCODE_IO_NOTSUPPORTED, ERRCODE_IO_OUTOFMEMORY, ERRCODE_IO_OUTOFSPACE, ERRCODE_IO_PENDING, ERRCODE_IO_RECURSIVE, ERRCODE_IO_TOOMANYOPENFILES, ERRCODE_IO_UNKNOWN, ERRCODE_IO_WRITEPROTECTED, ERRCODE_IO_WRONGFORMAT, ERRCODE_IO_WRONGVERSION, and postError().

Referenced by handleInteractionRequest().

handleMacroConfirmationRequest()

bool LOKInteractionHandler::handleMacroConfirmationRequest ( const css::uno::Reference< css::task::XInteractionRequest > &  xRequest )

staticprivate

Definition at line 336 of file lokinteractionhandler.cxx.

References comphelper::getProcessComponentContext().

Referenced by handleInteractionRequest().

handleNetworkException()

bool LOKInteractionHandler::handleNetworkException ( const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &  rContinuations, const css::uno::Any &  rRequest  )

private

Definition at line 195 of file lokinteractionhandler.cxx.

References ERRCODE_INET_CONNECT, ERRCODE_INET_GENERAL, ERRCODE_INET_NAME_RESOLVE, ERRCODE_INET_OFFLINE, ERRCODE_INET_READ, ERRCODE_INET_WRITE, and postError().

Referenced by handleInteractionRequest().

handlePasswordRequest()

bool LOKInteractionHandler::handlePasswordRequest ( const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &  rContinuations, const css::uno::Any &  rRequest  )

private

Definition at line 244 of file lokinteractionhandler.cxx.

References desktop::LibLibreOffice_Impl::hasOptionalFeature(), m_havePassword, m_Password, m_pLOKit, m_usePassword, desktop::LibLibreOffice_Impl::mpCallback, and desktop::LibLibreOffice_Impl::mpCallbackData.

Referenced by handleInteractionRequest().

initialize()

void SAL_CALL LOKInteractionHandler::initialize ( com::sun::star::uno::Sequence< com::sun::star::uno::Any > const &  rArguments )

overridevirtual

Definition at line 90 of file lokinteractionhandler.cxx.

operator=()

LOKInteractionHandler & LOKInteractionHandler::operator= ( const LOKInteractionHandler &  )

privatedelete

postError()

void LOKInteractionHandler::postError ( css::task::InteractionClassification  classif, const char *  kind, ErrCode  code, const OUString &  message  )

private

Call the LOK_CALLBACK_ERROR on the LOK document (if available) or LOK lib.

The error itself is a JSON message, like: { "classification": "error" | "warning" | "info" "kind": "network" etc. "code": 403 | 404 | ... "message": freeform description }

Definition at line 101 of file lokinteractionhandler.cxx.

References code, SfxViewShell::Current(), tools::JsonWriter::finishAndGetAsOString(), SfxLokHelper::getView(), m_command, m_pLOKDocument, m_pLOKit, desktop::LibLibreOffice_Impl::mpCallback, desktop::LibLibreOffice_Impl::mpCallbackData, desktop::LibLODocument_Impl::mpCallbackFlushHandlers, and tools::JsonWriter::put().

Referenced by handleIOException(), and handleNetworkException().

SetPassword()

void LOKInteractionHandler::SetPassword

(

char const *

pPassword

)

Definition at line 398 of file lokinteractionhandler.cxx.

References m_havePassword, m_Password, and m_usePassword.

supportsService()

sal_Bool SAL_CALL LOKInteractionHandler::supportsService ( OUString const &  rServiceName )

overridevirtual

Definition at line 76 of file lokinteractionhandler.cxx.

References cppu::supportsService().

Member Data Documentation

m_command

OString LOKInteractionHandler::m_command

private

Command for which we use this interaction handler (like "load", "save", "saveas", ...)

Definition at line 53 of file lokinteractionhandler.hxx.

Referenced by postError().

m_havePassword

osl::Condition LOKInteractionHandler::m_havePassword

private

Definition at line 57 of file lokinteractionhandler.hxx.

Referenced by handlePasswordRequest(), and SetPassword().

m_Password

OUString LOKInteractionHandler::m_Password

private

Definition at line 55 of file lokinteractionhandler.hxx.

Referenced by handlePasswordRequest(), and SetPassword().

m_pLOKDocument

desktop::LibLODocument_Impl* LOKInteractionHandler::m_pLOKDocument

private

Definition at line 50 of file lokinteractionhandler.hxx.

Referenced by postError().

m_pLOKit

desktop::LibLibreOffice_Impl* LOKInteractionHandler::m_pLOKit

private

Definition at line 49 of file lokinteractionhandler.hxx.

Referenced by handlePasswordRequest(), LOKInteractionHandler(), and postError().

m_usePassword

bool LOKInteractionHandler::m_usePassword

private

Definition at line 56 of file lokinteractionhandler.hxx.

Referenced by handlePasswordRequest(), and SetPassword().

---

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

• lokinteractionhandler.hxx
• lokinteractionhandler.cxx