From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- include/xmloff/xmlprmap.hxx | 128 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 include/xmloff/xmlprmap.hxx (limited to 'include/xmloff/xmlprmap.hxx') diff --git a/include/xmloff/xmlprmap.hxx b/include/xmloff/xmlprmap.hxx new file mode 100644 index 000000000..2a4b93e84 --- /dev/null +++ b/include/xmloff/xmlprmap.hxx @@ -0,0 +1,128 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef INCLUDED_XMLOFF_XMLPRMAP_HXX +#define INCLUDED_XMLOFF_XMLPRMAP_HXX + +#include +#include +#include + +#include +#include + +namespace rtl { template class Reference; } + +class SvXMLUnitConverter; +class XMLPropertyHandler; +class XMLPropertyHandlerFactory; +struct XMLPropertyMapEntry; +struct XMLPropertyState; + +class XMLOFF_DLLPUBLIC XMLPropertySetMapper : public salhelper::SimpleReferenceObject +{ + struct Impl; + + std::unique_ptr mpImpl; + + XMLPropertySetMapper( const XMLPropertySetMapper& ) = delete; + XMLPropertySetMapper& operator= ( const XMLPropertySetMapper& ) = delete; + +public: + /** The last element of the XMLPropertyMapEntry-array must contain NULL-values. + + @param bForExport + If TRUE, only entries that have the mbImportOnly flag not set + will be in the mappings. + */ + XMLPropertySetMapper( + const XMLPropertyMapEntry* pEntries, + const rtl::Reference& rFactory, + bool bForExport ); + + virtual ~XMLPropertySetMapper() override; + + void AddMapperEntry( const rtl::Reference < XMLPropertySetMapper >& rMapper ); + + /** Return number of entries in input-array */ + sal_Int32 GetEntryCount() const; + + /** Returns the flags of an entry */ + sal_uInt32 GetEntryFlags( sal_Int32 nIndex ) const; + + /** Returns the type of an entry */ + sal_uInt32 GetEntryType( sal_Int32 nIndex ) const; + + /** Returns the namespace-key of an entry */ + sal_uInt16 GetEntryNameSpace( sal_Int32 nIndex ) const; + + /** Returns the 'local' XML-name of the entry */ + const OUString& GetEntryXMLName( sal_Int32 nIndex ) const; + + /** Returns the entry API name */ + const OUString& GetEntryAPIName( sal_Int32 nIndex ) const; + + /** returns the entry context id. -1 is a valid index here. */ + sal_Int16 GetEntryContextId( sal_Int32 nIndex ) const; + + /** returns the earliest ODF version for which this property should be + exported as standard ODF element, which is the earliest ODF version + for which the property should not be exported as extension element. + */ + SvtSaveOptions::ODFSaneDefaultVersion GetEarliestODFVersionForExport(sal_Int32 nIndex) const; + + /** Returns the index of an entry with the given XML-name and namespace + If there is no matching entry the method returns -1 */ + sal_Int32 GetEntryIndex( + sal_uInt16 nNamespace, std::u16string_view rStrName, sal_uInt32 nPropType, + sal_Int32 nStartAt = -1 ) const; + + /** Returns the index of an entry with the given XML-name and namespace + If there is no matching entry the method returns -1 */ + sal_Int32 GetEntryIndex( + sal_Int32 nElement, sal_uInt32 nPropType, + sal_Int32 nStartAt = -1 ) const; + + /** Retrieves a PropertyHandler for that property which placed at nIndex in the XMLPropertyMapEntry-array */ + const XMLPropertyHandler* GetPropertyHandler( sal_Int32 nIndex ) const; + + /** import/export + This methods calls the respective im/export-method of the respective PropertyHandler. */ + bool exportXML( + OUString& rStrExpValue, const XMLPropertyState& rProperty, + const SvXMLUnitConverter& rUnitConverter ) const; + + bool importXML( + const OUString& rStrImpValue, XMLPropertyState& rProperty, + const SvXMLUnitConverter& rUnitConverter ) const; + + /** searches for an entry that matches the given api name, namespace and local name or -1 if nothing found */ + sal_Int32 FindEntryIndex( + const char* sApiName, sal_uInt16 nNameSpace, std::u16string_view sXMLName ) const; + + /** searches for an entry that matches the given ContextId or gives -1 if nothing found */ + sal_Int32 FindEntryIndex( const sal_Int16 nContextId ) const; + + /** Remove an entry */ + void RemoveEntry( sal_Int32 nIndex ); +}; + +#endif // INCLUDED_XMLOFF_XMLPRMAP_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3