helper to handle all URLs related to the StartModule More...

#include <startmoduledispatcher.hxx>

Inheritance diagram for framework::StartModuleDispatcher:

Collaboration diagram for framework::StartModuleDispatcher:

Public Member Functions
	StartModuleDispatcher (css::uno::Reference< css::uno::XComponentContext > xContext)
	connect a new StartModuleDispatcher instance to its "owner frame". More...

virtual	~StartModuleDispatcher () override
	does nothing real. More...

virtual void SAL_CALL	dispatchWithNotification (const css::util::URL &aURL, const css::uno::Sequence< css::beans::PropertyValue > &lArguments, const css::uno::Reference< css::frame::XDispatchResultListener > &xListener) override

virtual void SAL_CALL	dispatch (const css::util::URL &aURL, const css::uno::Sequence< css::beans::PropertyValue > &lArguments) override

virtual void SAL_CALL	addStatusListener (const css::uno::Reference< css::frame::XStatusListener > &xListener, const css::util::URL &aURL) override

virtual void SAL_CALL	removeStatusListener (const css::uno::Reference< css::frame::XStatusListener > &xListener, const css::util::URL &aURL) override

virtual css::uno::Sequence< sal_Int16 > SAL_CALL	getSupportedCommandGroups () override

virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL	getConfigurableDispatchInformation (sal_Int16 nCommandGroup) override

Private Member Functions
bool	implts_isBackingModePossible ()
	check if StartModule can be shown. More...

void	implts_establishBackingMode ()
	open the special BackingComponent (now StartModule) More...

void	implts_notifyResultListener (const css::uno::Reference< css::frame::XDispatchResultListener > &xListener, sal_Int16 nState, const css::uno::Any &aResult)
	notify a DispatchResultListener. More...

Private Attributes
css::uno::Reference< css::uno::XComponentContext >	m_xContext
	reference to a uno service manager, which can be used to create own needed uno resources. More...

Detailed Description

helper to handle all URLs related to the StartModule

Definition at line 36 of file startmoduledispatcher.hxx.

Constructor & Destructor Documentation

◆ StartModuleDispatcher()

framework::StartModuleDispatcher::StartModuleDispatcher ( css::uno::Reference< css::uno::XComponentContext > xContext )

connect a new StartModuleDispatcher instance to its "owner frame".

@descr Such "owner frame" is used as context for all related operations.

Parameters

xContext	a UNO service manager, which is needed to create UNO resource internally.
xFrame	the frame where the corresponding dispatch was started.

Definition at line 40 of file startmoduledispatcher.cxx.

◆ ~StartModuleDispatcher()

framework::StartModuleDispatcher::~StartModuleDispatcher ( )

overridevirtual

does nothing real.

Definition at line 45 of file startmoduledispatcher.cxx.

Member Function Documentation

◆ addStatusListener()

void SAL_CALL framework::StartModuleDispatcher::addStatusListener	(	const css::uno::Reference< css::frame::XStatusListener > &	xListener,
		const css::util::URL &	aURL
	)

overridevirtual

Definition at line 83 of file startmoduledispatcher.cxx.

◆ dispatch()

void SAL_CALL framework::StartModuleDispatcher::dispatch	(	const css::util::URL &	aURL,
		const css::uno::Sequence< css::beans::PropertyValue > &	lArguments
	)

overridevirtual

Definition at line 49 of file startmoduledispatcher.cxx.

References aURL, and dispatchWithNotification().

◆ dispatchWithNotification()

void SAL_CALL framework::StartModuleDispatcher::dispatchWithNotification	(	const css::util::URL &	aURL,
		const css::uno::Sequence< css::beans::PropertyValue > &	lArguments,
		const css::uno::Reference< css::frame::XDispatchResultListener > &	xListener
	)

overridevirtual

Definition at line 55 of file startmoduledispatcher.cxx.

References aURL, implts_establishBackingMode(), implts_isBackingModePossible(), implts_notifyResultListener(), and framework::isStartModuleDispatch().

Referenced by dispatch().

◆ getConfigurableDispatchInformation()

css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL framework::StartModuleDispatcher::getConfigurableDispatchInformation ( sal_Int16 nCommandGroup )

overridevirtual

Definition at line 78 of file startmoduledispatcher.cxx.

◆ getSupportedCommandGroups()

css::uno::Sequence<::sal_Int16 > SAL_CALL framework::StartModuleDispatcher::getSupportedCommandGroups ( )

overridevirtual

Definition at line 73 of file startmoduledispatcher.cxx.

◆ implts_establishBackingMode()

void framework::StartModuleDispatcher::implts_establishBackingMode ( )

private

open the special BackingComponent (now StartModule)

Definition at line 117 of file startmoduledispatcher.cxx.

References m_xContext, framework::SPECIALTARGET_BLANK, and xFrame.

Referenced by dispatchWithNotification().

◆ implts_isBackingModePossible()

bool framework::StartModuleDispatcher::implts_isBackingModePossible ( )

private

check if StartModule can be shown.

Definition at line 93 of file startmoduledispatcher.cxx.

References BackingComponent, Help, m_xContext, and SvtModuleOptions::STARTMODULE.

Referenced by dispatchWithNotification().

◆ implts_notifyResultListener()

void framework::StartModuleDispatcher::implts_notifyResultListener	(	const css::uno::Reference< css::frame::XDispatchResultListener > &	xListener,
		sal_Int16	nState,
		const css::uno::Any &	aResult
	)

private

notify a DispatchResultListener.

@descr We check the listener reference before we use it. So this method can be called every time!

@parama xListener the listener, which should be notified. Can be null!

Parameters

nState	directly used as css::frame::DispatchResultState value.
aResult	not used yet really ...

Definition at line 130 of file startmoduledispatcher.cxx.

References aEvent, and nState.

Referenced by dispatchWithNotification().

◆ removeStatusListener()

void SAL_CALL framework::StartModuleDispatcher::removeStatusListener	(	const css::uno::Reference< css::frame::XStatusListener > &	xListener,
		const css::util::URL &	aURL
	)

overridevirtual

Definition at line 88 of file startmoduledispatcher.cxx.

Member Data Documentation

◆ m_xContext

css::uno::Reference< css::uno::XComponentContext > framework::StartModuleDispatcher::m_xContext

private

reference to a uno service manager, which can be used to create own needed uno resources.

Definition at line 48 of file startmoduledispatcher.hxx.

Referenced by implts_establishBackingMode(), and implts_isBackingModePossible().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StartModuleDispatcher()

◆ ~StartModuleDispatcher()

Member Function Documentation

◆ addStatusListener()

◆ dispatch()

◆ dispatchWithNotification()

◆ getConfigurableDispatchInformation()

◆ getSupportedCommandGroups()

◆ implts_establishBackingMode()

◆ implts_isBackingModePossible()

◆ implts_notifyResultListener()

◆ removeStatusListener()

Member Data Documentation

◆ m_xContext