xmloff/source/forms/eventexport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _XMLOFF_FORMS_EVENTEXPORT_HXX_
  30 #define _XMLOFF_FORMS_EVENTEXPORT_HXX_
  31
  32 #include <com/sun/star/container/XNameReplace.hpp>
  33 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  34 #include <com/sun/star/beans/PropertyValue.hpp>
  35 #include <com/sun/star/uno/Sequence.hxx>
  36 #include <cppuhelper/implbase1.hxx>
  37 #include <comphelper/stl_types.hxx>
  38
  39 //.........................................................................
  40 namespace xmloff
  41 {
  42 //.........................................................................
  43
  44     //=====================================================================
  45     //= OEventDescriptorMapper
  46     //=====================================================================
  47     typedef ::cppu::WeakImplHelper1 <   ::com::sun::star::container::XNameReplace
  48                                     >   OEventDescriptorMapper_Base;
  49     /** helper class wrapping different script event representations
  50
  51         <p>In the form layer, the script events are represented by <type scope="com.sun.star.script">ScriptEventDescriptor</type>
  52         instances. The office applications, on the other hand, represent their a single script event as sequence
  53         of <type scope="com.sun.star.beans">PropertyValue</type>s, where all events of a given object are
  54         accessible through a <type scope="com.sun.star.container">XNameReplace</type> interface.</p>
  55         <p>This class maps the first representation of events of a single object to the second one.</p>
  56         <p>This way, we can use the helper classes here in the project.</p>
  57     */
  58     class OEventDescriptorMapper : public OEventDescriptorMapper_Base
  59     {
  60     protected:
  61         DECLARE_STL_USTRINGACCESS_MAP( ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >, MapString2PropertyValueSequence );
  62         MapString2PropertyValueSequence m_aMappedEvents;
  63
  64     public:
  65         OEventDescriptorMapper(
  66             const ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _rEvents);
  67
  68         // XNameReplace
  69         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);
  70
  71         // XNameAccess
  72         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);
  73         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames(  ) throw(::com::sun::star::uno::RuntimeException);
  74         virtual sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw(::com::sun::star::uno::RuntimeException);
  75
  76         // XElementAccess
  77         virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw(::com::sun::star::uno::RuntimeException);
  78         virtual sal_Bool SAL_CALL hasElements(  ) throw(::com::sun::star::uno::RuntimeException);
  79     };
  80
  81
  82 //.........................................................................
  83 }   // namespace xmloff
  84 //.........................................................................
  85
  86 #endif // _XMLOFF_FORMS_EVENTEXPORT_HXX_
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */