xmloff/source/forms/eventexport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_XMLOFF_SOURCE_FORMS_EVENTEXPORT_HXX
  21 #define INCLUDED_XMLOFF_SOURCE_FORMS_EVENTEXPORT_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <map>
  26
  27 #include <com/sun/star/container/XNameReplace.hpp>
  28 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  29 #include <com/sun/star/beans/PropertyValue.hpp>
  30 #include <com/sun/star/uno/Sequence.hxx>
  31 #include <cppuhelper/implbase.hxx>
  32
  33 namespace xmloff
  34 {
  35
  36     //= OEventDescriptorMapper
  37     typedef ::cppu::WeakImplHelper <   css::container::XNameReplace
  38                                     >   OEventDescriptorMapper_Base;
  39     /** helper class wrapping different script event representations
  40
  41         <p>In the form layer, the script events are represented by <type scope="com.sun.star.script">ScriptEventDescriptor</type>
  42         instances. The office applications, on the other hand, represent their a single script event as sequence
  43         of <type scope="com.sun.star.beans">PropertyValue</type>s, where all events of a given object are
  44         accessible through a <type scope="com.sun.star.container">XNameReplace</type> interface.</p>
  45         <p>This class maps the first representation of events of a single object to the second one.</p>
  46         <p>This way, we can use the helper classes here in the project.</p>
  47     */
  48     class OEventDescriptorMapper : public OEventDescriptorMapper_Base
  49     {
  50     protected:
  51         typedef std::map< OUString, css::uno::Sequence < css::beans::PropertyValue > > MapString2PropertyValueSequence;
  52         MapString2PropertyValueSequence m_aMappedEvents;
  53
  54     public:
  55         explicit OEventDescriptorMapper(
  56             const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rEvents);
  57
  58         // XNameReplace
  59         virtual void SAL_CALL replaceByName( const OUString& aName, const css::uno::Any& aElement ) throw(css::lang::IllegalArgumentException, css::container::NoSuchElementException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) override;
  60
  61         // XNameAccess
  62         virtual css::uno::Any SAL_CALL getByName( const OUString& aName ) throw(css::container::NoSuchElementException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) override;
  63         virtual css::uno::Sequence< OUString > SAL_CALL getElementNames(  ) throw(css::uno::RuntimeException, std::exception) override;
  64         virtual sal_Bool SAL_CALL hasByName( const OUString& aName ) throw(css::uno::RuntimeException, std::exception) override;
  65
  66         // XElementAccess
  67         virtual css::uno::Type SAL_CALL getElementType(  ) throw(css::uno::RuntimeException, std::exception) override;
  68         virtual sal_Bool SAL_CALL hasElements(  ) throw(css::uno::RuntimeException, std::exception) override;
  69     };
  70
  71 }   // namespace xmloff
  72
  73 #endif // INCLUDED_XMLOFF_SOURCE_FORMS_EVENTEXPORT_HXX
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */