include/sfx2/XmlIdRegistry.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_SFX2_XMLIDREGISTRY_HXX
  21 #define INCLUDED_SFX2_XMLIDREGISTRY_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <string_view>
  26
  27 #include <sfx2/dllapi.h>
  28
  29 namespace com::sun::star::beans { struct StringPair; }
  30 namespace com::sun::star::uno { template <typename > class Reference; }
  31
  32 namespace com::sun::star::rdf {
  33     class XMetadatable;
  34 }
  35
  36 namespace sfx2 {
  37
  38 // XML ID utilities --------------------------------------------------
  39
  40 /** is i_rIdref a valid NCName ? */
  41 bool SFX2_DLLPUBLIC isValidNCName(std::u16string_view i_rIdref);
  42
  43 bool SFX2_DLLPUBLIC isValidXmlId(std::u16string_view i_rStreamName,
  44     std::u16string_view i_rIdref);
  45
  46 // XML ID handling ---------------------------------------------------
  47
  48 /** interface for getElementByMetadataReference;
  49     for use by sfx2::DocumentMetadataAccess
  50  */
  51 class SFX2_DLLPUBLIC IXmlIdRegistry
  52 {
  53
  54 public:
  55     virtual ~IXmlIdRegistry() { }
  56
  57     virtual css::uno::Reference< css::rdf::XMetadatable >
  58         GetElementByMetadataReference(
  59             const css::beans::StringPair & i_rXmlId) const = 0;
  60
  61 };
  62
  63 } // namespace sfx2
  64
  65 #endif // INCLUDED_SFX2_XMLIDREGISTRY_HXX
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */