framework::LoadDispatcher Class Reference

implements a dispatch object which can be used to load non-visible components (by using the mechanism of ContentHandler) or visible-components (by using the mechanism of FrameLoader). More...

#include <loaddispatcher.hxx>

Inheritance diagram for framework::LoadDispatcher:

Collaboration diagram for framework::LoadDispatcher:

Public Member Functions
	LoadDispatcher (const css::uno::Reference< css::uno::XComponentContext > &xContext, const css::uno::Reference< css::frame::XFrame > &xOwnerFrame, OUString sTargetName, sal_Int32 nSearchFlags)
	creates a new instance and initialize it with all necessary parameters. More...
virtual	~LoadDispatcher () override
	used to free internal resources. 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::Any SAL_CALL	dispatchWithReturnValue (const css::util::URL &aURL, const css::uno::Sequence< css::beans::PropertyValue > &lArguments) override

Private Member Functions
css::uno::Any	impl_dispatch (const css::util::URL &rURL, const css::uno::Sequence< css::beans::PropertyValue > &lArguments, const css::uno::Reference< css::frame::XDispatchResultListener > &xListener)

Private Attributes
osl::Mutex	m_mutex
css::uno::WeakReference< css::frame::XFrame >	m_xOwnerFrame
	TODO document me. More...
OUString	m_sTarget
	TODO document me. More...
sal_Int32	m_nSearchFlags
	TODO document me. More...
LoadEnv	m_aLoader
	TODO document me. More...

Detailed Description

implements a dispatch object which can be used to load non-visible components (by using the mechanism of ContentHandler) or visible-components (by using the mechanism of FrameLoader).

Definition at line 36 of file loaddispatcher.hxx.

Constructor & Destructor Documentation

LoadDispatcher()

framework::LoadDispatcher::LoadDispatcher	(	const css::uno::Reference< css::uno::XComponentContext > &	xContext,
		const css::uno::Reference< css::frame::XFrame > &	xOwnerFrame,
		OUString	sTargetName,
		sal_Int32	nSearchFlags
	)

creates a new instance and initialize it with all necessary parameters.

@descr Every instance of such LoadDispatcher can be used for the specified context only. That means: it can be used to load any further requested content into the here(!) specified target frame.

Parameters

xContext	will be used to create own needed services on demand.
xOwnerFrame	used as startpoint to locate the right target frame.
sTargetName	the name or the target frame for loading or a special qualifier which define such target.
nSearchFlags	used in case sTargetFrame isn't a special one.

Definition at line 29 of file loaddispatcher.cxx.

~LoadDispatcher()

framework::LoadDispatcher::~LoadDispatcher ( )

overridevirtual

used to free internal resources.

Definition at line 40 of file loaddispatcher.cxx.

Member Function Documentation

addStatusListener()

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

overridevirtual

Definition at line 63 of file loaddispatcher.cxx.

dispatch()

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

overridevirtual

Definition at line 51 of file loaddispatcher.cxx.

References aURL, and impl_dispatch().

dispatchWithNotification()

void SAL_CALL framework::LoadDispatcher::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 44 of file loaddispatcher.cxx.

References aURL, and impl_dispatch().

dispatchWithReturnValue()

css::uno::Any SAL_CALL framework::LoadDispatcher::dispatchWithReturnValue ( const css::util::URL &  aURL, const css::uno::Sequence< css::beans::PropertyValue > &  lArguments  )

overridevirtual

Definition at line 57 of file loaddispatcher.cxx.

References impl_dispatch().

impl_dispatch()

css::uno::Any framework::LoadDispatcher::impl_dispatch ( const css::util::URL &  rURL, const css::uno::Sequence< css::beans::PropertyValue > &  lArguments, const css::uno::Reference< css::frame::XDispatchResultListener > &  xListener  )

private

Definition at line 73 of file loaddispatcher.cxx.

References AllowContentHandler, framework::LoadEnv::getTargetComponent(), m_aLoader, framework::LoadEnvException::m_exOriginal, m_mutex, framework::LoadEnvException::m_nID, m_nSearchFlags, framework::LoadEnvException::m_sMessage, m_sTarget, m_xOwnerFrame, SAL_WARN, framework::LoadEnv::startLoading(), framework::LoadEnv::waitWhileLoading(), and WorkWithUI.

Referenced by dispatch(), dispatchWithNotification(), and dispatchWithReturnValue().

removeStatusListener()

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

overridevirtual

Definition at line 68 of file loaddispatcher.cxx.

Member Data Documentation

m_aLoader

LoadEnv framework::LoadDispatcher::m_aLoader

private

TODO document me.

Definition at line 55 of file loaddispatcher.hxx.

Referenced by impl_dispatch().

m_mutex

osl::Mutex framework::LoadDispatcher::m_mutex

private

Definition at line 43 of file loaddispatcher.hxx.

Referenced by impl_dispatch().

m_nSearchFlags

sal_Int32 framework::LoadDispatcher::m_nSearchFlags

private

TODO document me.

Definition at line 52 of file loaddispatcher.hxx.

Referenced by impl_dispatch().

m_sTarget

OUString framework::LoadDispatcher::m_sTarget

private

TODO document me.

Definition at line 49 of file loaddispatcher.hxx.

Referenced by impl_dispatch().

m_xOwnerFrame

css::uno::WeakReference< css::frame::XFrame > framework::LoadDispatcher::m_xOwnerFrame

private

TODO document me.

Definition at line 46 of file loaddispatcher.hxx.

Referenced by impl_dispatch().

---

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

• loaddispatcher.hxx
• loaddispatcher.cxx