diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/rdf/XMetadatable.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/rdf/XMetadatable.idl | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rdf/XMetadatable.idl b/offapi/com/sun/star/rdf/XMetadatable.idl new file mode 100644 index 000000000..fc80bef99 --- /dev/null +++ b/offapi/com/sun/star/rdf/XMetadatable.idl @@ -0,0 +1,87 @@ +/* -*- 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 __com_sun_star_rdf_XMetadatable_idl__ +#define __com_sun_star_rdf_XMetadatable_idl__ + +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/beans/StringPair.idl> +#include <com/sun/star/rdf/XURI.idl> + + + +module com { module sun { module star { module rdf { + +/** marks an object representing an ODF element that may have RDF meta data + attached. + + <p> + To make using ODF elements as part of RDF statements more convenient, + this interface inherits from XURI. + The URI is constructed by concatenating the URI of the document, the + stream name, a fragment separator, and the XML ID. + </p> + + <p> + Note that using the XURI interface on an instance of + XMetadatable may have the side effect of creating a metadata + reference for the instance. + </p> + + @since OOo 3.2 + + @see XRepository + @see XDocumentMetadataAccess + */ +interface XMetadatable : XURI +{ + /** a metadata reference, comprising the stream name and the XML ID. + + <p> + Note that this metadata reference must be unique for the ODF document. + This implies that the XML ID part must be unique for every stream. + A pair of two empty strings signifies "no metadata reference". + For example: Pair("content.xml", "foo-element-1") + </p> + + @throws com::sun::star::lang::IllegalArgumentException + if the given metadata reference is invalid, or not unique + */ + [attribute] com::sun::star::beans::StringPair MetadataReference { + set raises ( com::sun::star::lang::IllegalArgumentException ); + }; + + /** creates a metadata reference for this object, if necessary. + + <p> + If this object already has a metadata reference, do nothing; + otherwise, create metadata reference with a fresh, unique XML ID + and assign it to the MetadataReference attribute. + </p> + */ + void ensureMetadataReference(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |