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