handle interactions non visible @descr Sometimes it's necessary to use a non visible interaction handler. More...

#include <quietinteraction.hxx>

Inheritance diagram for framework::QuietInteraction:

Collaboration diagram for framework::QuietInteraction:

Public Member Functions
virtual void SAL_CALL	handle (const css::uno::Reference< css::task::XInteractionRequest > &xRequest) override

	QuietInteraction ()
	ctor to guarantee right initialized instances of this class @threadsafe not necessary More...

css::uno::Any	getRequest () const
	return the handled interaction request @descr We saved any obtained interaction request internally. More...

bool	wasUsed () const
	returns information if interaction was used @descr It can be useful to know the reason for a failed operation. More...

Private Attributes
css::uno::Any	m_aRequest
	in case an unknown interaction was aborted - we save it for our external user! More...

Detailed Description

handle interactions non visible @descr Sometimes it's necessary to use a non visible interaction handler.

He can't do anything, which a visible one can handle. But it can be used to intercept problems e.g. during loading of documents.

In current implementation we solve conflicts for following situations only:

InteractiveIOException
InteractiveAugmentedIOException All other requests will be aborted.

Definition at line 40 of file quietinteraction.hxx.

Constructor & Destructor Documentation

◆ QuietInteraction()

framework::QuietInteraction::QuietInteraction ( )

ctor to guarantee right initialized instances of this class @threadsafe not necessary

Definition at line 36 of file quietinteraction.cxx.

Member Function Documentation

◆ getRequest()

css::uno::Any framework::QuietInteraction::getRequest ( ) const

return the handled interaction request @descr We saved any obtained interaction request internally.

Maybe the outside user of this class is interested on that. Especially we got an unknown interaction and aborted it hard.

Returns: [com.sun.star.uno.Any] the packed interaction request Can be empty if no interaction was used!

@threadsafe yes

Definition at line 115 of file quietinteraction.cxx.

References m_aRequest.

◆ handle()

void SAL_CALL framework::QuietInteraction::handle ( const css::uno::Reference< css::task::XInteractionRequest > & xRequest )

overridevirtual

Definition at line 40 of file quietinteraction.cxx.

References i, ErrCode::IsWarning(), m_aRequest, and nCount.

◆ wasUsed()

bool framework::QuietInteraction::wasUsed ( ) const

returns information if interaction was used @descr It can be useful to know the reason for a failed operation.

Returns: [boolean] <TRUE> for used interaction <FALSE> otherwise

@threadsafe yes

Definition at line 121 of file quietinteraction.cxx.

References m_aRequest.

Member Data Documentation

◆ m_aRequest

css::uno::Any framework::QuietInteraction::m_aRequest

private

in case an unknown interaction was aborted - we save it for our external user!

Definition at line 47 of file quietinteraction.hxx.

Referenced by getRequest(), handle(), and wasUsed().

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

Public Member Functions

Private Attributes