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