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 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <map>
  25
  26 #include <com/sun/star/container/XNameReplace.hpp>
  27 #include <com/sun/star/script/ScriptEventDescriptor.hpp>
  28 #include <com/sun/star/beans/PropertyValue.hpp>
  29 #include <com/sun/star/uno/Sequence.hxx>
  30 #include <cppuhelper/implbase.hxx>
  31
  32 namespace xmloff
  33 {
  34
  35     //= OEventDescriptorMapper
  36     typedef ::cppu::WeakImplHelper <   css::container::XNameReplace
  37                                     >   OEventDescriptorMapper_Base;
  38     /** helper class wrapping different script event representations
  39
  40         <p>In the form layer, the script events are represented by <type scope="com.sun.star.script">ScriptEventDescriptor</type>
  41         instances. The office applications, on the other hand, represent their a single script event as sequence
  42         of <type scope="com.sun.star.beans">PropertyValue</type>s, where all events of a given object are
  43         accessible through a <type scope="com.sun.star.container">XNameReplace</type> interface.</p>
  44         <p>This class maps the first representation of events of a single object to the second one.</p>
  45         <p>This way, we can use the helper classes here in the project.</p>
  46     */
  47     class OEventDescriptorMapper : public OEventDescriptorMapper_Base
  48     {
  49         typedef std::map< OUString, css::uno::Sequence < css::beans::PropertyValue > > MapString2PropertyValueSequence;
  50         MapString2PropertyValueSequence m_aMappedEvents;
  51
  52     public:
  53         explicit OEventDescriptorMapper(
  54             const css::uno::Sequence< css::script::ScriptEventDescriptor >& _rEvents);
  55
  56         // XNameReplace
  57         virtual void SAL_CALL replaceByName( const OUString& aName, const css::uno::Any& aElement ) override;
  58
  59         // XNameAccess
  60         virtual css::uno::Any SAL_CALL getByName( const OUString& aName ) override;
  61         virtual css::uno::Sequence< OUString > SAL_CALL getElementNames(  ) override;
  62         virtual sal_Bool SAL_CALL hasByName( const OUString& aName ) override;
  63
  64         // XElementAccess
  65         virtual css::uno::Type SAL_CALL getElementType(  ) override;
  66         virtual sal_Bool SAL_CALL hasElements(  ) override;
  67     };
  68
  69 }   // namespace xmloff
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */