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

protocol handler for "systemexec:*" URLs @descr It's a special dispatch/provider object which is registered for such URL pattern and will be automatically used by the framework dispatch mechanism if such URL occurred. More...

#include <systemexec.hxx>

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

Public Member Functions

 SystemExec (css::uno::Reference< css::uno::XComponentContext > xContext)
 
virtual ~SystemExec () override
 
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 css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch (const css::util::URL &aURL, const OUString &sTarget, sal_Int32 nFlags) override
 
virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches (const css::uno::Sequence< css::frame::DispatchDescriptor > &lDescriptor) override
 
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
 

Private Member Functions

void impl_notifyResultListener (const css::uno::Reference< css::frame::XDispatchResultListener > &xListener, const sal_Int16 nState)
 

Private Attributes

css::uno::Reference< css::uno::XComponentContext > m_xContext
 reference to global uno service manager which had created us More...
 

Detailed Description

protocol handler for "systemexec:*" URLs @descr It's a special dispatch/provider object which is registered for such URL pattern and will be automatically used by the framework dispatch mechanism if such URL occurred.

It forwards all URL's to the underlying operating system. So it would e.g. be possible to open HTML files outside the office within a web browser.

@base OWeakObject provides XWeak and ref count mechanism

@devstatus ready to use

Definition at line 47 of file systemexec.hxx.

Constructor & Destructor Documentation

◆ SystemExec()

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

Definition at line 52 of file systemexec.cxx.

◆ ~SystemExec()

framework::SystemExec::~SystemExec ( )
overridevirtual

Definition at line 57 of file systemexec.cxx.

Member Function Documentation

◆ addStatusListener()

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

Definition at line 124 of file systemexec.cxx.

◆ dispatch()

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

Definition at line 86 of file systemexec.cxx.

References aURL, and dispatchWithNotification().

◆ dispatchWithNotification()

void SAL_CALL framework::SystemExec::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 92 of file systemexec.cxx.

References aURL, impl_notifyResultListener(), m_xContext, and framework::PROTOCOL_VALUE.

Referenced by dispatch().

◆ getImplementationName()

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

Definition at line 37 of file systemexec.cxx.

◆ getSupportedServiceNames()

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

Definition at line 47 of file systemexec.cxx.

References framework::SERVICENAME_PROTOCOLHANDLER.

◆ impl_notifyResultListener()

void framework::SystemExec::impl_notifyResultListener ( const css::uno::Reference< css::frame::XDispatchResultListener > &  xListener,
const sal_Int16  nState 
)
private

Definition at line 136 of file systemexec.cxx.

References aEvent, and nState.

Referenced by dispatchWithNotification().

◆ queryDispatch()

css::uno::Reference< css::frame::XDispatch > SAL_CALL framework::SystemExec::queryDispatch ( const css::util::URL &  aURL,
const OUString &  sTarget,
sal_Int32  nFlags 
)
overridevirtual

Definition at line 61 of file systemexec.cxx.

References aURL, and framework::PROTOCOL_VALUE.

Referenced by queryDispatches().

◆ queryDispatches()

css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL framework::SystemExec::queryDispatches ( const css::uno::Sequence< css::frame::DispatchDescriptor > &  lDescriptor)
overridevirtual

Definition at line 71 of file systemexec.cxx.

References i, nCount, and queryDispatch().

◆ removeStatusListener()

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

Definition at line 130 of file systemexec.cxx.

◆ supportsService()

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

Definition at line 42 of file systemexec.cxx.

References sServiceName, and cppu::supportsService().

Member Data Documentation

◆ m_xContext

css::uno::Reference< css::uno::XComponentContext > framework::SystemExec::m_xContext
private

reference to global uno service manager which had created us

Definition at line 56 of file systemexec.hxx.

Referenced by dispatchWithNotification().


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