LibreOffice Module framework (master) 1
mailtodispatcher.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#pragma once
21
22#include <com/sun/star/frame/XNotifyingDispatch.hpp>
23#include <com/sun/star/frame/XDispatch.hpp>
24#include <com/sun/star/frame/XDispatchProvider.hpp>
25#include <com/sun/star/lang/XServiceInfo.hpp>
26#include <com/sun/star/uno/XComponentContext.hpp>
27#include <com/sun/star/util/URL.hpp>
28#include <com/sun/star/beans/PropertyValue.hpp>
29#include <com/sun/star/frame/XStatusListener.hpp>
30
32
33namespace framework{
34
45class MailToDispatcher final : public ::cppu::WeakImplHelper<
46 css::lang::XServiceInfo,
47 css::frame::XDispatchProvider,
48 css::frame::XNotifyingDispatch> // => XDispatch
49{
50 /* member */
51 private:
52
54 css::uno::Reference< css::uno::XComponentContext > m_xContext;
55
56 /* interface */
57 public:
58
59 // ctor/dtor
60 MailToDispatcher( css::uno::Reference< css::uno::XComponentContext > xContext );
61 virtual ~MailToDispatcher( ) override;
62
63 /* interface XServiceInfo */
64 virtual OUString SAL_CALL getImplementationName() override;
65 virtual sal_Bool SAL_CALL supportsService( const OUString& sServiceName ) override;
66 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
67
68 // XDispatchProvider
69 virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch ( const css::util::URL& aURL ,
70 const OUString& sTarget ,
71 sal_Int32 nFlags ) override;
72 virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) override;
73
74 // XNotifyingDispatch
75 virtual void SAL_CALL dispatchWithNotification( const css::util::URL& aURL ,
76 const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
77 const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) override;
78
79 // XDispatch
80 virtual void SAL_CALL dispatch ( const css::util::URL& aURL ,
81 const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) override;
82 virtual void SAL_CALL addStatusListener ( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
83 const css::util::URL& aURL ) override;
84 virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
85 const css::util::URL& aURL ) override;
86
87 /* internal */
88 private:
90 bool implts_dispatch( const css::util::URL& aURL );
91
92}; // class MailToDispatcher
93
94} // namespace framework
95
96/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
protocol handler for "mailto:" URLs @descr It's a special dispatch object which is used registered fo...
MailToDispatcher(css::uno::Reference< css::uno::XComponentContext > xContext)
standard ctor @descr This initializes a new instance of this class with needed information for work.
virtual void SAL_CALL removeStatusListener(const css::uno::Reference< css::frame::XStatusListener > &xListener, const css::util::URL &aURL) override
virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch(const css::util::URL &aURL, const OUString &sTarget, sal_Int32 nFlags) override
decide if this dispatch implementation can be used for requested URL or not @descr A protocol handler...
bool implts_dispatch(const css::util::URL &aURL)
threadsafe helper for dispatch calls @descr We support two interfaces for the same process - dispatch...
virtual void SAL_CALL addStatusListener(const css::uno::Reference< css::frame::XStatusListener > &xListener, const css::util::URL &aURL) override
add/remove listener for state events @descr Because we use an external process to forward such mail U...
virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches(const css::uno::Sequence< css::frame::DispatchDescriptor > &lDescriptor) override
do the same like dispatch() but for multiple requests at the same time
css::uno::Reference< css::uno::XComponentContext > m_xContext
reference to global uno service manager which had created us
virtual void SAL_CALL dispatch(const css::util::URL &aURL, const css::uno::Sequence< css::beans::PropertyValue > &lArguments) override
dispatch URL with arguments @descr We use threadsafe internal method to do so.
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
dispatch with guaranteed notifications about success @descr We use threadsafe internal method to do s...
virtual ~MailToDispatcher() override
standard dtor
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
virtual sal_Bool SAL_CALL supportsService(const OUString &sServiceName) override
virtual OUString SAL_CALL getImplementationName() override
unsigned char sal_Bool