forms/source/inc/controlfeatureinterception.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_FORMS_SOURCE_INC_CONTROLFEATUREINTERCEPTION_HXX
  21 #define INCLUDED_FORMS_SOURCE_INC_CONTROLFEATUREINTERCEPTION_HXX
  22
  23 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  24 #include <com/sun/star/frame/XDispatchProviderInterceptor.hpp>
  25 #include <com/sun/star/uno/XComponentContext.hpp>
  26
  27 #include <memory>
  28
  29
  30 namespace frm
  31 {
  32
  33
  34     class UrlTransformer;
  35
  36     //= ControlFeatureInterception
  37
  38     /** helper class for controls which allow some of their features to be intercepted
  39         by external instances
  40
  41         For using this class, instantiate it as member, derive yourself from
  42         <type scope="css::frame">XDispatchProviderInterception</type>, and forward all
  43         respective methods to this member.
  44
  45         Additionally, don't forget to call <member>dispose</member> when your class is disposed itself.
  46     */
  47     class ControlFeatureInterception
  48     {
  49     private:
  50         css::uno::Reference< css::frame::XDispatchProviderInterceptor >
  51                                               m_xFirstDispatchInterceptor;
  52         ::std::unique_ptr< UrlTransformer >   m_pUrlTransformer;
  53
  54     public:
  55         /** retrieves our URL transformer, so our clients may use it, too
  56         */
  57         const UrlTransformer& getTransformer() const { return *m_pUrlTransformer; }
  58
  59     public:
  60         ControlFeatureInterception( const css::uno::Reference< css::uno::XComponentContext >& _rxORB );
  61
  62         // XDispatchProviderInterception
  63         void SAL_CALL registerDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& Interceptor ) throw (css::uno::RuntimeException );
  64         void SAL_CALL releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& Interceptor ) throw (css::uno::RuntimeException );
  65
  66         // XComponent
  67         void SAL_CALL dispose();
  68
  69         /** queries the interceptor chain for the given dispatch
  70         */
  71         css::uno::Reference< css::frame::XDispatch >
  72             queryDispatch( const css::util::URL& _rURL, const OUString& _rTargetFrameName );
  73
  74         /** queries the interceptor chain for the given dispatch, with a blank target frame and no frame search flags
  75         */
  76         css::uno::Reference< css::frame::XDispatch >
  77             queryDispatch( const css::util::URL& _rURL );
  78
  79         /** queries the interceptor chain for the URL given as ASCII string,
  80             with a blank target frame and no frame search flags
  81         */
  82         css::uno::Reference< css::frame::XDispatch >
  83             queryDispatch( const sal_Char* _pAsciiURL );
  84     };
  85
  86
  87 } // namespace frm
  88
  89
  90 #endif // INCLUDED_FORMS_SOURCE_INC_CONTROLFEATUREINTERCEPTION_HXX
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */