Prevent us from showing the same interaction more than once during the same transaction. More...

#include <preventduplicateinteraction.hxx>

Inheritance diagram for sfx2::PreventDuplicateInteraction:

Collaboration diagram for sfx2::PreventDuplicateInteraction:

Classes
struct	InteractionInfo

Public Member Functions
virtual void SAL_CALL	initialize (const css::uno::Sequence< css::uno::Any > &rArguments) override

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

virtual sal_Bool SAL_CALL	handleInteractionRequest (const css::uno::Reference< css::task::XInteractionRequest > &xRequest) override

virtual css::uno::Any SAL_CALL	queryInterface (const css::uno::Type &aType) override

	PreventDuplicateInteraction (css::uno::Reference< css::uno::XComponentContext > xContext)
	ctor to guarantee right initialized instances of this class @descr It uses the given uno service manager to create the global generic UI interaction handler for later internal using. More...

virtual	~PreventDuplicateInteraction () override
	dtor to free used memory. More...

void	setHandler (const css::uno::Reference< css::task::XInteractionHandler > &xHandler)
	set the outside interaction handler, which must be used internally if the interaction will not be blocked by the set list of rules. More...

void	useDefaultUUIHandler ()
	instead of setting an outside interaction handler, this method make sure the default UUI interaction handler of the office is used. More...

void	addInteractionRule (const PreventDuplicateInteraction::InteractionInfo &aInteractionInfo)
	add a new interaction to the list of interactions, which must be handled by this helper. More...

bool	getInteractionInfo (const css::uno::Type &aInteraction, PreventDuplicateInteraction::InteractionInfo *pReturn) const
	return the info struct for the specified interaction. More...

Private Attributes
std::mutex	m_aLock

css::uno::Reference< css::uno::XComponentContext >	m_xContext
	Used to create needed uno services at runtime. More...

css::uno::Reference< css::task::XInteractionHandler >	m_xHandler
	The outside interaction handler, which is used to handle every incoming interaction, if it's not blocked. More...

std::unique_ptr< WarningDialogsParentScope >	m_xWarningDialogsParent

std::vector< InteractionInfo >	m_lInteractionRules
	This list describe which and how incoming interactions must be handled. More...

Detailed Description

Prevent us from showing the same interaction more than once during the same transaction.

@descr Every interaction provided to this helper will be safed ... handled by the internal used UUIInteractionHandler (!) and never be handled a second time!

On the other side there exists some interactions, which allow a retry. So this helper allow to set a list of interactions combined with a retry value.

Definition at line 153 of file preventduplicateinteraction.hxx.

Constructor & Destructor Documentation

◆ PreventDuplicateInteraction()

sfx2::PreventDuplicateInteraction::PreventDuplicateInteraction ( css::uno::Reference< css::uno::XComponentContext > xContext )

ctor to guarantee right initialized instances of this class @descr It uses the given uno service manager to create the global generic UI interaction handler for later internal using.

Parameters

xSMGR uno service manager for creating services internally

@threadsafe not necessary

Definition at line 31 of file preventduplicateinteraction.cxx.

References m_xContext.

◆ ~PreventDuplicateInteraction()

sfx2::PreventDuplicateInteraction::~PreventDuplicateInteraction ( )

overridevirtual

dtor to free used memory.

Definition at line 36 of file preventduplicateinteraction.cxx.

Member Function Documentation

◆ addInteractionRule()

void sfx2::PreventDuplicateInteraction::addInteractionRule ( const PreventDuplicateInteraction::InteractionInfo & aInteractionInfo )

add a new interaction to the list of interactions, which must be handled by this helper.

@descr This method must be called immediately after a new instance of this helper was created. Without such list of InteractionRules, this instances does nothing! On the other side there is no possibility to remove rules. So the same instance can't be used within different transactions. It's a OneWay-object .-)

Parameters

aInteractionInfo describe the type of interaction, hos often it can be called etcpp.

@threadsafe yes

Definition at line 164 of file preventduplicateinteraction.cxx.

References m_aLock, m_lInteractionRules, sfx2::PreventDuplicateInteraction::InteractionInfo::m_nCallCount, and sfx2::PreventDuplicateInteraction::InteractionInfo::m_nMaxCount.

◆ getInteractionInfo()

bool sfx2::PreventDuplicateInteraction::getInteractionInfo	(	const css::uno::Type &	aInteraction,
		PreventDuplicateInteraction::InteractionInfo *	pReturn
	)		const

return the info struct for the specified interaction.

Parameters

aInteraction	specify the interaction.
pReturn	provides information about: the count how often this interaction was handled during the lifetime of this helper. the interaction itself, so it can be analyzed further

Returns: [boolean] true if the queried interaction could be found. false otherwise.

@threadsafe yes

Definition at line 183 of file preventduplicateinteraction.cxx.

References m_aLock, and m_lInteractionRules.

◆ handle()

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

overridevirtual

Definition at line 75 of file preventduplicateinteraction.cxx.

References m_aLock, m_lInteractionRules, sfx2::PreventDuplicateInteraction::InteractionInfo::m_nCallCount, sfx2::PreventDuplicateInteraction::InteractionInfo::m_nMaxCount, m_xHandler, and sfx2::PreventDuplicateInteraction::InteractionInfo::m_xRequest.

◆ handleInteractionRequest()

sal_Bool SAL_CALL sfx2::PreventDuplicateInteraction::handleInteractionRequest ( const css::uno::Reference< css::task::XInteractionRequest > & xRequest )

overridevirtual

Definition at line 118 of file preventduplicateinteraction.cxx.

References m_aLock, m_lInteractionRules, sfx2::PreventDuplicateInteraction::InteractionInfo::m_nCallCount, sfx2::PreventDuplicateInteraction::InteractionInfo::m_nMaxCount, m_xHandler, and sfx2::PreventDuplicateInteraction::InteractionInfo::m_xRequest.