framework/inc/uiconfiguration/uiconfigurationmanager.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: uiconfigurationmanager.hxx,v $
  10  * $Revision: 1.9 $
  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_UICONFIGURATION_UICONFIGMANAGER_HXX_
  32 #define __FRAMEWORK_UICONFIGURATION_UICONFIGMANAGER_HXX_
  33
  34
  35 /** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble
  36                with solaris headers ...
  37 */
  38 #include <vector>
  39 #include <list>
  40 #include <hash_map>
  41 #include <memory>
  42
  43 //_________________________________________________________________________________________________________________
  44 //      my own includes
  45 //_________________________________________________________________________________________________________________
  46 #include <threadhelp/threadhelpbase.hxx>
  47 #include <macros/generic.hxx>
  48 #include <macros/xinterface.hxx>
  49 #include <macros/xtypeprovider.hxx>
  50 #include <macros/xserviceinfo.hxx>
  51 #include <stdtypes.h>
  52 #include <uiconfiguration/imagemanager.hxx>
  53
  54 //_________________________________________________________________________________________________________________
  55 //      interface includes
  56 //_________________________________________________________________________________________________________________
  57 #include <com/sun/star/lang/XServiceInfo.hpp>
  58 #include <com/sun/star/lang/XTypeProvider.hpp>
  59 #include <com/sun/star/lang/XComponent.hpp>
  60 #include <com/sun/star/ui/XUIConfiguration.hpp>
  61 #include <com/sun/star/ui/XUIConfigurationPersistence.hpp>
  62
  63 #ifndef _COM_SUN_STAR_UI_XUICONFIGURATIONSTORGAE_HPP_
  64 #include <com/sun/star/ui/XUIConfigurationStorage.hpp>
  65 #endif
  66 #include <com/sun/star/ui/XUIConfigurationManager.hpp>
  67 #include <com/sun/star/ui/ConfigurationEvent.hpp>
  68 #include <com/sun/star/ui/UIElementType.hpp>
  69 #include <com/sun/star/container/XIndexContainer.hpp>
  70
  71 //_________________________________________________________________________________________________________________
  72 //      other includes
  73 //_________________________________________________________________________________________________________________
  74 #include <cppuhelper/weak.hxx>
  75 #include <cppuhelper/interfacecontainer.hxx>
  76 #include <rtl/ustring.hxx>
  77
  78
  79 namespace framework
  80 {
  81     class UIConfigurationManagerImpl;
  82     class UIConfigurationManager :   public com::sun::star::lang::XTypeProvider ,
  83                                      public com::sun::star::lang::XServiceInfo  ,
  84                                      public com::sun::star::lang::XComponent    ,
  85                                      public ::com::sun::star::ui::XUIConfiguration             ,
  86                                      public ::com::sun::star::ui::XUIConfigurationManager      ,
  87                                      public ::com::sun::star::ui::XUIConfigurationPersistence  ,
  88                                      public ::com::sun::star::ui::XUIConfigurationStorage      ,
  89                                      public ::cppu::OWeakObject
  90     {
  91         public:
  92             //  XInterface, XTypeProvider, XServiceInfo
  93             FWK_DECLARE_XINTERFACE
  94             FWK_DECLARE_XTYPEPROVIDER
  95             DECLARE_XSERVICEINFO
  96
  97             UIConfigurationManager( com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > xServiceManager );
  98             virtual ~UIConfigurationManager();
  99
 100             // XComponent
 101             virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException);
 102             virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
 103             virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException);
 104
 105             // XUIConfiguration
 106             virtual void SAL_CALL addConfigurationListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationListener >& Listener ) throw (::com::sun::star::uno::RuntimeException);
 107             virtual void SAL_CALL removeConfigurationListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationListener >& Listener ) throw (::com::sun::star::uno::RuntimeException);
 108
 109             // XUIConfigurationManager
 110             virtual void SAL_CALL reset() throw (::com::sun::star::uno::RuntimeException);
 111             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);
 112             virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexContainer > SAL_CALL createSettings(  ) throw (::com::sun::star::uno::RuntimeException);
 113             virtual sal_Bool SAL_CALL hasSettings( const ::rtl::OUString& ResourceURL ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 114             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);
 115             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);
 116             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);
 117             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);
 118             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getImageManager() throw (::com::sun::star::uno::RuntimeException);
 119             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getShortCutManager() throw (::com::sun::star::uno::RuntimeException);
 120             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getEventsManager() throw (::com::sun::star::uno::RuntimeException);
 121
 122             // XUIConfigurationPersistence
 123             virtual void SAL_CALL reload() throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
 124             virtual void SAL_CALL store() throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
 125             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);
 126             virtual sal_Bool SAL_CALL isModified() throw (::com::sun::star::uno::RuntimeException);
 127             virtual sal_Bool SAL_CALL isReadOnly() throw (::com::sun::star::uno::RuntimeException);
 128
 129             // XUIConfigurationStorage
 130             virtual void SAL_CALL setStorage( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& Storage ) throw (::com::sun::star::uno::RuntimeException);
 131             virtual sal_Bool SAL_CALL hasStorage() throw (::com::sun::star::uno::RuntimeException);
 132
 133         private:
 134             ::std::auto_ptr<UIConfigurationManagerImpl> m_pImpl;
 135    };
 136 }
 137
 138 #endif // __FRAMEWORK_UICONFIGURATION_UICONFIGMANAGER_HXX_