Line data    Source code

       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 _SFX_XMLIDREGISTRY_HXX_
      21             : #define _SFX_XMLIDREGISTRY_HXX_
      22             : 
      23             : #include <sal/config.h>
      24             : 
      25             : #include <sfx2/dllapi.h>
      26             : 
      27             : #include <com/sun/star/beans/StringPair.hpp>
      28             : 
      29             : 
      30             : namespace com { namespace sun { namespace star { namespace rdf {
      31             :     class XMetadatable;
      32             : } } } }
      33             : 
      34             : namespace sfx2 {
      35             : 
      36             : // XML ID utilities --------------------------------------------------
      37             : 
      38             : /** is i_rIdref a valid NCName ? */
      39             : bool SFX2_DLLPUBLIC isValidNCName(::rtl::OUString const & i_rIdref);
      40             : 
      41             : bool SFX2_DLLPUBLIC isValidXmlId(::rtl::OUString const & i_rStreamName,
      42             :     ::rtl::OUString const & i_rIdref);
      43             : 
      44             : // XML ID handling ---------------------------------------------------
      45             : 
      46             : /** interface for getElementByMetadataReference;
      47             :     for use by sfx2::DocumentMetadataAccess
      48             :  */
      49             : class SFX2_DLLPUBLIC IXmlIdRegistry
      50             : {
      51             : 
      52             : public:
      53           0 :     virtual ~IXmlIdRegistry() { }
      54             : 
      55             :     virtual ::com::sun::star::uno::Reference<
      56             :             ::com::sun::star::rdf::XMetadatable > SAL_CALL
      57             :         GetElementByMetadataReference(
      58             :             const ::com::sun::star::beans::StringPair & i_rXmlId) const = 0;
      59             : 
      60             : };
      61             : 
      62             : /** supplier interface for the registry.
      63             : 
      64             :     This indirection is unfortunately necessary, because the SwDocShell
      65             :     is not always connected to a SwDoc, so we cannot guarantee that a
      66             :     registry given to a SfxBaseModel/DocumentMetadataAccess remains valid;
      67             :     it has to be retrieved from this supplier interface on access.
      68             :  */
      69             : class SFX2_DLLPUBLIC IXmlIdRegistrySupplier
      70             : {
      71             : 
      72             : public:
      73           0 :     virtual ~IXmlIdRegistrySupplier() { }
      74             : 
      75             :     /** override this if you have a XmlIdRegistry. */
      76           0 :     virtual const IXmlIdRegistry* GetXmlIdRegistry() const { return 0; }
      77             : 
      78             : };
      79             : 
      80             : } // namespace sfx2
      81             : 
      82             : #endif // _SFX_XMLIDREGISTRY_HXX_
      83             : 
      84             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */