include/xmloff/xmlevent.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_XMLEVENT_HXX
  21 #define INCLUDED_XMLOFF_XMLEVENT_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <utility>
  25
  26 namespace com::sun::star::uno { template <class interface_type> class Reference; }
  27 namespace com::sun::star::uno { template <typename > class Sequence; }
  28
  29
  30 /**
  31  * @#file
  32  *
  33  * Several definition used in im- and export of events
  34  */
  35
  36 namespace com::sun::star {
  37     namespace xml::sax { class XFastAttributeList; }
  38     namespace beans { struct PropertyValue; }
  39 }
  40
  41 class SvXMLExport;
  42 class SvXMLImportContext;
  43 class SvXMLImport;
  44 class XMLEventsImportContext;
  45
  46
  47 struct XMLEventName
  48 {
  49     sal_uInt16 m_nPrefix;
  50     OUString m_aName;
  51
  52     XMLEventName() : m_nPrefix( 0 ) {}
  53     XMLEventName( sal_uInt16 n, const char *p ) :
  54         m_nPrefix( n ),
  55         m_aName( OUString::createFromAscii(p) )
  56        {}
  57
  58     XMLEventName( sal_uInt16 n, OUString s ) :
  59         m_nPrefix( n ),
  60         m_aName(std::move( s ))
  61        {}
  62
  63     bool operator<( const XMLEventName& r ) const
  64     {
  65         return m_nPrefix < r.m_nPrefix ||
  66                (m_nPrefix == r.m_nPrefix && m_aName < r.m_aName );
  67     }
  68
  69 };
  70
  71 /**
  72  * XMLEventNameTranslation: define tables that translate between event names
  73  * as used in the XML file format and in the StarOffice API.
  74  * The last entry in the table must be { NULL, 0, NULL }.
  75  */
  76 struct XMLEventNameTranslation
  77 {
  78     const char* sAPIName;
  79     sal_uInt16 nPrefix;    // namespace prefix
  80     const char* sXMLName;
  81 };
  82
  83 /// a translation table for the events defined in the XEventsSupplier service
  84 /// (implemented in XMLEventExport.cxx)
  85 extern const XMLEventNameTranslation aStandardEventTable[];
  86
  87
  88 /**
  89  * Handle export of an event for a certain event type (event type as
  90  * defined by the PropertyValue "EventType" in API).
  91  *
  92  * The Handler has to generate the full <script:event> element.
  93  */
  94 class XMLEventExportHandler
  95 {
  96 public:
  97     virtual ~XMLEventExportHandler() {};
  98
  99     virtual void Export(
 100         SvXMLExport& rExport,                   /// the current XML export
 101         const OUString& rEventQName,     /// the XML name of the event
 102         const css::uno::Sequence<css::beans::PropertyValue> & rValues, /// the values for the event
 103         bool bUseWhitespace) = 0;  /// create whitespace around elements?
 104 };
 105
 106
 107 /**
 108  * Handle import of an event for a certain event type (as defined by
 109  * the PropertyValue "EventType" in the API).
 110  *
 111  * EventContextFactories must be registered with the EventImportHelper
 112  * that is attached to the SvXMLImport.
 113  *
 114  * The factory has to create an import context for a <script:event>
 115  * element.  The context has to call the
 116  * EventsImportContext::AddEventValues() method to save its event
 117  * registered with the enclosing element. For events consisting only
 118  * of attributes (and an empty element) an easy solution is to handle
 119  * all attributes in the CreateContext()-method and return a default
 120  * context.
 121  *
 122  * EventContextFactory objects have to be registered with the
 123  * EventsImportHelper.
 124  */
 125 class XMLEventContextFactory
 126 {
 127 public:
 128     virtual ~XMLEventContextFactory() {};
 129
 130     virtual SvXMLImportContext* CreateContext(
 131         SvXMLImport& rImport,               /// import context
 132         const css::uno::Reference<css::xml::sax::XFastAttributeList> & xAttrList, /// attribute list
 133         /// the context for the enclosing <script:events> element
 134         XMLEventsImportContext* rEvents,
 135         /// the event name (as understood by the API)
 136         const OUString& rApiEventName) = 0;
 137 };
 138
 139
 140 #endif
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */