framework/inc/dispatch/servicehandler.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_SERVICEHANDLER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_DISPATCH_SERVICEHANDLER_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 "service:*" URLs
  44     @descr          It's a special dispatch/provider object which is registered for such URL pattern and will
  45                     be automatically used by the framework dispatch mechanism if such URL occurred.
  46                     His job is to create any registered uno components which must be coded inside
  47                     dispatched URL (may with some optional given parameters). After that such created
  48                     service must be hold his self alive. Such mechanism can be useful for UI components
  49                     (e.g. Dialogs, Wizards) only.
  50
  51     @base           OWeakObject
  52                         provides XWeak and ref count mechanism
  53
  54     @devstatus      ready to use
  55 */
  56 class ServiceHandler : public  ::cppu::WeakImplHelper3<
  57                                    css::lang::XServiceInfo       ,
  58                                    css::frame::XDispatchProvider ,
  59                                    css::frame::XNotifyingDispatch > // => XDispatch
  60 {
  61     /* member */
  62     private:
  63
  64         /// reference to global uno service manager which had created us
  65         css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory;
  66
  67     /* interface */
  68     public:
  69
  70         // ctor/dtor
  71                  ServiceHandler( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
  72         virtual ~ServiceHandler(                                                                        );
  73
  74         // XInterface, XTypeProvider, XServiceInfo
  75         DECLARE_XSERVICEINFO
  76
  77         // XDispatchProvider
  78         virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL                       queryDispatch  ( const css::util::URL&                                       aURL        ,
  79                                                                                                              const OUString&                                      sTarget     ,
  80                                                                                                                    sal_Int32                                             nFlags      ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  81         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;
  82
  83         // XNotifyingDispatch
  84         virtual void SAL_CALL dispatchWithNotification( const css::util::URL&                                             aURL      ,
  85                                                         const css::uno::Sequence< css::beans::PropertyValue >&            lArguments,
  86                                                         const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  87
  88         // XDispatch
  89         virtual void SAL_CALL dispatch            ( const css::util::URL&                                     aURL       ,
  90                                                     const css::uno::Sequence< css::beans::PropertyValue >&    lArguments ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  91         virtual void SAL_CALL addStatusListener   ( const css::uno::Reference< css::frame::XStatusListener >& xListener  ,
  92                                                     const css::util::URL&                                     aURL       ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  93         virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener  ,
  94                                                     const css::util::URL&                                     aURL       ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  95
  96     /* internal */
  97     private:
  98
  99         css::uno::Reference< css::uno::XInterface > implts_dispatch( const css::util::URL&                                  aURL       ,
 100                                                                      const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException );
 101
 102 };      //  class ServiceHandler
 103
 104 }       //  namespace framework
 105
 106 #endif // INCLUDED_FRAMEWORK_INC_DISPATCH_SERVICEHANDLER_HXX
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */