LibreOffice Module framework (master) 1
Public Member Functions | Private Attributes | List of all members
framework::DispatchRecorderSupplier Class Referencefinal

implement a supplier for dispatch recorder @descr This supplier can be set on property "DispatchRecorderSupplier" on a frame. More...

#include <dispatchrecordersupplier.hxx>

Inheritance diagram for framework::DispatchRecorderSupplier:
[legend]
Collaboration diagram for framework::DispatchRecorderSupplier:
[legend]

Public Member Functions

virtual OUString SAL_CALL getImplementationName () override
 
virtual sal_Bool SAL_CALL supportsService (const OUString &sServiceName) override
 
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames () override
 
virtual void SAL_CALL setDispatchRecorder (const css::uno::Reference< css::frame::XDispatchRecorder > &xRecorder) override
 set a new dispatch recorder on this supplier @descr Because there can exist more than one recorder implementations (to generate java/basic/... scripts from recorded data) it must be possible to set it on a supplier. More...
 
virtual css::uno::Reference< css::frame::XDispatchRecorder > SAL_CALL getDispatchRecorder () override
 provides access to the dispatch recorder of this supplier @descr Such recorder can be used outside to record dispatches. More...
 
virtual void SAL_CALL dispatchAndRecord (const css::util::URL &aURL, const css::uno::Sequence< css::beans::PropertyValue > &lArguments, const css::uno::Reference< css::frame::XDispatch > &xDispatcher) override
 execute a dispatch request and record it @descr If given dispatch object provides right recording interface it will be used. More...
 
 DispatchRecorderSupplier ()
 
virtual ~DispatchRecorderSupplier () override
 standard destructor @descr We are a helper and not a real service. More...
 

Private Attributes

css::uno::Reference< css::frame::XDispatchRecorder > m_xDispatchRecorder
 provided dispatch recorder of this supplier instance More...
 

Detailed Description

implement a supplier for dispatch recorder @descr This supplier can be set on property "DispatchRecorderSupplier" on a frame.

By using of this supplier and his internal XDispatchRecorder it's possible to record XDispatch::dispatch() requests.

@threadsafe yes

Definition at line 38 of file dispatchrecordersupplier.hxx.

Constructor & Destructor Documentation

◆ DispatchRecorderSupplier()

framework::DispatchRecorderSupplier::DispatchRecorderSupplier ( )

Definition at line 47 of file dispatchrecordersupplier.cxx.

◆ ~DispatchRecorderSupplier()

framework::DispatchRecorderSupplier::~DispatchRecorderSupplier ( )
overridevirtual

standard destructor @descr We are a helper and not a real service.

So we don't provide dispose() functionality. This supplier dies by ref count mechanism and should release all internal used ones too.

Definition at line 57 of file dispatchrecordersupplier.cxx.

References m_xDispatchRecorder.

Member Function Documentation

◆ dispatchAndRecord()

void SAL_CALL framework::DispatchRecorderSupplier::dispatchAndRecord ( const css::util::URL &  aURL,
const css::uno::Sequence< css::beans::PropertyValue > &  lArguments,
const css::uno::Reference< css::frame::XDispatch > &  xDispatcher 
)
overridevirtual

execute a dispatch request and record it @descr If given dispatch object provides right recording interface it will be used.

If it's not supported it record the pure dispatch parameters only. There is no code neither the possibility to check if recording is enabled or not.

Parameters
aURLthe command URL
lArgumentsoptional arguments (see com.sun.star.document.MediaDescriptor for further information)
xDispatcherthe original dispatch object which should be recorded

@change 09.04.2002 by Andreas Schluens

Definition at line 118 of file dispatchrecordersupplier.cxx.

References aURL, and m_xDispatchRecorder.

◆ getDispatchRecorder()

css::uno::Reference< css::frame::XDispatchRecorder > SAL_CALL framework::DispatchRecorderSupplier::getDispatchRecorder ( )
overridevirtual

provides access to the dispatch recorder of this supplier @descr Such recorder can be used outside to record dispatches.

But normally he is used internally only. Of course he must used from outside to get the recorded data e.g. for saving it as a script.

See also
setDispatchRecorder()
Returns
the internal used dispatch recorder
May it can be <NULL> if no one was set before.

@change 09.04.2002 by Andreas Schluens

Definition at line 99 of file dispatchrecordersupplier.cxx.

References m_xDispatchRecorder.

◆ getImplementationName()

OUString SAL_CALL framework::DispatchRecorderSupplier::getImplementationName ( )
overridevirtual

Definition at line 31 of file dispatchrecordersupplier.cxx.

◆ getSupportedServiceNames()

css::uno::Sequence< OUString > SAL_CALL framework::DispatchRecorderSupplier::getSupportedServiceNames ( )
overridevirtual

Definition at line 41 of file dispatchrecordersupplier.cxx.

◆ setDispatchRecorder()

void SAL_CALL framework::DispatchRecorderSupplier::setDispatchRecorder ( const css::uno::Reference< css::frame::XDispatchRecorder > &  xRecorder)
overridevirtual

set a new dispatch recorder on this supplier @descr Because there can exist more than one recorder implementations (to generate java/basic/... scripts from recorded data) it must be possible to set it on a supplier.

See also
getDispatchRecorder()
Parameters
xRecorderthe new recorder to set it
<NULL> isn't recommended, because recording without a valid recorder can't work. But it's not checked here. So user of this supplier can decide that without changing this implementation.

@change 09.04.2002 by Andreas Schluens

Definition at line 79 of file dispatchrecordersupplier.cxx.

References m_xDispatchRecorder.

◆ supportsService()

sal_Bool SAL_CALL framework::DispatchRecorderSupplier::supportsService ( const OUString &  sServiceName)
overridevirtual

Definition at line 36 of file dispatchrecordersupplier.cxx.

References sServiceName, and cppu::supportsService().

Member Data Documentation

◆ m_xDispatchRecorder

css::uno::Reference< css::frame::XDispatchRecorder > framework::DispatchRecorderSupplier::m_xDispatchRecorder
private

provided dispatch recorder of this supplier instance

@life Is controlled from outside. Because this variable is set from there and not created internally. But we release our reference to it if we die.

Definition at line 53 of file dispatchrecordersupplier.hxx.

Referenced by dispatchAndRecord(), getDispatchRecorder(), setDispatchRecorder(), and ~DispatchRecorderSupplier().


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