offapi/com/sun/star/ucb/HierarchyContentProvider.idl

   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
  21 module com { module sun { module star { module ucb {
  22
  23 /** The Hierarchy Content Provider (HCP) implements a
  24     ContentProvider for the UniversalContentBroker
  25     (UCB).
  26
  27     <p>It provides access to a persistent, customizable hierarchy of contents
  28     (folders and links).
  29
  30     @see com::sun::star::ucb::Content
  31 */
  32 published service HierarchyContentProvider
  33 {
  34     /** provides three types of contents: Link, Folder and Root Folder.
  35
  36         <p>
  37
  38         <b>HCP Contents</b>
  39         <ol>
  40         <li>
  41         A HCP Link (HierarchyLinkContent) is a content which
  42         points to another (UCB) content. It is always contained in HCP Folder.
  43         A HCP Link has no children.
  44         </li>
  45         <li>
  46         A HCP Folder (HierarchyFolderContent) is a container for
  47         other HCP Folders and HCP Links.
  48         </li>
  49         <li>
  50         There is at most one instance of a HCP Root Folder
  51         ( HierarchyRootFolderContent ) at a time.
  52         All other HCP contents are children of this folder. The HCP Root
  53         Folder can contain HCP Folders and HCP Links. It has the URL
  54         "vnd.sun.star.hier:/".
  55         </li>
  56         </ol>
  57
  58         <p><b>URL Scheme for HCP Contents</b>
  59
  60         <p>Each HCP content has an identifier corresponding to the following
  61         scheme:
  62
  63         <ul>
  64         <li>
  65             vnd.sun.star.hier:/&lt;path&gt;, where &lt;path&gt; is a
  66             hierarchical path of the form &lt;name&gt;/.../&lt;name&gt; and
  67             where &lt;name&gt; is a string encoded according to the URL
  68             conventions.
  69         </li>
  70         </ul>
  71
  72         <p>Examples:
  73
  74         <ul>
  75         <li>
  76         vnd.sun.star.hier:/ (The URL of the HCP Root Folder)
  77         </li>
  78         <li>
  79         vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page
  80         </li>
  81         <li>
  82         vnd.sun.star.hier:/Workplace/Printers
  83         </li>
  84         </ul>
  85
  86         </p>
  87      */
  88     interface com::sun::star::ucb::XContentProvider;
  89 };
  90
  91
  92 }; }; }; };
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */