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