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/ucb/HierarchyContentProvider.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.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 'offapi/com/sun/star/ucb/HierarchyContentProvider.idl')
-rw-r--r-- | offapi/com/sun/star/ucb/HierarchyContentProvider.idl | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl new file mode 100644 index 000000000..5d9fa601a --- /dev/null +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -0,0 +1,100 @@ +/* -*- 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_ucb_HierarchyContentProvider_idl__ +#define __com_sun_star_ucb_HierarchyContentProvider_idl__ + +#include <com/sun/star/ucb/XContentProvider.idl> + + +module com { module sun { module star { module ucb { + +/** The Hierarchy Content Provider (HCP) implements a + ContentProvider for the UniversalContentBroker + (UCB). + + <p>It provides access to a persistent, customizable hierarchy of contents + (folders and links). + + @see com::sun::star::ucb::Content +*/ +published service HierarchyContentProvider +{ + /** provides three types of contents: Link, Folder and Root Folder. + + <p> + + <b>HCP Contents</b> + <ol> + <li> + A HCP Link (HierarchyLinkContent) is a content which + points to another (UCB) content. It is always contained in HCP Folder. + A HCP Link has no children. + </li> + <li> + A HCP Folder (HierarchyFolderContent) is a container for + other HCP Folders and HCP Links. + </li> + <li> + There is at most one instance of a HCP Root Folder + ( HierarchyRootFolderContent ) at a time. + All other HCP contents are children of this folder. The HCP Root + Folder can contain HCP Folders and HCP Links. It has the URL + "vnd.sun.star.hier:/". + </li> + </ol> + + <p><b>URL Scheme for HCP Contents</b> + + <p>Each HCP content has an identifier corresponding to the following + scheme: + + <ul> + <li> + vnd.sun.star.hier:/<path>, where <path> is a + hierarchical path of the form <name>/.../<name> and + where <name> is a string encoded according to the URL + conventions. + </li> + </ul> + + <p>Examples: + + <ul> + <li> + vnd.sun.star.hier:/ (The URL of the HCP Root Folder) + </li> + <li> + vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page + </li> + <li> + vnd.sun.star.hier:/Workplace/Printers + </li> + </ul> + + </p> + */ + interface com::sun::star::ucb::XContentProvider; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |