framework/inc/dispatch/mailtodispatcher.hxx

   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 #ifndef INCLUDED_FRAMEWORK_INC_DISPATCH_MAILTODISPATCHER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_DISPATCH_MAILTODISPATCHER_HXX
  22
  23 #include <macros/generic.hxx>
  24 #include <macros/xinterface.hxx>
  25 #include <macros/xtypeprovider.hxx>
  26 #include <macros/xserviceinfo.hxx>
  27 #include <general.h>
  28 #include <stdtypes.h>
  29
  30 #include <com/sun/star/lang/XTypeProvider.hpp>
  31 #include <com/sun/star/frame/XNotifyingDispatch.hpp>
  32 #include <com/sun/star/frame/XDispatch.hpp>
  33 #include <com/sun/star/frame/XDispatchProvider.hpp>
  34 #include <com/sun/star/util/URL.hpp>
  35 #include <com/sun/star/beans/PropertyValue.hpp>
  36 #include <com/sun/star/frame/XStatusListener.hpp>
  37
  38 #include <cppuhelper/implbase3.hxx>
  39
  40 namespace framework{
  41
  42 /**
  43     @short          protocol handler for "mailto:" URLs
  44     @descr          It's a special dispatch object which is used registered for "mailto:*" URLs and
  45                     will be automatically used from the framework dispatch mechanism if such URL occurred.
  46
  47     @base           OWeakObject
  48                         provides XWeak and ref count mechanism
  49
  50     @devstatus      ready to use
  51 */
  52 class MailToDispatcher : public  ::cppu::WeakImplHelper3<
  53                                      css::lang::XServiceInfo,
  54                                      css::frame::XDispatchProvider,
  55                                      css::frame::XNotifyingDispatch> // => XDispatch
  56 {
  57     /* member */
  58     private:
  59
  60         /// reference to global uno service manager which had created us
  61         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  62
  63     /* interface */
  64     public:
  65
  66         // ctor/dtor
  67                  MailToDispatcher( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  68         virtual ~MailToDispatcher(                                                                     );
  69
  70         // XInterface, XTypeProvider, XServiceInfo
  71         DECLARE_XSERVICEINFO
  72
  73         // XDispatchProvider
  74         virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL                       queryDispatch  ( const css::util::URL&                                       aURL        ,
  75                                                                                                              const OUString&                                      sTarget     ,
  76                                                                                                                    sal_Int32                                             nFlags      ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  77         virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  78
  79         // XNotifyingDispatch
  80         virtual void SAL_CALL dispatchWithNotification( const css::util::URL&                                             aURL      ,
  81                                                         const css::uno::Sequence< css::beans::PropertyValue >&            lArguments,
  82                                                         const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  83
  84         // XDispatch
  85         virtual void SAL_CALL dispatch            ( const css::util::URL&                                     aURL       ,
  86                                                     const css::uno::Sequence< css::beans::PropertyValue >&    lArguments ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  87         virtual void SAL_CALL addStatusListener   ( const css::uno::Reference< css::frame::XStatusListener >& xListener  ,
  88                                                     const css::util::URL&                                     aURL       ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  89         virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener  ,
  90                                                     const css::util::URL&                                     aURL       ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  91
  92     /* internal */
  93     private:
  94
  95         bool implts_dispatch( const css::util::URL&                                  aURL       ,
  96                                   const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException );
  97
  98 };      //  class MailToDispatcher
  99
 100 }       //  namespace framework
 101
 102 #endif // INCLUDED_FRAMEWORK_INC_DISPATCH_MAILTODISPATCHER_HXX
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */