diff options
Diffstat (limited to 'include/sfx2/XmlIdRegistry.hxx')
-rw-r--r-- | include/sfx2/XmlIdRegistry.hxx | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/include/sfx2/XmlIdRegistry.hxx b/include/sfx2/XmlIdRegistry.hxx new file mode 100644 index 000000000000..a7540dc469b0 --- /dev/null +++ b/include/sfx2/XmlIdRegistry.hxx @@ -0,0 +1,84 @@ +/* -*- 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 _SFX_XMLIDREGISTRY_HXX_ +#define _SFX_XMLIDREGISTRY_HXX_ + +#include <sal/config.h> + +#include <sfx2/dllapi.h> + +#include <com/sun/star/beans/StringPair.hpp> + + +namespace com { namespace sun { namespace star { namespace rdf { + class XMetadatable; +} } } } + +namespace sfx2 { + +// XML ID utilities -------------------------------------------------- + +/** is i_rIdref a valid NCName ? */ +bool SFX2_DLLPUBLIC isValidNCName(OUString const & i_rIdref); + +bool SFX2_DLLPUBLIC isValidXmlId(OUString const & i_rStreamName, + OUString const & i_rIdref); + +// XML ID handling --------------------------------------------------- + +/** interface for getElementByMetadataReference; + for use by sfx2::DocumentMetadataAccess + */ +class SFX2_DLLPUBLIC IXmlIdRegistry +{ + +public: + virtual ~IXmlIdRegistry() { } + + virtual ::com::sun::star::uno::Reference< + ::com::sun::star::rdf::XMetadatable > SAL_CALL + GetElementByMetadataReference( + const ::com::sun::star::beans::StringPair & i_rXmlId) const = 0; + +}; + +/** supplier interface for the registry. + + This indirection is unfortunately necessary, because the SwDocShell + is not always connected to a SwDoc, so we cannot guarantee that a + registry given to a SfxBaseModel/DocumentMetadataAccess remains valid; + it has to be retrieved from this supplier interface on access. + */ +class SFX2_DLLPUBLIC IXmlIdRegistrySupplier +{ + +public: + virtual ~IXmlIdRegistrySupplier() { } + + /** override this if you have a XmlIdRegistry. */ + virtual const IXmlIdRegistry* GetXmlIdRegistry() const { return 0; } + +}; + +} // namespace sfx2 + +#endif // _SFX_XMLIDREGISTRY_HXX_ + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |