sfx2/source/inc/appbaslib.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: appbaslib.hxx,v $
  10  * $Revision: 1.5 $
  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 APPBASLIB_HXX
  32 #define APPBASLIB_HXX
  33
  34 #include <com/sun/star/uno/Sequence.hxx>
  35 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  36 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  37 #include <com/sun/star/script/XStorageBasedLibraryContainer.hpp>
  38 #include <com/sun/star/embed/XStorage.hpp>
  39
  40 class BasicManager;
  41
  42 /** helper class which holds and manipulates a BasicManager
  43 */
  44 class SfxBasicManagerHolder
  45 {
  46 private:
  47     BasicManager*   mpBasicManager;
  48     ::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer >
  49                     mxBasicContainer;
  50     ::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer >
  51                     mxDialogContainer;
  52
  53 public:
  54     SfxBasicManagerHolder();
  55
  56     enum ContainerType
  57     {
  58         SCRIPTS, DIALOGS
  59     };
  60
  61     /** returns <TRUE/> if and only if the instance is currently bound to a non-<NULL/>
  62         BasicManager.
  63     */
  64     bool    isValid() const { return mpBasicManager != NULL; }
  65
  66     /** returns the BasicManager which this instance is currently bound to
  67     */
  68     BasicManager*
  69             get() const { return mpBasicManager; }
  70
  71     /** binds the instance to the given BasicManager
  72     */
  73     void    reset( BasicManager* _pBasicManager );
  74
  75     ::com::sun::star::uno::Reference< ::com::sun::star::script::XLibraryContainer >
  76             getLibraryContainer( ContainerType _eType );
  77
  78     /** determines whether any of our library containers is modified, i.e. returns <TRUE/>
  79         in its isContainerModified call.
  80     */
  81     bool    isAnyContainerModified() const;
  82
  83     /** calls the storeLibraries at both our script and basic library container
  84     */
  85     void    storeAllLibraries();
  86
  87     /** calls the setStorage at all our XStorageBasedLibraryContainer.
  88     */
  89     void    setStorage(
  90                 const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage
  91             );
  92
  93     /** calls the storeLibrariesToStorage at all our XStorageBasedLibraryContainer.
  94     */
  95     void    storeLibrariesToStorage(
  96                 const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& _rxStorage
  97             );
  98
  99
 100     /** checks if any modules in the SfxLibraryContainer exceed the binary
 101         limits.
 102     */
 103     sal_Bool LegacyPsswdBinaryLimitExceeded( ::com::sun::star::uno::Sequence< rtl::OUString >& sModules );
 104
 105
 106 private:
 107     void    impl_releaseContainers();
 108
 109     bool    impl_getContainer(
 110                 ContainerType _eType,
 111                 ::com::sun::star::uno::Reference< ::com::sun::star::script::XStorageBasedLibraryContainer >& _out_rxContainer );
 112 };
 113
 114 class SfxApplicationScriptLibraryContainer
 115 {
 116 public:
 117     // Service
 118     static ::com::sun::star::uno::Sequence< ::rtl::OUString > impl_getStaticSupportedServiceNames();
 119     static ::rtl::OUString impl_getStaticImplementationName();
 120     static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL impl_createInstance
 121         ( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager )
 122             throw( ::com::sun::star::uno::Exception );
 123     static ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > impl_createFactory
 124         ( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager );
 125
 126 };
 127
 128 class SfxApplicationDialogLibraryContainer
 129 {
 130 public:
 131     // Service
 132     static ::com::sun::star::uno::Sequence< ::rtl::OUString > impl_getStaticSupportedServiceNames();
 133     static ::rtl::OUString impl_getStaticImplementationName();
 134     static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL impl_createInstance
 135         ( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager )
 136             throw( ::com::sun::star::uno::Exception );
 137     static ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > impl_createFactory
 138         ( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager );
 139
 140 };
 141
 142 #endif // APPBASLIB_HXX
 143