framework/inc/recording/dispatchrecordersupplier.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 #pragma once
  21
  22 #include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
  23 #include <com/sun/star/util/URL.hpp>
  24 #include <com/sun/star/beans/PropertyValue.hpp>
  25 #include <com/sun/star/lang/XServiceInfo.hpp>
  26
  27 #include <cppuhelper/implbase.hxx>
  28
  29 namespace framework{
  30
  31 /** @short          implement a supplier for dispatch recorder
  32     @descr          This supplier can be set on property "DispatchRecorderSupplier" on a frame.
  33                     By using of this supplier and his internal XDispatchRecorder it's possible to
  34                     record XDispatch::dispatch() requests.
  35
  36     @threadsafe     yes
  37  */
  38 class DispatchRecorderSupplier final : public  ::cppu::WeakImplHelper<
  39                                                 css::lang::XServiceInfo             ,
  40                                                 css::frame::XDispatchRecorderSupplier >
  41 {
  42
  43     // member
  44
  45     private:
  46
  47         /** provided dispatch recorder of this supplier instance
  48
  49             @life   Is controlled from outside. Because this variable is set
  50                     from there and not created internally. But we release our
  51                     reference to it if we die.
  52          */
  53         css::uno::Reference< css::frame::XDispatchRecorder > m_xDispatchRecorder;
  54
  55     // uno interface
  56
  57     public:
  58
  59         /* interface XServiceInfo */
  60         virtual OUString SAL_CALL getImplementationName() override;
  61         virtual sal_Bool SAL_CALL supportsService( const OUString& sServiceName ) override;
  62         virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
  63
  64         // XDispatchRecorderSupplier
  65
  66         virtual void                                                 SAL_CALL setDispatchRecorder( const css::uno::Reference< css::frame::XDispatchRecorder >& xRecorder   ) override;
  67         virtual css::uno::Reference< css::frame::XDispatchRecorder > SAL_CALL getDispatchRecorder(                                                                         ) override;
  68         virtual void                                                 SAL_CALL dispatchAndRecord  ( const css::util::URL&                                       aURL        ,
  69                                                                                                    const css::uno::Sequence< css::beans::PropertyValue >&      lArguments  ,
  70                                                                                                    const css::uno::Reference< css::frame::XDispatch >&         xDispatcher ) override;
  71
  72     // native interface
  73
  74     public:
  75
  76         DispatchRecorderSupplier();
  77         virtual ~DispatchRecorderSupplier() override;
  78
  79 };      //  class DispatchRecorderSupplier
  80
  81 }       //  namespace framework
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */