framework/inc/dispatch/dispatchinformationprovider.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_DISPATCHINFORMATIONPROVIDER_HXX
  21 #define INCLUDED_FRAMEWORK_INC_DISPATCH_DISPATCHINFORMATIONPROVIDER_HXX
  22
  23 #include <macros/generic.hxx>
  24 #include <macros/xinterface.hxx>
  25 #include <general.h>
  26
  27 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  28 #include <com/sun/star/frame/XFrame.hpp>
  29 #include <com/sun/star/frame/XDispatchInformationProvider.hpp>
  30
  31 #include <cppuhelper/weakref.hxx>
  32 #include <rtl/ustring.hxx>
  33 #include <cppuhelper/implbase1.hxx>
  34 #include <vcl/svapp.hxx>
  35
  36 namespace framework{
  37
  38 /*-************************************************************************************************************
  39     @short          a helper to merge dispatch information of different sources together.
  40 *//*-*************************************************************************************************************/
  41 class DispatchInformationProvider : public  ::cppu::WeakImplHelper1< css::frame::XDispatchInformationProvider >
  42 {
  43
  44     // member
  45     private:
  46
  47         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  48         css::uno::WeakReference< css::frame::XFrame > m_xFrame;
  49
  50     // interface
  51     public:
  52
  53         DispatchInformationProvider(const css::uno::Reference< css::uno::XComponentContext >& xContext ,
  54                                     const css::uno::Reference< css::frame::XFrame >&          xFrame);
  55
  56         virtual ~DispatchInformationProvider();
  57
  58         virtual css::uno::Sequence< sal_Int16 > SAL_CALL getSupportedCommandGroups()
  59             throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  60
  61         virtual css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation(sal_Int16 nCommandGroup)
  62             throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  63
  64     // helper
  65     private:
  66
  67         css::uno::Sequence< css::uno::Reference< css::frame::XDispatchInformationProvider > > implts_getAllSubProvider();
  68
  69 }; // class DispatchInformationProvider
  70
  71 } // namespace framework
  72
  73 #endif // INCLUDED_FRAMEWORK_INC_DISPATCH_DISPATCHINFORMATIONPROVIDER_HXX
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */