framework/inc/uielement/menubarwrapper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: menubarwrapper.hxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_UIELEMENT_MENUBARWRAPPER_HXX_
  32 #define __FRAMEWORK_UIELEMENT_MENUBARWRAPPER_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <helper/uiconfigelementwrapperbase.hxx>
  39 #include <uielement/menubarmanager.hxx>
  40
  41 //_________________________________________________________________________________________________________________
  42 //      interface includes
  43 //_________________________________________________________________________________________________________________
  44 #include <com/sun/star/frame/XFrame.hpp>
  45 #include <com/sun/star/frame/XDispatchProvider.hpp>
  46 #include <com/sun/star/lang/XComponent.hpp>
  47 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  48 #ifndef __COM_SUN_STAR_CONTAINER_XNAMEACCESS_HPP_
  49 #include <com/sun/star/container/XNameAccess.hpp>
  50 #endif
  51
  52 //_________________________________________________________________________________________________________________
  53 //      other includes
  54 //_________________________________________________________________________________________________________________
  55
  56 #include <hash_map>
  57
  58 namespace framework
  59 {
  60
  61 class MenuBarWrapper : public UIConfigElementWrapperBase,
  62                        public ::com::sun::star::container::XNameAccess
  63
  64 {
  65     public:
  66         // #110897#
  67         MenuBarWrapper(
  68             const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& xServiceManager );
  69         virtual ~MenuBarWrapper();
  70
  71         //---------------------------------------------------------------------------------------------------------
  72         //      XInterface, XTypeProvider
  73         //---------------------------------------------------------------------------------------------------------
  74         FWK_DECLARE_XINTERFACE
  75         FWK_DECLARE_XTYPEPROVIDER
  76
  77         MenuBarManager* GetMenuBarManager() const { return static_cast< MenuBarManager* >( m_xMenuBarManager.get() ); }
  78         void            InvalidatePopupControllerCache() { m_bRefreshPopupControllerCache = sal_True; }
  79
  80         // XComponent
  81         virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException);
  82
  83         // XInitialization
  84         virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
  85
  86         // XUIElement
  87         virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getRealInterface() throw (::com::sun::star::uno::RuntimeException);
  88
  89         // XUIElementSettings
  90         virtual void SAL_CALL updateSettings(  ) throw (::com::sun::star::uno::RuntimeException);
  91
  92         // XElementAccess
  93         virtual ::com::sun::star::uno::Type SAL_CALL getElementType() throw (::com::sun::star::uno::RuntimeException);
  94         virtual ::sal_Bool SAL_CALL hasElements() throw (::com::sun::star::uno::RuntimeException);
  95
  96         // XNameAccess
  97         virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
  98         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames() throw (::com::sun::star::uno::RuntimeException);
  99         virtual ::sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
 100
 101     private:
 102         virtual void impl_fillNewData();
 103         void fillPopupControllerCache();
 104
 105         sal_Bool                                                                                m_bRefreshPopupControllerCache : 1;
 106         com::sun::star::uno::Reference< com::sun::star::lang::XComponent >                      m_xMenuBarManager;
 107         PopupControllerCache                                                                    m_aPopupControllerCache;
 108 };
 109
 110 } // namespace framework
 111
 112 #endif // __FRAMEWORK_UIELEMENT_MENUBARWRAPPER_HXX_