xref: /trunk/main/framework/source/uiconfiguration/imagemanagerimpl.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_IMAGEMANAGERIMPL_HXX_
29*cdf0e10cSrcweir #define __FRAMEWORK_UICONFIGURATION_IMAGEMANAGERIMPL_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/imagetype.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/XUIConfigurationPersistence.hpp>
57*cdf0e10cSrcweir #include <com/sun/star/ui/XUIConfigurationStorage.hpp>
58*cdf0e10cSrcweir #include <com/sun/star/ui/XUIConfiguration.hpp>
59*cdf0e10cSrcweir #include <com/sun/star/ui/XImageManager.hpp>
60*cdf0e10cSrcweir #include <com/sun/star/lang/XInitialization.hpp>
61*cdf0e10cSrcweir #include <com/sun/star/ui/ConfigurationEvent.hpp>
62*cdf0e10cSrcweir #include <com/sun/star/embed/XTransactedObject.hpp>
63*cdf0e10cSrcweir #include <com/sun/star/ui/XImageManager.hpp>
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
66*cdf0e10cSrcweir //  other includes
67*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
68*cdf0e10cSrcweir #include <cppuhelper/weak.hxx>
69*cdf0e10cSrcweir #include <cppuhelper/interfacecontainer.hxx>
70*cdf0e10cSrcweir #include <rtl/ustring.hxx>
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir #include <vcl/image.hxx>
73*cdf0e10cSrcweir #include <tools/color.hxx>
74*cdf0e10cSrcweir #include <rtl/ref.hxx>
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir #include <vector>
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir namespace framework
79*cdf0e10cSrcweir {
80*cdf0e10cSrcweir     class CmdImageList
81*cdf0e10cSrcweir     {
82*cdf0e10cSrcweir         public:
83*cdf0e10cSrcweir             CmdImageList( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& rServiceManager,
84*cdf0e10cSrcweir                           const ::rtl::OUString& aModuleIdentifier );
85*cdf0e10cSrcweir             virtual ~CmdImageList();
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir             virtual Image                           getImageFromCommandURL( sal_Int16 nImageType, const rtl::OUString& rCommandURL );
88*cdf0e10cSrcweir             virtual bool                            hasImage( sal_Int16 nImageType, const rtl::OUString& rCommandURL );
89*cdf0e10cSrcweir             virtual ::std::vector< rtl::OUString >& getImageNames();
90*cdf0e10cSrcweir             virtual ::std::vector< rtl::OUString >& getImageCommandNames();
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir         protected:
93*cdf0e10cSrcweir             void                            impl_fillCommandToImageNameMap();
94*cdf0e10cSrcweir             ImageList*                      impl_getImageList( sal_Int16 nImageType );
95*cdf0e10cSrcweir             std::vector< ::rtl::OUString >& impl_getImageNameVector();
96*cdf0e10cSrcweir             std::vector< ::rtl::OUString >& impl_getImageCommandNameVector();
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir         private:
99*cdf0e10cSrcweir             sal_Bool                                                                         m_bVectorInit;
100*cdf0e10cSrcweir             rtl::OUString                                                                    m_aModuleIdentifier;
101*cdf0e10cSrcweir             ImageList*                                                                       m_pImageList[ImageType_COUNT];
102*cdf0e10cSrcweir             CommandToImageNameMap                                                            m_aCommandToImageNameMap;
103*cdf0e10cSrcweir             ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > m_xServiceManager;
104*cdf0e10cSrcweir             ::std::vector< rtl::OUString >                                                   m_aImageNameVector;
105*cdf0e10cSrcweir             ::std::vector< rtl::OUString >                                                   m_aImageCommandNameVector;
106*cdf0e10cSrcweir             sal_Int16                                                                        m_nSymbolsStyle;
107*cdf0e10cSrcweir     };
108*cdf0e10cSrcweir 
109*cdf0e10cSrcweir     class GlobalImageList : public CmdImageList, public rtl::IReference
110*cdf0e10cSrcweir     {
111*cdf0e10cSrcweir         public:
112*cdf0e10cSrcweir             GlobalImageList( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& rServiceManager );
113*cdf0e10cSrcweir             virtual ~GlobalImageList();
114*cdf0e10cSrcweir 
115*cdf0e10cSrcweir             virtual Image                           getImageFromCommandURL( sal_Int16 nImageType, const rtl::OUString& rCommandURL );
116*cdf0e10cSrcweir             virtual bool                            hasImage( sal_Int16 nImageType, const rtl::OUString& rCommandURL );
117*cdf0e10cSrcweir             virtual ::std::vector< rtl::OUString >& getImageNames();
118*cdf0e10cSrcweir             virtual ::std::vector< rtl::OUString >& getImageCommandNames();
119*cdf0e10cSrcweir 
120*cdf0e10cSrcweir             // �Reference
121*cdf0e10cSrcweir             virtual oslInterlockedCount SAL_CALL acquire();
122*cdf0e10cSrcweir             virtual oslInterlockedCount SAL_CALL release();
123*cdf0e10cSrcweir 
124*cdf0e10cSrcweir         private:
125*cdf0e10cSrcweir             oslInterlockedCount                                                              m_nRefCount;
126*cdf0e10cSrcweir     };
127*cdf0e10cSrcweir 
128*cdf0e10cSrcweir     class ImageManagerImpl : public ThreadHelpBase  // Struct for right initalization of mutex member! Must be first of baseclasses.
129*cdf0e10cSrcweir     {
130*cdf0e10cSrcweir         public:
131*cdf0e10cSrcweir 
132*cdf0e10cSrcweir             ImageManagerImpl(const com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& xServiceManager
133*cdf0e10cSrcweir                 ,const  com::sun::star::uno::Reference< com::sun::star::uno::XInterface >& _xOwner
134*cdf0e10cSrcweir                 ,bool _bUseGlobal);
135*cdf0e10cSrcweir             ~ImageManagerImpl();
136*cdf0e10cSrcweir 
137*cdf0e10cSrcweir             void dispose();
138*cdf0e10cSrcweir             void initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments );
139*cdf0e10cSrcweir             void addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
140*cdf0e10cSrcweir             void removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException);
141*cdf0e10cSrcweir 
142*cdf0e10cSrcweir             // XImageManager
143*cdf0e10cSrcweir             void reset() throw (::com::sun::star::uno::RuntimeException);
144*cdf0e10cSrcweir             ::com::sun::star::uno::Sequence< ::rtl::OUString > getAllImageNames( ::sal_Int16 nImageType ) throw (::com::sun::star::uno::RuntimeException);
145*cdf0e10cSrcweir             ::sal_Bool hasImage( ::sal_Int16 nImageType, const ::rtl::OUString& aCommandURL ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
146*cdf0e10cSrcweir             ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > > getImages( ::sal_Int16 nImageType, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aCommandURLSequence ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
147*cdf0e10cSrcweir             void replaceImages( ::sal_Int16 nImageType, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aCommandURLSequence, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > >& aGraphicsSequence ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException, ::com::sun::star::uno::RuntimeException);
148*cdf0e10cSrcweir             void removeImages( ::sal_Int16 nImageType, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aResourceURLSequence ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException, ::com::sun::star::uno::RuntimeException);
149*cdf0e10cSrcweir             void insertImages( ::sal_Int16 nImageType, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aCommandURLSequence, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::graphic::XGraphic > >& aGraphicSequence ) throw (::com::sun::star::container::ElementExistException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::IllegalAccessException, ::com::sun::star::uno::RuntimeException);
150*cdf0e10cSrcweir 
151*cdf0e10cSrcweir             // XUIConfiguration
152*cdf0e10cSrcweir             void addConfigurationListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationListener >& Listener ) throw (::com::sun::star::uno::RuntimeException);
153*cdf0e10cSrcweir             void removeConfigurationListener( const ::com::sun::star::uno::Reference< ::com::sun::star::ui::XUIConfigurationListener >& Listener ) throw (::com::sun::star::uno::RuntimeException);
154*cdf0e10cSrcweir 
155*cdf0e10cSrcweir             // XUIConfigurationPersistence
156*cdf0e10cSrcweir             void reload() throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
157*cdf0e10cSrcweir             void store() throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
158*cdf0e10cSrcweir             void storeToStorage( const ::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage >& Storage ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
159*cdf0e10cSrcweir             sal_Bool isModified() throw (::com::sun::star::uno::RuntimeException);
160*cdf0e10cSrcweir             sal_Bool isReadOnly() throw (::com::sun::star::uno::RuntimeException);
161*cdf0e10cSrcweir 
162*cdf0e10cSrcweir             void clear();
163*cdf0e10cSrcweir 
164*cdf0e10cSrcweir             typedef std::hash_map< rtl::OUString,
165*cdf0e10cSrcweir                                    sal_Bool,
166*cdf0e10cSrcweir                                    OUStringHashCode,
167*cdf0e10cSrcweir                                    ::std::equal_to< ::rtl::OUString > > ImageNameMap;
168*cdf0e10cSrcweir 
169*cdf0e10cSrcweir             enum Layer
170*cdf0e10cSrcweir             {
171*cdf0e10cSrcweir                 LAYER_DEFAULT,
172*cdf0e10cSrcweir                 LAYER_USERDEFINED,
173*cdf0e10cSrcweir                 LAYER_COUNT
174*cdf0e10cSrcweir             };
175*cdf0e10cSrcweir 
176*cdf0e10cSrcweir             enum NotifyOp
177*cdf0e10cSrcweir             {
178*cdf0e10cSrcweir                 NotifyOp_Remove,
179*cdf0e10cSrcweir                 NotifyOp_Insert,
180*cdf0e10cSrcweir                 NotifyOp_Replace
181*cdf0e10cSrcweir             };
182*cdf0e10cSrcweir 
183*cdf0e10cSrcweir             typedef ::std::vector< ::com::sun::star::ui::ConfigurationEvent > ConfigEventNotifyContainer;
184*cdf0e10cSrcweir 
185*cdf0e10cSrcweir             // private methods
186*cdf0e10cSrcweir             void                                      implts_initialize();
187*cdf0e10cSrcweir             void                                      implts_notifyContainerListener( const ::com::sun::star::ui::ConfigurationEvent& aEvent, NotifyOp eOp );
188*cdf0e10cSrcweir             ImageList*                                implts_getUserImageList( ImageType nImageType );
189*cdf0e10cSrcweir             sal_Bool                                  implts_loadUserImages( ImageType nImageType,
190*cdf0e10cSrcweir                                                                              const com::sun::star::uno::Reference< com::sun::star::embed::XStorage >& xUserImageStorage,
191*cdf0e10cSrcweir                                                                              const com::sun::star::uno::Reference< com::sun::star::embed::XStorage >& xUserBitmapsStorage );
192*cdf0e10cSrcweir             sal_Bool                                  implts_storeUserImages( ImageType nImageType,
193*cdf0e10cSrcweir                                                                               const com::sun::star::uno::Reference< com::sun::star::embed::XStorage >& xUserImageStorage,
194*cdf0e10cSrcweir                                                                               const com::sun::star::uno::Reference< com::sun::star::embed::XStorage >& xUserBitmapsStorage );
195*cdf0e10cSrcweir             const rtl::Reference< GlobalImageList >&  implts_getGlobalImageList();
196*cdf0e10cSrcweir             CmdImageList*                             implts_getDefaultImageList();
197*cdf0e10cSrcweir 
198*cdf0e10cSrcweir 
199*cdf0e10cSrcweir             com::sun::star::uno::Reference< com::sun::star::embed::XStorage >               m_xUserConfigStorage;
200*cdf0e10cSrcweir             com::sun::star::uno::Reference< com::sun::star::embed::XStorage >               m_xUserImageStorage;
201*cdf0e10cSrcweir             com::sun::star::uno::Reference< com::sun::star::embed::XStorage >               m_xUserBitmapsStorage;
202*cdf0e10cSrcweir             com::sun::star::uno::Reference< com::sun::star::embed::XTransactedObject >      m_xUserRootCommit;
203*cdf0e10cSrcweir             com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >    m_xServiceManager;
204*cdf0e10cSrcweir             com::sun::star::uno::Reference< com::sun::star::uno::XInterface >               m_xOwner;
205*cdf0e10cSrcweir             rtl::Reference< GlobalImageList >                                               m_pGlobalImageList;
206*cdf0e10cSrcweir             CmdImageList*                                                                   m_pDefaultImageList;
207*cdf0e10cSrcweir             rtl::OUString                                                                   m_aXMLPostfix;
208*cdf0e10cSrcweir             rtl::OUString                                                                   m_aModuleIdentifier;
209*cdf0e10cSrcweir             rtl::OUString                                                                   m_aResourceString;
210*cdf0e10cSrcweir             ::cppu::OMultiTypeInterfaceContainerHelper                                      m_aListenerContainer;   /// container for ALL Listener
211*cdf0e10cSrcweir             ImageList*                                                                      m_pUserImageList[ImageType_COUNT];
212*cdf0e10cSrcweir             bool                                                                            m_bUserImageListModified[ImageType_COUNT];
213*cdf0e10cSrcweir             bool                                                                            m_bUseGlobal;
214*cdf0e10cSrcweir             bool                                                                            m_bReadOnly;
215*cdf0e10cSrcweir             bool                                                                            m_bInitialized;
216*cdf0e10cSrcweir             bool                                                                            m_bModified;
217*cdf0e10cSrcweir             bool                                                                            m_bConfigRead;
218*cdf0e10cSrcweir             bool                                                                            m_bDisposed;
219*cdf0e10cSrcweir    };
220*cdf0e10cSrcweir }
221*cdf0e10cSrcweir 
222*cdf0e10cSrcweir #endif // __FRAMEWORK_UICONFIGURATION_IMAGEMANAGERIMPL_HXX_
223