framework/inc/dispatch/startmoduledispatcher.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_STARTMODULEDISPATCHER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_DISPATCH_STARTMODULEDISPATCHER_HXX
  22
  23 #include <macros/xinterface.hxx>
  24 #include <macros/xtypeprovider.hxx>
  25 #include <macros/generic.hxx>
  26 #include <stdtypes.h>
  27 #include <general.h>
  28
  29 #include <com/sun/star/lang/XTypeProvider.hpp>
  30 #include <com/sun/star/frame/XFrame.hpp>
  31 #include <com/sun/star/frame/XStatusListener.hpp>
  32 #include <com/sun/star/frame/XNotifyingDispatch.hpp>
  33 #include <com/sun/star/frame/XDispatchInformationProvider.hpp>
  34 #include <com/sun/star/util/URL.hpp>
  35 #include <com/sun/star/frame/XDispatchResultListener.hpp>
  36 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  37 #include <com/sun/star/uno/XComponentContext.hpp>
  38 #include <com/sun/star/frame/DispatchResultState.hpp>
  39
  40 #include <cppuhelper/implbase2.hxx>
  41 #include <vcl/evntpost.hxx>
  42
  43 namespace framework{
  44
  45 /**
  46     @short          helper to handle all URLs related to the StartModule
  47  */
  48 class StartModuleDispatcher : public  ::cppu::WeakImplHelper2<
  49                                          css::frame::XNotifyingDispatch,             // => XDispatch
  50                                          css::frame::XDispatchInformationProvider >
  51 {
  52
  53     // member
  54
  55     private:
  56
  57         /** @short reference to an uno service manager,
  58                    which can be used to create own needed
  59                    uno resources. */
  60         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  61
  62         /** @short  our "context" frame. */
  63         css::uno::WeakReference< css::frame::XFrame > m_xOwner;
  64
  65         /** @short  list of registered status listener */
  66         osl::Mutex m_mutex;
  67         ListenerHash m_lStatusListener;
  68
  69     // native interface
  70
  71     public:
  72
  73         /** @short  connect a new StartModuleDispatcher instance to its "owner frame".
  74
  75             @descr  Such "owner frame" is used as context for all related operations.
  76
  77             @param  xContext
  78                     an UNO service manager, which is needed to create UNO resource
  79                     internally.
  80
  81             @param  xFrame
  82                     the frame where the corresponding dispatch was started.
  83          */
  84         StartModuleDispatcher(const css::uno::Reference< css::uno::XComponentContext >&     rxContext,
  85                               const css::uno::Reference< css::frame::XFrame >&              xFrame);
  86
  87         /** @short  does nothing real. */
  88         virtual ~StartModuleDispatcher();
  89
  90     // uno interface
  91
  92     public:
  93
  94         // XNotifyingDispatch
  95         virtual void SAL_CALL dispatchWithNotification( const css::util::URL&                                             aURL      ,
  96                                                         const css::uno::Sequence< css::beans::PropertyValue >&            lArguments,
  97                                                         const css::uno::Reference< css::frame::XDispatchResultListener >& xListener ) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  98
  99         // XDispatch
 100         virtual void SAL_CALL dispatch            ( const css::util::URL&                                     aURL      ,
 101                                                     const css::uno::Sequence< css::beans::PropertyValue >&    lArguments) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 102         virtual void SAL_CALL addStatusListener   ( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
 103                                                     const css::util::URL&                                     aURL      ) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 104         virtual void SAL_CALL removeStatusListener( const css::uno::Reference< css::frame::XStatusListener >& xListener ,
 105                                                     const css::util::URL&                                     aURL      ) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 106
 107         // XDispatchInformationProvider
 108         virtual css::uno::Sequence< sal_Int16 >                       SAL_CALL getSupportedCommandGroups         (                         ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 109         virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( sal_Int16 nCommandGroup ) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 110
 111     // internal helper
 112
 113     private:
 114
 115         /** @short  check if StartModule can be shown.
 116          */
 117         bool implts_isBackingModePossible();
 118
 119         /** @short  open the special BackingComponent (now StartModule)
 120
 121             @return [bool]
 122                     sal_True if operation was successfully.
 123          */
 124         bool implts_establishBackingMode();
 125
 126         /** @short  notify a DispatchResultListener.
 127
 128             @descr  We check the listener reference before we use it.
 129                     So this method can be called every time!
 130
 131             @parama xListener
 132                     the listener, which should be notified.
 133                     Can be null!
 134
 135             @param  nState
 136                     directly used as css::frame::DispatchResultState value.
 137
 138             @param  aResult
 139                     not used yet really ...
 140          */
 141         void implts_notifyResultListener(const css::uno::Reference< css::frame::XDispatchResultListener >& xListener,
 142                                                sal_Int16                                                   nState   ,
 143                                          const css::uno::Any&                                              aResult  );
 144
 145 }; // class StartModuleDispatcher
 146
 147 } // namespace framework
 148
 149 #endif // INCLUDED_FRAMEWORK_INC_DISPATCH_STARTMODULEDISPATCHER_HXX
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */