framework/inc/uielement/uicommanddescription.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: uicommanddescription.hxx,v $
  10  * $Revision: 1.7 $
  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_UICOMMANDDESCRPTION_HXX_
  32 #define __FRAMEWORK_UIELEMENT_UICOMMANDDESCRPTION_HXX_
  33
  34 /** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble
  35                with solaris headers ...
  36 */
  37 #include <vector>
  38 #include <list>
  39 #include <hash_map>
  40
  41 //_________________________________________________________________________________________________________________
  42 //      my own includes
  43 //_________________________________________________________________________________________________________________
  44 #include <threadhelp/threadhelpbase.hxx>
  45 #include <macros/generic.hxx>
  46 #include <macros/xinterface.hxx>
  47 #include <macros/xtypeprovider.hxx>
  48 #include <macros/xserviceinfo.hxx>
  49 #include <stdtypes.h>
  50
  51 //_________________________________________________________________________________________________________________
  52 //      interface includes
  53 //_________________________________________________________________________________________________________________
  54 #include <com/sun/star/lang/XServiceInfo.hpp>
  55 #include <com/sun/star/lang/XTypeProvider.hpp>
  56 #include <com/sun/star/container/XNameAccess.hpp>
  57 #include <com/sun/star/frame/XModuleManager.hpp>
  58
  59 //_________________________________________________________________________________________________________________
  60 //      other includes
  61 //_________________________________________________________________________________________________________________
  62 #include <cppuhelper/weak.hxx>
  63 #include <rtl/ustring.hxx>
  64
  65 namespace framework
  66 {
  67
  68 class ConfigurationAccess_UICommand;
  69 class UICommandDescription :  public com::sun::star::lang::XTypeProvider        ,
  70                               public com::sun::star::lang::XServiceInfo         ,
  71                                                           public com::sun::star::container::XNameAccess ,
  72                                                           private ThreadHelpBase                                                ,       // Struct for right initalization of mutex member! Must be first of baseclasses.
  73                                                           public ::cppu::OWeakObject
  74 {
  75         public:
  76                 UICommandDescription( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager );
  77                 virtual ~UICommandDescription();
  78
  79         //  XInterface, XTypeProvider, XServiceInfo
  80                 FWK_DECLARE_XINTERFACE
  81                 FWK_DECLARE_XTYPEPROVIDER
  82                 DECLARE_XSERVICEINFO
  83
  84         // XNameAccess
  85         virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName )
  86             throw ( ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
  87
  88         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames()
  89             throw (::com::sun::star::uno::RuntimeException);
  90
  91         virtual sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName )
  92             throw (::com::sun::star::uno::RuntimeException);
  93
  94         // XElementAccess
  95         virtual ::com::sun::star::uno::Type SAL_CALL getElementType()
  96             throw (::com::sun::star::uno::RuntimeException);
  97         virtual sal_Bool SAL_CALL hasElements()
  98             throw (::com::sun::star::uno::RuntimeException);
  99
 100         typedef ::std::hash_map< ::rtl::OUString,
 101                                  ::rtl::OUString,
 102                                  OUStringHashCode,
 103                                  ::std::equal_to< ::rtl::OUString > > ModuleToCommandFileMap;
 104
 105         typedef ::std::hash_map< ::rtl::OUString,
 106                                  ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >,
 107                                  OUStringHashCode,
 108                                                                  ::std::equal_to< ::rtl::OUString > > UICommandsHashMap;
 109
 110     private:
 111         sal_Bool                                                                            m_bConfigRead;
 112         rtl::OUString                                                                       m_aPrivateResourceURL;
 113         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >    m_xServiceManager;
 114         ModuleToCommandFileMap                                                              m_aModuleToCommandFileMap;
 115         UICommandsHashMap                                                                   m_aUICommandsHashMap;
 116         ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >        m_xGenericUICommands;
 117         ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModuleManager > m_xModuleManager;
 118 };
 119
 120 } // namespace framework
 121
 122 #endif // __FRAMEWORK_SERVICES_UICOMMANDDESCRPTION_HXX_