xmloff/source/forms/eventexport.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: eventexport.hxx,v $
  10  * $Revision: 1.4 $
  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 _XMLOFF_FORMS_EVENTEXPORT_HXX_
  32 #define _XMLOFF_FORMS_EVENTEXPORT_HXX_
  33
  34 #include <com/sun/star/container/XNameReplace.hpp>
  35 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  36 #include <com/sun/star/beans/PropertyValue.hpp>
  37 #include <com/sun/star/uno/Sequence.hxx>
  38 #include <cppuhelper/implbase1.hxx>
  39 #include <comphelper/stl_types.hxx>
  40
  41 //.........................................................................
  42 namespace xmloff
  43 {
  44 //.........................................................................
  45
  46     //=====================================================================
  47     //= OEventDescriptorMapper
  48     //=====================================================================
  49     typedef ::cppu::WeakImplHelper1     <       ::com::sun::star::container::XNameReplace
  50                                     >   OEventDescriptorMapper_Base;
  51     /** helper class wrapping different script event representations
  52
  53         <p>In the form layer, the script events are represented by <type scope="com.sun.star.script">ScriptEventDescriptor</type>
  54         instances. The office applications, on the other hand, represent their a single script event as sequence
  55         of <type scope="com.sun.star.beans">PropertyValue</type>s, where all events of a given object are
  56         accessible through a <type scope="com.sun.star.container">XNameReplace</type> interface.</p>
  57         <p>This class maps the first representation of events of a single object to the second one.</p>
  58         <p>This way, we can use the helper classes here in the project.</p>
  59     */
  60     class OEventDescriptorMapper : public OEventDescriptorMapper_Base
  61     {
  62     protected:
  63         DECLARE_STL_USTRINGACCESS_MAP( ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >, MapString2PropertyValueSequence );
  64         MapString2PropertyValueSequence m_aMappedEvents;
  65
  66     public:
  67         OEventDescriptorMapper(
  68             const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rEvents);
  69
  70         // XNameReplace
  71         virtual void SAL_CALL replaceByName( const ::rtl::OUString& aName, const ::com::sun::star::uno::Any& aElement ) throw(::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
  72
  73         // XNameAccess
  74         virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw(::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
  75         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames(  ) throw(::com::sun::star::uno::RuntimeException);
  76         virtual sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw(::com::sun::star::uno::RuntimeException);
  77
  78         // XElementAccess
  79         virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw(::com::sun::star::uno::RuntimeException);
  80         virtual sal_Bool SAL_CALL hasElements(  ) throw(::com::sun::star::uno::RuntimeException);
  81     };
  82
  83
  84 //.........................................................................
  85 }       // namespace xmloff
  86 //.........................................................................
  87
  88 #endif // _XMLOFF_FORMS_EVENTEXPORT_HXX_
  89