1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef __FRAMEWORK_UICONFIGURATION_UICONFIGMANAGER_HXX_ 29*cdf0e10cSrcweir #define __FRAMEWORK_UICONFIGURATION_UICONFIGMANAGER_HXX_ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir /** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble 33*cdf0e10cSrcweir with solaris headers ... 34*cdf0e10cSrcweir */ 35*cdf0e10cSrcweir #include <vector> 36*cdf0e10cSrcweir #include <list> 37*cdf0e10cSrcweir #include <hash_map> 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 40*cdf0e10cSrcweir // my own includes 41*cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 42*cdf0e10cSrcweir #include <threadhelp/threadhelpbase.hxx> 43*cdf0e10cSrcweir #include <macros/generic.hxx> 44*cdf0e10cSrcweir #include <macros/xinterface.hxx> 45*cdf0e10cSrcweir #include <macros/xtypeprovider.hxx> 46*cdf0e10cSrcweir #include <macros/xserviceinfo.hxx> 47*cdf0e10cSrcweir #include <stdtypes.h> 48*cdf0e10cSrcweir #include <uiconfiguration/imagemanager.hxx> 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 51*cdf0e10cSrcweir // interface includes 52*cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 53*cdf0e10cSrcweir #include <com/sun/star/lang/XServiceInfo.hpp> 54*cdf0e10cSrcweir #include <com/sun/star/lang/XTypeProvider.hpp> 55*cdf0e10cSrcweir #include <com/sun/star/lang/XComponent.hpp> 56*cdf0e10cSrcweir #include <com/sun/star/ui/XUIConfiguration.hpp> 57*cdf0e10cSrcweir #include <com/sun/star/ui/XUIConfigurationPersistence.hpp> 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir #ifndef _COM_SUN_STAR_UI_XUICONFIGURATIONSTORGAE_HPP_ 60*cdf0e10cSrcweir #include <com/sun/star/ui/XUIConfigurationStorage.hpp> 61*cdf0e10cSrcweir #endif 62*cdf0e10cSrcweir #include <com/sun/star/ui/XUIConfigurationManager.hpp> 63*cdf0e10cSrcweir #include <com/sun/star/ui/ConfigurationEvent.hpp> 64*cdf0e10cSrcweir #include <com/sun/star/ui/UIElementType.hpp> 65*cdf0e10cSrcweir #include <com/sun/star/container/XIndexContainer.hpp> 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 68*cdf0e10cSrcweir // other includes 69*cdf0e10cSrcweir //_________________________________________________________________________________________________________________ 70*cdf0e10cSrcweir #include <cppuhelper/weak.hxx> 71*cdf0e10cSrcweir #include <cppuhelper/interfacecontainer.hxx> 72*cdf0e10cSrcweir #include <rtl/ustring.hxx> 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir namespace framework 76*cdf0e10cSrcweir { 77*cdf0e10cSrcweir class UIConfigurationManager : public com::sun::star::lang::XTypeProvider , 78*cdf0e10cSrcweir public com::sun::star::lang::XServiceInfo , 79*cdf0e10cSrcweir public com::sun::star::lang::XComponent , 80*cdf0e10cSrcweir public ::com::sun::star::ui::XUIConfiguration , 81*cdf0e10cSrcweir public ::com::sun::star::ui::XUIConfigurationManager , 82*cdf0e10cSrcweir public ::com::sun::star::ui::XUIConfigurationPersistence , 83*cdf0e10cSrcweir public ::com::sun::star::ui::XUIConfigurationStorage , 84*cdf0e10cSrcweir private ThreadHelpBase , // Struct for right initalization of mutex member! Must be first of baseclasses. 85*cdf0e10cSrcweir public ::cppu::OWeakObject 86*cdf0e10cSrcweir { 87*cdf0e10cSrcweir public: 88*cdf0e10cSrcweir // XInterface, XTypeProvider, XServiceInfo 89*cdf0e10cSrcweir FWK_DECLARE_XINTERFACE 90*cdf0e10cSrcweir FWK_DECLARE_XTYPEPROVIDER 91*cdf0e10cSrcweir DECLARE_XSERVICEINFO 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir UIConfigurationManager( com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > xServiceManager ); 94*cdf0e10cSrcweir virtual ~UIConfigurationManager(); 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir // XComponent 97*cdf0e10cSrcweir virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException); 98*cdf0e10cSrcweir virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException); 99*cdf0e10cSrcweir virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException); 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir // XUIConfiguration 102*cdf0e10cSrcweir virtual void SAL_CALL addConfigurationListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationListener >& Listener ) throw (::com::sun::star::uno::RuntimeException); 103*cdf0e10cSrcweir virtual void SAL_CALL removeConfigurationListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationListener >& Listener ) throw (::com::sun::star::uno::RuntimeException); 104*cdf0e10cSrcweir 105*cdf0e10cSrcweir // XUIConfigurationManager 106*cdf0e10cSrcweir virtual void SAL_CALL reset() throw (::com::sun::star::uno::RuntimeException); 107*cdf0e10cSrcweir virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > SAL_CALL getUIElementsInfo( sal_Int16 ElementType ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 108*cdf0e10cSrcweir virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexContainer > SAL_CALL createSettings( ) throw (::com::sun::star::uno::RuntimeException); 109*cdf0e10cSrcweir virtual sal_Bool SAL_CALL hasSettings( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 110*cdf0e10cSrcweir virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess > SAL_CALL getSettings( const ::rtl::OUString& ResourceURL, sal_Bool bWriteable ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException); 111*cdf0e10cSrcweir virtual void SAL_CALL replaceSettings( const ::rtl::OUString& ResourceURL, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& aNewData ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException, ::com::sun::star::uno::RuntimeException); 112*cdf0e10cSrcweir virtual void SAL_CALL removeSettings( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException, ::com::sun::star::uno::RuntimeException); 113*cdf0e10cSrcweir virtual void SAL_CALL insertSettings( const ::rtl::OUString& NewResourceURL, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& aNewData ) throw (::com::sun::star::container::ElementExistException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException, ::com::sun::star::uno::RuntimeException); 114*cdf0e10cSrcweir virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getImageManager() throw (::com::sun::star::uno::RuntimeException); 115*cdf0e10cSrcweir virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getShortCutManager() throw (::com::sun::star::uno::RuntimeException); 116*cdf0e10cSrcweir virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getEventsManager() throw (::com::sun::star::uno::RuntimeException); 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir // XUIConfigurationPersistence 119*cdf0e10cSrcweir virtual void SAL_CALL reload() throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException); 120*cdf0e10cSrcweir virtual void SAL_CALL store() throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException); 121*cdf0e10cSrcweir virtual void SAL_CALL storeToStorage( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& Storage ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException); 122*cdf0e10cSrcweir virtual sal_Bool SAL_CALL isModified() throw (::com::sun::star::uno::RuntimeException); 123*cdf0e10cSrcweir virtual sal_Bool SAL_CALL isReadOnly() throw (::com::sun::star::uno::RuntimeException); 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir // XUIConfigurationStorage 126*cdf0e10cSrcweir virtual void SAL_CALL setStorage( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& Storage ) throw (::com::sun::star::uno::RuntimeException); 127*cdf0e10cSrcweir virtual sal_Bool SAL_CALL hasStorage() throw (::com::sun::star::uno::RuntimeException); 128*cdf0e10cSrcweir 129*cdf0e10cSrcweir private: 130*cdf0e10cSrcweir // private data types 131*cdf0e10cSrcweir enum NotifyOp 132*cdf0e10cSrcweir { 133*cdf0e10cSrcweir NotifyOp_Remove, 134*cdf0e10cSrcweir NotifyOp_Insert, 135*cdf0e10cSrcweir NotifyOp_Replace 136*cdf0e10cSrcweir }; 137*cdf0e10cSrcweir 138*cdf0e10cSrcweir struct UIElementInfo 139*cdf0e10cSrcweir { 140*cdf0e10cSrcweir UIElementInfo( const rtl::OUString& rResourceURL, const rtl::OUString& rUIName ) : 141*cdf0e10cSrcweir aResourceURL( rResourceURL), aUIName( rUIName ) {} 142*cdf0e10cSrcweir rtl::OUString aResourceURL; 143*cdf0e10cSrcweir rtl::OUString aUIName; 144*cdf0e10cSrcweir }; 145*cdf0e10cSrcweir 146*cdf0e10cSrcweir struct UIElementData 147*cdf0e10cSrcweir { 148*cdf0e10cSrcweir UIElementData() : bModified( false ), bDefault( true ) {}; 149*cdf0e10cSrcweir 150*cdf0e10cSrcweir rtl::OUString aResourceURL; 151*cdf0e10cSrcweir rtl::OUString aName; 152*cdf0e10cSrcweir bool bModified; // has been changed since last storing 153*cdf0e10cSrcweir bool bDefault; // default settings 154*cdf0e10cSrcweir com::sun::star::uno::Reference< com::sun::star::container::XIndexAccess > xSettings; 155*cdf0e10cSrcweir }; 156*cdf0e10cSrcweir 157*cdf0e10cSrcweir struct UIElementType; 158*cdf0e10cSrcweir friend struct UIElementType; 159*cdf0e10cSrcweir typedef ::std::hash_map< rtl::OUString, UIElementData, OUStringHashCode, ::std::equal_to< rtl::OUString > > UIElementDataHashMap; 160*cdf0e10cSrcweir 161*cdf0e10cSrcweir struct UIElementType 162*cdf0e10cSrcweir { 163*cdf0e10cSrcweir UIElementType() : bModified( false ), 164*cdf0e10cSrcweir bLoaded( false ), 165*cdf0e10cSrcweir bDefaultLayer( false ), 166*cdf0e10cSrcweir nElementType( ::com::sun::star::ui::UIElementType::UNKNOWN ) {} 167*cdf0e10cSrcweir 168*cdf0e10cSrcweir 169*cdf0e10cSrcweir bool bModified; 170*cdf0e10cSrcweir bool bLoaded; 171*cdf0e10cSrcweir bool bDefaultLayer; 172*cdf0e10cSrcweir sal_Int16 nElementType; 173*cdf0e10cSrcweir UIElementDataHashMap aElementsHashMap; 174*cdf0e10cSrcweir com::sun::star::uno::Reference< com::sun::star::embed::XStorage > xStorage; 175*cdf0e10cSrcweir }; 176*cdf0e10cSrcweir 177*cdf0e10cSrcweir typedef ::std::vector< UIElementType > UIElementTypesVector; 178*cdf0e10cSrcweir typedef ::std::vector< ::com::sun::star::ui::ConfigurationEvent > ConfigEventNotifyContainer; 179*cdf0e10cSrcweir typedef ::std::hash_map< rtl::OUString, UIElementInfo, OUStringHashCode, ::std::equal_to< rtl::OUString > > UIElementInfoHashMap; 180*cdf0e10cSrcweir 181*cdf0e10cSrcweir // private methods 182*cdf0e10cSrcweir void impl_Initialize(); 183*cdf0e10cSrcweir void implts_notifyContainerListener( const ::com::sun::star::ui::ConfigurationEvent& aEvent, NotifyOp eOp ); 184*cdf0e10cSrcweir void impl_fillSequenceWithElementTypeInfo( UIElementInfoHashMap& aUIElementInfoCollection, sal_Int16 nElementType ); 185*cdf0e10cSrcweir void impl_preloadUIElementTypeList( sal_Int16 nElementType ); 186*cdf0e10cSrcweir UIElementData* impl_findUIElementData( const rtl::OUString& aResourceURL, sal_Int16 nElementType, bool bLoad = true ); 187*cdf0e10cSrcweir void impl_requestUIElementData( sal_Int16 nElementType, UIElementData& aUIElementData ); 188*cdf0e10cSrcweir void impl_storeElementTypeData( com::sun::star::uno::Reference< com::sun::star::embed::XStorage >& xStorage, UIElementType& rElementType, bool bResetModifyState = true ); 189*cdf0e10cSrcweir void impl_resetElementTypeData( UIElementType& rDocElementType, ConfigEventNotifyContainer& rRemoveNotifyContainer ); 190*cdf0e10cSrcweir void impl_reloadElementTypeData( UIElementType& rDocElementType, ConfigEventNotifyContainer& rRemoveNotifyContainer, ConfigEventNotifyContainer& rReplaceNotifyContainer ); 191*cdf0e10cSrcweir 192*cdf0e10cSrcweir UIElementTypesVector m_aUIElements; 193*cdf0e10cSrcweir com::sun::star::uno::Reference< com::sun::star::embed::XStorage > m_xDocConfigStorage; 194*cdf0e10cSrcweir bool m_bReadOnly; 195*cdf0e10cSrcweir bool m_bInitialized; 196*cdf0e10cSrcweir bool m_bModified; 197*cdf0e10cSrcweir bool m_bConfigRead; 198*cdf0e10cSrcweir bool m_bDisposed; 199*cdf0e10cSrcweir rtl::OUString m_aXMLPostfix; 200*cdf0e10cSrcweir rtl::OUString m_aPropUIName; 201*cdf0e10cSrcweir rtl::OUString m_aPropResourceURL; 202*cdf0e10cSrcweir rtl::OUString m_aModuleIdentifier; 203*cdf0e10cSrcweir com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > m_xServiceManager; 204*cdf0e10cSrcweir ::cppu::OMultiTypeInterfaceContainerHelper m_aListenerContainer; /// container for ALL Listener 205*cdf0e10cSrcweir com::sun::star::uno::Reference< com::sun::star::lang::XComponent > m_xImageManager; 206*cdf0e10cSrcweir com::sun::star::uno::Reference< com::sun::star::uno::XInterface > m_xAccConfig; 207*cdf0e10cSrcweir }; 208*cdf0e10cSrcweir } 209*cdf0e10cSrcweir 210*cdf0e10cSrcweir #endif // __FRAMEWORK_UICONFIGURATION_UICONFIGMANAGER_HXX_ 211